SelectObjectContentRequest (AWS Java SDK for Amazon S3 1.11.780 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.s3.model.SelectObjectContentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, SSECustomerKeyProvider, Serializable, Cloneable
```
public class SelectObjectContentRequest
extends AmazonWebServiceRequest
implements SSECustomerKeyProvider, Serializable, Cloneable
```
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 also specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, go to S3Select API Documentation.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

SelectObjectContentRequest()

Constructors
Constructor and Description
`SelectObjectContentRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getBucketName()` The S3 Bucket.
`String`	`getExpression()` The expression that is used to query the object.
`String`	`getExpressionType()` The type of the provided expression (e.g., SQL).
`InputSerialization`	`getInputSerialization()` Describes the format of the data in the object that is being queried.
`String`	`getKey()` The Object Key.
`OutputSerialization`	`getOutputSerialization()` Describes the format of the data that you want Amazon S3 to return in response.
`RequestProgress`	`getRequestProgress()` Describes optional, periodic `SelectObjectContentEvent.ProgressEvent`s that can be returned.
`ScanRange`	`getScanRange()` The byte range of the query
`SSECustomerKey`	`getSSECustomerKey()` Returns the optional customer-provided server-side encryption key to use to encrypt the uploaded object.
`void`	`setBucketName(String bucketName)` The S3 Bucket.
`void`	`setExpression(String expression)` The expression that is used to query the object.
`void`	`setExpressionType(ExpressionType expressionType)` The type of the provided expression (e.g., SQL).
`void`	`setExpressionType(String expressionType)` The type of the provided expression (e.g., SQL).
`void`	`setInputSerialization(InputSerialization inputSerialization)` Describes the format of the data in the object that is being queried.
`void`	`setKey(String key)` The Object Key.
`void`	`setOutputSerialization(OutputSerialization outputSerialization)` Describes the format of the data that you want Amazon S3 to return in response.
`void`	`setRequestProgress(RequestProgress requestProgress)` Describes optional, periodic `SelectObjectContentEvent.ProgressEvent`s that can be returned.
`void`	`setScanRange(ScanRange scanRange)` The byte range of the query
`void`	`setSSECustomerKey(SSECustomerKey sseCustomerKey)`
`SelectObjectContentRequest`	`withBucketName(String bucketName)` The S3 Bucket.
`SelectObjectContentRequest`	`withExpression(String expression)` The expression that is used to query the object.
`SelectObjectContentRequest`	`withExpressionType(ExpressionType expressionType)` The type of the provided expression (e.g., SQL).
`SelectObjectContentRequest`	`withExpressionType(String expressionType)` The type of the provided expression (e.g., SQL).
`SelectObjectContentRequest`	`withInputSerialization(InputSerialization inputSerialization)` Describes the format of the data in the object that is being queried.
`SelectObjectContentRequest`	`withKey(String key)` The Object Key.
`SelectObjectContentRequest`	`withOutputSerialization(OutputSerialization outputSerialization)` Describes the format of the data that you want Amazon S3 to return in response.
`SelectObjectContentRequest`	`withRequestProgress(RequestProgress requestProgress)` Describes optional, periodic `SelectObjectContentEvent.ProgressEvent`s that can be returned.
`SelectObjectContentRequest`	`withScanRange(ScanRange scanRange)` The byte range of the query
`SelectObjectContentRequest`	`withSSECustomerKey(SSECustomerKey sseCustomerKey)`

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SelectObjectContentRequest
```
public SelectObjectContentRequest()
```
- Method Detail
  - getBucketName
```
public String getBucketName()
```
    The S3 Bucket.
  - setBucketName
```
public void setBucketName(String bucketName)
```
    The S3 Bucket.
  - withBucketName
```
public SelectObjectContentRequest withBucketName(String bucketName)
```
    The S3 Bucket.
  - getKey
```
public String getKey()
```
    The Object Key.
  - setKey
```
public void setKey(String key)
```
    The Object Key.
  - withKey
```
public SelectObjectContentRequest withKey(String key)
```
    The Object Key.
  - getExpression
```
public String getExpression()
```
    The expression that is used to query the object.
  - setExpression
```
public void setExpression(String expression)
```
    The expression that is used to query the object.
  - withExpression
```
public SelectObjectContentRequest withExpression(String expression)
```
    The expression that is used to query the object.
  - getExpressionType
```
public String getExpressionType()
```
    The type of the provided expression (e.g., SQL).
  - setExpressionType
```
public void setExpressionType(String expressionType)
```
    The type of the provided expression (e.g., SQL).
  - withExpressionType
```
public SelectObjectContentRequest withExpressionType(String expressionType)
```
    The type of the provided expression (e.g., SQL).
  - setExpressionType
```
public void setExpressionType(ExpressionType expressionType)
```
    The type of the provided expression (e.g., SQL).
  - withExpressionType
```
public SelectObjectContentRequest withExpressionType(ExpressionType expressionType)
```
    The type of the provided expression (e.g., SQL).
  - getScanRange
```
public ScanRange getScanRange()
```
    The byte range of the query
  - setScanRange
```
public void setScanRange(ScanRange scanRange)
```
    The byte range of the query
  - withScanRange
```
public SelectObjectContentRequest withScanRange(ScanRange scanRange)
```
    The byte range of the query
  - getRequestProgress
```
public RequestProgress getRequestProgress()
```
    Describes optional, periodic SelectObjectContentEvent.ProgressEvents that can be returned.
  - setRequestProgress
```
public void setRequestProgress(RequestProgress requestProgress)
```
    Describes optional, periodic SelectObjectContentEvent.ProgressEvents that can be returned.
  - withRequestProgress
```
public SelectObjectContentRequest withRequestProgress(RequestProgress requestProgress)
```
    Describes optional, periodic SelectObjectContentEvent.ProgressEvents that can be returned.
  - getInputSerialization
```
public InputSerialization getInputSerialization()
```
    Describes the format of the data in the object that is being queried.
  - setInputSerialization
```
public void setInputSerialization(InputSerialization inputSerialization)
```
    Describes the format of the data in the object that is being queried.
  - withInputSerialization
```
public SelectObjectContentRequest withInputSerialization(InputSerialization inputSerialization)
```
    Describes the format of the data in the object that is being queried.
  - getOutputSerialization
```
public OutputSerialization getOutputSerialization()
```
    Describes the format of the data that you want Amazon S3 to return in response.
  - setOutputSerialization
```
public void setOutputSerialization(OutputSerialization outputSerialization)
```
    Describes the format of the data that you want Amazon S3 to return in response.
  - withOutputSerialization
```
public SelectObjectContentRequest withOutputSerialization(OutputSerialization outputSerialization)
```
    Describes the format of the data that you want Amazon S3 to return in response.
  - getSSECustomerKey
```
public SSECustomerKey getSSECustomerKey()
```
    Description copied from interface: SSECustomerKeyProvider
    
    Returns the optional customer-provided server-side encryption key to use to encrypt the uploaded object.
    
    Specified by:
    
    getSSECustomerKey in interface SSECustomerKeyProvider
    
    Returns:
    
    The optional customer-provided server-side encryption key to use to encrypt the uploaded object.
  - setSSECustomerKey
```
public void setSSECustomerKey(SSECustomerKey sseCustomerKey)
```
  - withSSECustomerKey
```
public SelectObjectContentRequest withSSECustomerKey(SSECustomerKey sseCustomerKey)
```

Class SelectObjectContentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SelectObjectContentRequest

Method Detail

getBucketName

setBucketName

withBucketName

getKey

setKey

withKey

getExpression

setExpression

withExpression

getExpressionType

setExpressionType

withExpressionType

setExpressionType

withExpressionType

getScanRange

setScanRange

withScanRange

getRequestProgress

setRequestProgress

withRequestProgress

getInputSerialization

setInputSerialization

withInputSerialization

getOutputSerialization

setOutputSerialization

withOutputSerialization

getSSECustomerKey

setSSECustomerKey

withSSECustomerKey