@Generated(value="software.amazon.awssdk:codegen") public final class SelectObjectContentRequest extends S3Request implements ToCopyableBuilder<SelectObjectContentRequest.Builder,SelectObjectContentRequest>
Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.
Modifier and Type | Class and Description |
---|---|
static interface |
SelectObjectContentRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The S3 bucket.
|
static SelectObjectContentRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
String |
expression()
The expression that is used to query the object.
|
ExpressionType |
expressionType()
The type of the provided expression (for example, SQL).
|
String |
expressionTypeAsString()
The type of the provided expression (for example, SQL).
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
InputSerialization |
inputSerialization()
Describes the format of the data in the object that is being queried.
|
String |
key()
The object key.
|
OutputSerialization |
outputSerialization()
Describes the format of the data that you want Amazon S3 to return in response.
|
RequestProgress |
requestProgress()
Specifies if periodic request progress information should be enabled.
|
ScanRange |
scanRange()
Specifies the byte range of the object to get the records from.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends SelectObjectContentRequest.Builder> |
serializableBuilderClass() |
String |
sseCustomerAlgorithm()
The server-side encryption (SSE) algorithm used to encrypt the object.
|
String |
sseCustomerKey()
The server-side encryption (SSE) customer managed key.
|
String |
sseCustomerKeyMD5()
The MD5 server-side encryption (SSE) customer managed key.
|
SelectObjectContentRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String bucket()
The S3 bucket.
public final String key()
The object key.
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.
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.
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.
public final String expression()
The expression that is used to query the object.
public final ExpressionType expressionType()
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()
.
ExpressionType
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()
.
ExpressionType
public final RequestProgress requestProgress()
Specifies if periodic request progress information should be enabled.
public final InputSerialization inputSerialization()
Describes the format of the data in the object that is being queried.
public final OutputSerialization outputSerialization()
Describes the format of the data that you want Amazon S3 to return in response.
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.
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
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.
public final 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).
403 Forbidden
(access denied).public SelectObjectContentRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<SelectObjectContentRequest.Builder,SelectObjectContentRequest>
toBuilder
in class S3Request
public static SelectObjectContentRequest.Builder builder()
public static Class<? extends SelectObjectContentRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.