Package software.amazon.awssdk.services.s3.model

Class WriteGetObjectResponseRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.s3.model.S3Request
software.amazon.awssdk.services.s3.model.WriteGetObjectResponseRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<WriteGetObjectResponseRequest.Builder,WriteGetObjectResponseRequest>
@Generated("software.amazon.awssdk:codegen") public final class WriteGetObjectResponseRequest extends S3Request implements ToCopyableBuilder<WriteGetObjectResponseRequest.Builder,WriteGetObjectResponseRequest>

  • Method Details

    • requestRoute

      public final String requestRoute()

      Route prefix to the HTTP URL generated.

      Returns:
      Route prefix to the HTTP URL generated.

    • requestToken

      public final String requestToken()

      A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

      Returns:
      A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

    • statusCode

      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

      Returns:
      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

    • errorCode

      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]+$".

      Returns:
      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]+$".

    • errorMessage

      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.

      Returns:
      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.

    • acceptRanges

      public final String acceptRanges()

      Indicates that a range of bytes was specified.

      Returns:
      Indicates that a range of bytes was specified.

    • cacheControl

      public final String cacheControl()

      Specifies caching behavior along the request/reply chain.

      Returns:
      Specifies caching behavior along the request/reply chain.

    • contentDisposition

      public final String contentDisposition()

      Specifies presentational information for the object.

      Returns:
      Specifies presentational information for the object.

    • contentEncoding

      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.

      Returns:
      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.

    • contentLanguage

      public final String contentLanguage()

      The language the content is in.

      Returns:
      The language the content is in.

    • contentLength

      public final Long contentLength()

      The size of the content body in bytes.

      Returns:
      The size of the content body in bytes.

    • contentRange

      public final String contentRange()

      The portion of the object returned in the response.

      Returns:
      The portion of the object returned in the response.

    • contentType

      public final String contentType()

      A standard MIME type describing the format of the object data.

      Returns:
      A standard MIME type describing the format of the object data.

    • checksumCRC32

      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.

      Returns:
      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.

    • checksumCRC32C

      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.

      Returns:
      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.

    • checksumSHA1

      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.

      Returns:
      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.

    • checksumSHA256

      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.

      Returns:
      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.

    • deleteMarker

      public final Boolean deleteMarker()

      Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

      Returns:
      Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

    • eTag

      public final String eTag()

      An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

      Returns:
      An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

    • expires

      public final Instant expires()

      The date and time at which the object is no longer cacheable.

      Returns:
      The date and time at which the object is no longer cacheable.

    • expiration

      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.

      Returns:
      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.

    • lastModified

      public final Instant lastModified()

      The date and time that the object was last modified.

      Returns:
      The date and time that the object was last modified.

    • missingMeta

      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.

      Returns:
      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.

    • hasMetadata

      public final boolean hasMetadata()
      For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • metadata

      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.

      Returns:
      A map of metadata to store with the object in S3.

    • objectLockMode

      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().

      Returns:
      Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
      See Also:

    • objectLockModeAsString

      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().

      Returns:
      Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.
      See Also:

    • objectLockLegalHoldStatus

      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().

      Returns:
      Indicates whether an object stored in Amazon S3 has an active legal hold.
      See Also:

    • objectLockLegalHoldStatusAsString

      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().

      Returns:
      Indicates whether an object stored in Amazon S3 has an active legal hold.
      See Also:

    • objectLockRetainUntilDate

      public final Instant objectLockRetainUntilDate()

      The date and time when Object Lock is configured to expire.

      Returns:
      The date and time when Object Lock is configured to expire.

    • partsCount

      public final Integer partsCount()

      The count of parts this object has.

      Returns:
      The count of parts this object has.

    • replicationStatus

      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().

      Returns:
      Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
      See Also:

    • replicationStatusAsString

      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().

      Returns:
      Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.
      See Also:

    • requestCharged

      public final RequestCharged requestCharged()
      Returns the value of the RequestCharged property for this object.

      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().

      Returns:
      The value of the RequestCharged property for this object.
      See Also:

    • requestChargedAsString

      public final String requestChargedAsString()
      Returns the value of the RequestCharged property for this object.

      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().

      Returns:
      The value of the RequestCharged property for this object.
      See Also:

    • restore

      public final String restore()

      Provides information about object restoration operation and expiration time of the restored object copy.

      Returns:
      Provides information about object restoration operation and expiration time of the restored object copy.

    • serverSideEncryption

      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().

      Returns:
      The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
      See Also:

    • serverSideEncryptionAsString

      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().

      Returns:
      The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).
      See Also:

    • sseCustomerAlgorithm

      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.

      Returns:
      Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

    • ssekmsKeyId

      public final String ssekmsKeyId()

      If present, specifies the ID (Key ID, Key ARN, or Key Alias) 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.

      Returns:
      If present, specifies the ID (Key ID, Key ARN, or Key Alias) 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.

    • sseCustomerKeyMD5

      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).

      Returns:
      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).

    • storageClass

      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().

      Returns:
      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.

      See Also:

    • storageClassAsString

      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().

      Returns:
      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.

      See Also:

    • tagCount

      public final Integer tagCount()

      The number of tags, if any, on the object.

      Returns:
      The number of tags, if any, on the object.

    • versionId

      public final String versionId()

      An ID used to reference a specific version of the object.

      Returns:
      An ID used to reference a specific version of the object.

    • bucketKeyEnabled

      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).

      Returns:
      Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

    • toBuilder

      public WriteGetObjectResponseRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<WriteGetObjectResponseRequest.Builder,WriteGetObjectResponseRequest>
      Specified by:
      toBuilder in class S3Request
      Returns:
      a builder for type T

    • builder

      public static WriteGetObjectResponseRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WriteGetObjectResponseRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.