public static interface SelectObjectContentRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<SelectObjectContentRequest.Builder,SelectObjectContentRequest>
Modifier and Type | Method and Description |
---|---|
SelectObjectContentRequest.Builder |
bucket(String bucket)
The S3 bucket.
|
SelectObjectContentRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
SelectObjectContentRequest.Builder |
expression(String expression)
The expression that is used to query the object.
|
SelectObjectContentRequest.Builder |
expressionType(ExpressionType expressionType)
The type of the provided expression (for example, SQL).
|
SelectObjectContentRequest.Builder |
expressionType(String expressionType)
The type of the provided expression (for example, SQL).
|
default SelectObjectContentRequest.Builder |
inputSerialization(Consumer<InputSerialization.Builder> inputSerialization)
Describes the format of the data in the object that is being queried.
|
SelectObjectContentRequest.Builder |
inputSerialization(InputSerialization inputSerialization)
Describes the format of the data in the object that is being queried.
|
SelectObjectContentRequest.Builder |
key(String key)
The object key.
|
default SelectObjectContentRequest.Builder |
outputSerialization(Consumer<OutputSerialization.Builder> outputSerialization)
Describes the format of the data that you want Amazon S3 to return in response.
|
SelectObjectContentRequest.Builder |
outputSerialization(OutputSerialization outputSerialization)
Describes the format of the data that you want Amazon S3 to return in response.
|
SelectObjectContentRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
SelectObjectContentRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
default SelectObjectContentRequest.Builder |
requestProgress(Consumer<RequestProgress.Builder> requestProgress)
Specifies if periodic request progress information should be enabled.
|
SelectObjectContentRequest.Builder |
requestProgress(RequestProgress requestProgress)
Specifies if periodic request progress information should be enabled.
|
default SelectObjectContentRequest.Builder |
scanRange(Consumer<ScanRange.Builder> scanRange)
Specifies the byte range of the object to get the records from.
|
SelectObjectContentRequest.Builder |
scanRange(ScanRange scanRange)
Specifies the byte range of the object to get the records from.
|
SelectObjectContentRequest.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
The server-side encryption (SSE) algorithm used to encrypt the object.
|
SelectObjectContentRequest.Builder |
sseCustomerKey(String sseCustomerKey)
The server-side encryption (SSE) customer managed key.
|
SelectObjectContentRequest.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
The MD5 server-side encryption (SSE) customer managed key.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
SelectObjectContentRequest.Builder bucket(String bucket)
The S3 bucket.
bucket
- The S3 bucket.SelectObjectContentRequest.Builder key(String key)
The object key.
key
- The object key.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.
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.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.
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.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.
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.SelectObjectContentRequest.Builder expression(String expression)
The expression that is used to query the object.
expression
- The expression that is used to query the object.SelectObjectContentRequest.Builder expressionType(String expressionType)
The type of the provided expression (for example, SQL).
expressionType
- The type of the provided expression (for example, SQL).ExpressionType
,
ExpressionType
SelectObjectContentRequest.Builder expressionType(ExpressionType expressionType)
The type of the provided expression (for example, SQL).
expressionType
- The type of the provided expression (for example, SQL).ExpressionType
,
ExpressionType
SelectObjectContentRequest.Builder requestProgress(RequestProgress requestProgress)
Specifies if periodic request progress information should be enabled.
requestProgress
- Specifies if periodic request progress information should be enabled.default SelectObjectContentRequest.Builder requestProgress(Consumer<RequestProgress.Builder> requestProgress)
Specifies if periodic request progress information should be enabled.
This is a convenience method that creates an instance of theRequestProgress.Builder
avoiding the
need to create one manually via RequestProgress.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to requestProgress(RequestProgress)
.
requestProgress
- a consumer that will call methods on RequestProgress.Builder
requestProgress(RequestProgress)
SelectObjectContentRequest.Builder inputSerialization(InputSerialization inputSerialization)
Describes the format of the data in the object that is being queried.
inputSerialization
- Describes the format of the data in the object that is being queried.default SelectObjectContentRequest.Builder inputSerialization(Consumer<InputSerialization.Builder> inputSerialization)
Describes the format of the data in the object that is being queried.
This is a convenience method that creates an instance of theInputSerialization.Builder
avoiding the
need to create one manually via InputSerialization.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its
result is passed to inputSerialization(InputSerialization)
.
inputSerialization
- a consumer that will call methods on InputSerialization.Builder
inputSerialization(InputSerialization)
SelectObjectContentRequest.Builder outputSerialization(OutputSerialization outputSerialization)
Describes the format of the data that you want Amazon S3 to return in response.
outputSerialization
- Describes the format of the data that you want Amazon S3 to return in response.default SelectObjectContentRequest.Builder outputSerialization(Consumer<OutputSerialization.Builder> outputSerialization)
Describes the format of the data that you want Amazon S3 to return in response.
This is a convenience method that creates an instance of theOutputSerialization.Builder
avoiding the
need to create one manually via OutputSerialization.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to outputSerialization(OutputSerialization)
.
outputSerialization
- a consumer that will call methods on OutputSerialization.Builder
outputSerialization(OutputSerialization)
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.
ScanRange
may 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.
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.
ScanRange
may 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.
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.
ScanRange
may 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.
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)
.
scanRange
- a consumer that will call methods on ScanRange.Builder
scanRange(ScanRange)
SelectObjectContentRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a different account, the
request fails with the HTTP status code 403 Forbidden
(access denied).SelectObjectContentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
SelectObjectContentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.