Class S3ObjectMetadata

java.lang.Object
software.amazon.awssdk.services.s3control.model.S3ObjectMetadata
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<S3ObjectMetadata.Builder,S3ObjectMetadata>
@Generated("software.amazon.awssdk:codegen") public final class S3ObjectMetadata extends Object implements SdkPojo, Serializable, ToCopyableBuilder<S3ObjectMetadata.Builder,S3ObjectMetadata>

See Also:

  • Method Details

    • cacheControl

      public final String cacheControl()

      Returns:

    • contentDisposition

      public final String contentDisposition()

      Returns:

    • contentEncoding

      public final String contentEncoding()

      Returns:

    • contentLanguage

      public final String contentLanguage()

      Returns:

    • hasUserMetadata

      public final boolean hasUserMetadata()
      For responses, this returns true if the service returned a value for the UserMetadata 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.

    • userMetadata

      public final Map<String,String> userMetadata()

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

      Returns:

    • contentLength

      public final Long contentLength()

      This member has been deprecated.

      Returns:
      This member has been deprecated.

    • contentMD5

      public final String contentMD5()

      This member has been deprecated.

      Returns:
      This member has been deprecated.

    • contentType

      public final String contentType()

      Returns:

    • httpExpiresDate

      public final Instant httpExpiresDate()

      Returns:

    • requesterCharged

      public final Boolean requesterCharged()

      This member has been deprecated.

      Returns:
      This member has been deprecated.

    • sseAlgorithm

      public final S3SSEAlgorithm sseAlgorithm()

      The server-side encryption algorithm used when storing objects in Amazon S3.

      Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (KMS). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For the Copy operation in Batch Operations, see S3CopyObjectOperation.

      If the service returns an enum value that is not available in the current SDK version, sseAlgorithm will return S3SSEAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sseAlgorithmAsString().

      Returns:
      The server-side encryption algorithm used when storing objects in Amazon S3.

      Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (KMS). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For the Copy operation in Batch Operations, see S3CopyObjectOperation.

      See Also:

    • sseAlgorithmAsString

      public final String sseAlgorithmAsString()

      The server-side encryption algorithm used when storing objects in Amazon S3.

      Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (KMS). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For the Copy operation in Batch Operations, see S3CopyObjectOperation.

      If the service returns an enum value that is not available in the current SDK version, sseAlgorithm will return S3SSEAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sseAlgorithmAsString().

      Returns:
      The server-side encryption algorithm used when storing objects in Amazon S3.

      Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (KMS). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For the Copy operation in Batch Operations, see S3CopyObjectOperation.

      See Also:

    • toBuilder

      public S3ObjectMetadata.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<S3ObjectMetadata.Builder,S3ObjectMetadata>
      Returns:
      a builder for type T

    • builder

      public static S3ObjectMetadata.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.