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

Class CopyObjectResponse

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

  • Method Details

    • copyObjectResult

      public final CopyObjectResult copyObjectResult()

      Container for all response elements.

      Returns:
      Container for all response elements.

    • expiration

      public final String expiration()

      If the object expiration is configured, the response includes this header.

      Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.

      Returns:
      If the object expiration is configured, the response includes this header.

      Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.

    • copySourceVersionId

      public final String copySourceVersionId()

      Version ID of the source object that was copied.

      This functionality is not supported when the source object is in a directory bucket.

      Returns:
      Version ID of the source object that was copied.

      This functionality is not supported when the source object is in a directory bucket.

    • versionId

      public final String versionId()

      Version ID of the newly created copy.

      This functionality is not supported for directory buckets.

      Returns:
      Version ID of the newly created copy.

      This functionality is not supported for directory buckets.

    • serverSideEncryption

      public final ServerSideEncryption serverSideEncryption()

      The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.

      When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

      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 you store this object in Amazon S3 or Amazon FSx.

      When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

      See Also:

    • serverSideEncryptionAsString

      public final String serverSideEncryptionAsString()

      The server-side encryption algorithm used when you store this object in Amazon S3 or Amazon FSx.

      When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

      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 you store this object in Amazon S3 or Amazon FSx.

      When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

      See Also:

    • sseCustomerAlgorithm

      public final String sseCustomerAlgorithm()

      If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

      This functionality is not supported for directory buckets.

      Returns:
      If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

      This functionality is not supported for directory buckets.

    • sseCustomerKeyMD5

      public final String sseCustomerKeyMD5()

      If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

      This functionality is not supported for directory buckets.

      Returns:
      If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

      This functionality is not supported for directory buckets.

    • ssekmsKeyId

      public final String ssekmsKeyId()

      If present, indicates the ID of the KMS key that was used for object encryption.

      Returns:
      If present, indicates the ID of the KMS key that was used for object encryption.

    • ssekmsEncryptionContext

      public final String ssekmsEncryptionContext()

      If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded UTF-8 string holding JSON with the encryption context key-value pairs.

      Returns:
      If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded UTF-8 string holding JSON with the encryption context key-value pairs.

    • bucketKeyEnabled

      public final Boolean bucketKeyEnabled()

      Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

      Returns:
      Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

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

    • toBuilder

      public CopyObjectResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CopyObjectResponse.Builder,CopyObjectResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static CopyObjectResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo