Class SelectObjectContentRequest

    • Method Detail

      • bucket

        public final String bucket()

        The S3 bucket.

        Returns:
        The S3 bucket.
      • key

        public final String key()

        The object key.

        Returns:
        The object key.
      • sseCustomerAlgorithm

        public final String sseCustomerAlgorithm()

        The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

        Returns:
        The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
      • sseCustomerKey

        public final String sseCustomerKey()

        The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

        Returns:
        The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
      • sseCustomerKeyMD5

        public final String sseCustomerKeyMD5()

        The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

        Returns:
        The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.
      • expression

        public final String expression()

        The expression that is used to query the object.

        Returns:
        The expression that is used to query the object.
      • expressionTypeAsString

        public final String expressionTypeAsString()

        The type of the provided expression (for example, SQL).

        If the service returns an enum value that is not available in the current SDK version, expressionType will return ExpressionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from expressionTypeAsString().

        Returns:
        The type of the provided expression (for example, SQL).
        See Also:
        ExpressionType
      • requestProgress

        public final RequestProgress requestProgress()

        Specifies if periodic request progress information should be enabled.

        Returns:
        Specifies if periodic request progress information should be enabled.
      • inputSerialization

        public final InputSerialization inputSerialization()

        Describes the format of the data in the object that is being queried.

        Returns:
        Describes the format of the data in the object that is being queried.
      • outputSerialization

        public final OutputSerialization outputSerialization()

        Describes the format of the data that you want Amazon S3 to return in response.

        Returns:
        Describes the format of the data that you want Amazon S3 to return in response.
      • scanRange

        public final ScanRange scanRange()

        Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

        ScanRangemay be used in the following ways:

        • <scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

        • <scanrange><start>50</start></scanrange> - process only the records starting after the byte 50

        • <scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.

        Returns:
        Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.

        ScanRangemay be used in the following ways:

        • <scanrange><start>50</start><end>100</end></scanrange> - process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)

        • <scanrange><start>50</start></scanrange> - process only the records starting after the byte 50

        • <scanrange><end>50</end></scanrange> - process only the records within the last 50 bytes of the file.

      • expectedBucketOwner

        public final String expectedBucketOwner()

        The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

        Returns:
        The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object