Package software.amazon.awssdk.services.s3.model

Interface SelectObjectContentRequest.Builder

    • Method Detail

      • bucket

        SelectObjectContentRequest.Builder bucket​(String bucket)

        The S3 bucket.

        Parameters:
        bucket - The S3 bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • key

        SelectObjectContentRequest.Builder key​(String key)

        The object key.

        Parameters:
        key - The object key.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sseCustomerAlgorithm

        SelectObjectContentRequest.Builder sseCustomerAlgorithm​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sseCustomerKey

        SelectObjectContentRequest.Builder sseCustomerKey​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • sseCustomerKeyMD5

        SelectObjectContentRequest.Builder sseCustomerKeyMD5​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • expression

        SelectObjectContentRequest.Builder expression​(String expression)

        The expression that is used to query the object.

        Parameters:
        expression - The expression that is used to query the object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • expressionType

        SelectObjectContentRequest.Builder expressionType​(String expressionType)

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

        Parameters:
        expressionType - The type of the provided expression (for example, SQL).
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ExpressionType, ExpressionType

      • requestProgress

        SelectObjectContentRequest.Builder requestProgress​(RequestProgress requestProgress)

        Specifies if periodic request progress information should be enabled.

        Parameters:
        requestProgress - Specifies if periodic request progress information should be enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • inputSerialization

        SelectObjectContentRequest.Builder inputSerialization​(InputSerialization inputSerialization)

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

        Parameters:
        inputSerialization - Describes the format of the data in the object that is being queried.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputSerialization

        SelectObjectContentRequest.Builder outputSerialization​(OutputSerialization outputSerialization)

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

        Parameters:
        outputSerialization - Describes the format of the data that you want Amazon S3 to return in response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • scanRange

        SelectObjectContentRequest.Builder scanRange​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • scanRange

        default SelectObjectContentRequest.Builder scanRange​(Consumer<ScanRange.Builder> 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.

        This is a convenience method that creates an instance of the ScanRange.Builder avoiding the need to create one manually via ScanRange.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scanRange(ScanRange).

        Parameters:
        scanRange - a consumer that will call methods on ScanRange.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        scanRange(ScanRange)

      • expectedBucketOwner

        SelectObjectContentRequest.Builder expectedBucketOwner​(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).

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.