SelectObjectContentRequest class

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.

Constructors

SelectObjectContentRequest({required String bucket, required String expression, required ExpressionType expressionType, required InputSerialization inputSerialization, required String key, required OutputSerialization outputSerialization, String? expectedBucketOwner, RequestProgress? requestProgress, String? sSECustomerAlgorithm, Uint8List? sSECustomerKey, String? sSECustomerKeyMD5, ScanRange? scanRange})

Properties

bucket → String

The S3 bucket.

final

expectedBucketOwner → String?

The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

final

expression → String

The expression that is used to query the object.

final

expressionType → ExpressionType

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

final

hashCode → int

The hash code for this object.

no setter, inherited

inputSerialization → InputSerialization

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

final

key → String

The object key.

final

outputSerialization → OutputSerialization

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

final

requestProgress → RequestProgress?

Specifies if periodic request progress information should be enabled.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

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.

final

sSECustomerAlgorithm → String?

The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

final

sSECustomerKey → Uint8List?

The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

final

sSECustomerKeyMD5 → String?

The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

toXml(String elemName, {List<XmlAttribute>? attributes}) → XmlElement

Operators

operator ==(Object other) → bool

The equality operator.

inherited