@Generated(value="software.amazon.awssdk:codegen") public final class WriteGetObjectResponseRequest extends S3Request implements ToCopyableBuilder<WriteGetObjectResponseRequest.Builder,WriteGetObjectResponseRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
WriteGetObjectResponseRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
acceptRanges()
Indicates that a range of bytes was specified.
|
Boolean |
bucketKeyEnabled()
Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web
Services KMS (SSE-KMS).
|
static WriteGetObjectResponseRequest.Builder |
builder() |
String |
cacheControl()
Specifies caching behavior along the request/reply chain.
|
String |
checksumCRC32()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
String |
checksumCRC32C()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
String |
checksumSHA1()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
String |
checksumSHA256()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent.
|
String |
contentDisposition()
Specifies presentational information for the object.
|
String |
contentEncoding()
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be
applied to obtain the media-type referenced by the Content-Type header field.
|
String |
contentLanguage()
The language the content is in.
|
Long |
contentLength()
The size of the content body in bytes.
|
String |
contentRange()
The portion of the object returned in the response.
|
String |
contentType()
A standard MIME type describing the format of the object data.
|
Boolean |
deleteMarker()
Specifies whether an object stored in Amazon S3 is (
true ) or is not (false ) a delete
marker. |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
errorCode()
A string that uniquely identifies an error condition.
|
String |
errorMessage()
Contains a generic description of the error condition.
|
String |
eTag()
An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
|
String |
expiration()
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
|
Instant |
expires()
The date and time at which the object is no longer cacheable.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasMetadata()
For responses, this returns true if the service returned a value for the Metadata property.
|
Instant |
lastModified()
The date and time that the object was last modified.
|
Map<String,String> |
metadata()
A map of metadata to store with the object in S3.
|
Integer |
missingMeta()
Set to the number of metadata entries not returned in
x-amz-meta headers. |
ObjectLockLegalHoldStatus |
objectLockLegalHoldStatus()
Indicates whether an object stored in Amazon S3 has an active legal hold.
|
String |
objectLockLegalHoldStatusAsString()
Indicates whether an object stored in Amazon S3 has an active legal hold.
|
ObjectLockMode |
objectLockMode()
Indicates whether an object stored in Amazon S3 has Object Lock enabled.
|
String |
objectLockModeAsString()
Indicates whether an object stored in Amazon S3 has Object Lock enabled.
|
Instant |
objectLockRetainUntilDate()
The date and time when Object Lock is configured to expire.
|
Integer |
partsCount()
The count of parts this object has.
|
ReplicationStatus |
replicationStatus()
Indicates if request involves bucket that is either a source or destination in a Replication rule.
|
String |
replicationStatusAsString()
Indicates if request involves bucket that is either a source or destination in a Replication rule.
|
RequestCharged |
requestCharged()
Returns the value of the RequestCharged property for this object.
|
String |
requestChargedAsString()
Returns the value of the RequestCharged property for this object.
|
String |
requestRoute()
Route prefix to the HTTP URL generated.
|
String |
requestToken()
A single use encrypted token that maps
WriteGetObjectResponse to the end user GetObject
request. |
String |
restore()
Provides information about object restoration operation and expiration time of the restored object copy.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends WriteGetObjectResponseRequest.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
serverSideEncryption()
The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256,
aws:kms ). |
String |
serverSideEncryptionAsString()
The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256,
aws:kms ). |
String |
sseCustomerAlgorithm()
Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for
object stored in Amazon S3.
|
String |
sseCustomerKeyMD5()
128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3.
|
String |
ssekmsKeyId()
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS)
symmetric encryption customer managed key that was used for stored in Amazon S3 object.
|
Integer |
statusCode()
The integer status code for an HTTP response of a corresponding
GetObject request. |
StorageClass |
storageClass()
Provides storage class information of the object.
|
String |
storageClassAsString()
Provides storage class information of the object.
|
Integer |
tagCount()
The number of tags, if any, on the object.
|
WriteGetObjectResponseRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
An ID used to reference a specific version of the object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String requestRoute()
Route prefix to the HTTP URL generated.
public final String requestToken()
A single use encrypted token that maps WriteGetObjectResponse
to the end user GetObject
request.
WriteGetObjectResponse
to the end user
GetObject
request.public final Integer statusCode()
The integer status code for an HTTP response of a corresponding GetObject
request. The following is
a list of status codes.
200 - OK
206 - Partial Content
304 - Not Modified
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
409 - Conflict
411 - Length Required
412 - Precondition Failed
416 - Range Not Satisfiable
500 - Internal Server Error
503 - Service Unavailable
GetObject
request. The
following is a list of status codes.
200 - OK
206 - Partial Content
304 - Not Modified
400 - Bad Request
401 - Unauthorized
403 - Forbidden
404 - Not Found
405 - Method Not Allowed
409 - Conflict
411 - Length Required
412 - Precondition Failed
416 - Range Not Satisfiable
500 - Internal Server Error
503 - Service Unavailable
public final String errorCode()
A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response
for a corresponding GetObject
call. Cannot be used with a successful StatusCode
header
or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular
expression (regex) value is "^[A-Z][a-zA-Z]+$"
.
GetObject
call. Cannot be used with a successful
StatusCode
header or when the transformed object is provided in the body. All error codes
from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$"
.public final String errorMessage()
Contains a generic description of the error condition. Returned in the <Message> tag of the error XML
response for a corresponding GetObject
call. Cannot be used with a successful
StatusCode
header or when the transformed object is provided in body.
GetObject
call. Cannot be used with a successful
StatusCode
header or when the transformed object is provided in body.public final String acceptRanges()
Indicates that a range of bytes was specified.
public final String cacheControl()
Specifies caching behavior along the request/reply chain.
public final String contentDisposition()
Specifies presentational information for the object.
public final String contentEncoding()
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
public final String contentLanguage()
The language the content is in.
public final Long contentLength()
The size of the content body in bytes.
public final String contentRange()
The portion of the object returned in the response.
public final String contentType()
A standard MIME type describing the format of the object data.
public final String checksumCRC32()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent. This specifies the base64-encoded, 32-bit CRC32 checksum of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform
validation of the checksum values only when the original GetObject
request required checksum
validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
GetObject
request
required checksum validation. For more information about checksums, see Checking
object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
public final String checksumCRC32C()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent. This specifies the base64-encoded, 32-bit CRC32C checksum of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform
validation of the checksum values only when the original GetObject
request required checksum
validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
GetObject
request
required checksum validation. For more information about checksums, see Checking
object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
public final String checksumSHA1()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform
validation of the checksum values only when the original GetObject
request required checksum
validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
GetObject
request
required checksum validation. For more information about checksums, see Checking
object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
public final String checksumSHA256()
This header can be used as a data integrity check to verify that the data received is the same data that was
originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object
Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform
validation of the checksum values only when the original GetObject
request required checksum
validation. For more information about checksums, see Checking object
integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
GetObject
request
required checksum validation. For more information about checksums, see Checking
object integrity in the Amazon S3 User Guide.
Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.
public final Boolean deleteMarker()
Specifies whether an object stored in Amazon S3 is (true
) or is not (false
) a delete
marker.
true
) or is not (false
) a
delete marker.public final String eTag()
An opaque identifier assigned by a web server to a specific version of a resource found at a URL.
public final Instant expires()
The date and time at which the object is no longer cacheable.
public final String expiration()
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes
the expiry-date
and rule-id
key-value pairs that provide the object expiration
information. The value of the rule-id
is URL-encoded.
expiry-date
and rule-id
key-value pairs that provide the object
expiration information. The value of the rule-id
is URL-encoded.public final Instant lastModified()
The date and time that the object was last modified.
public final Integer missingMeta()
Set to the number of metadata entries not returned in x-amz-meta
headers. This can happen if you
create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using
SOAP, you can create metadata whose values are not legal HTTP headers.
x-amz-meta
headers. This can happen if
you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For
example, using SOAP, you can create metadata whose values are not legal HTTP headers.public final boolean hasMetadata()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final Map<String,String> metadata()
A map of metadata to store with the object in S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasMetadata()
method.
public final ObjectLockMode objectLockMode()
Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public final String objectLockModeAsString()
Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
Indicates whether an object stored in Amazon S3 has an active legal hold.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
public final String objectLockLegalHoldStatusAsString()
Indicates whether an object stored in Amazon S3 has an active legal hold.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
public final Instant objectLockRetainUntilDate()
The date and time when Object Lock is configured to expire.
public final Integer partsCount()
The count of parts this object has.
public final ReplicationStatus replicationStatus()
Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
If the service returns an enum value that is not available in the current SDK version, replicationStatus
will return ReplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from replicationStatusAsString()
.
ReplicationStatus
public final String replicationStatusAsString()
Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
If the service returns an enum value that is not available in the current SDK version, replicationStatus
will return ReplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from replicationStatusAsString()
.
ReplicationStatus
public final RequestCharged requestCharged()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final String requestChargedAsString()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final String restore()
Provides information about object restoration operation and expiration time of the restored object copy.
public final ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256,
aws:kms
).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
aws:kms
).ServerSideEncryption
public final String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256,
aws:kms
).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
aws:kms
).ServerSideEncryption
public final String sseCustomerAlgorithm()
Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.
public final String ssekmsKeyId()
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.
public final String sseCustomerKeyMD5()
128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).
public final StorageClass storageClass()
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
For more information, see Storage Classes.
StorageClass
public final String storageClassAsString()
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
For more information, see Storage Classes.
StorageClass
public final Integer tagCount()
The number of tags, if any, on the object.
public final String versionId()
An ID used to reference a specific version of the object.
public final Boolean bucketKeyEnabled()
Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
public WriteGetObjectResponseRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<WriteGetObjectResponseRequest.Builder,WriteGetObjectResponseRequest>
toBuilder
in class S3Request
public static WriteGetObjectResponseRequest.Builder builder()
public static Class<? extends WriteGetObjectResponseRequest.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.