Class AnnotationEntry

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

Describes a single annotation attached to an object, including its name, last modified time, size, ETag, checksum algorithm, and replication status. Returned in the response from ListObjectAnnotations.

See Also:

  • Method Details

    • annotationName

      public final String annotationName()

      The name of the annotation.

      Returns:
      The name of the annotation.

    • lastModified

      public final Instant lastModified()

      The date and time the annotation was last modified.

      Returns:
      The date and time the annotation was last modified.

    • eTag

      public final String eTag()

      The entity tag of the annotation.

      Returns:
      The entity tag of the annotation.

    • checksumAlgorithm

      public final List<ChecksumAlgorithm> checksumAlgorithm()

      The checksum algorithm used for the annotation.

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

      Returns:
      The checksum algorithm used for the annotation.

    • hasChecksumAlgorithm

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

    • checksumAlgorithmAsStrings

      public final List<String> checksumAlgorithmAsStrings()

      The checksum algorithm used for the annotation.

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

      Returns:
      The checksum algorithm used for the annotation.

    • size

      public final Long size()

      The size of the annotation payload, in bytes.

      Returns:
      The size of the annotation payload, in bytes.

    • replicationStatus

      public final ReplicationStatus replicationStatus()

      The replication status of the annotation.

      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:
      The replication status of the annotation.
      See Also:

    • replicationStatusAsString

      public final String replicationStatusAsString()

      The replication status of the annotation.

      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:
      The replication status of the annotation.
      See Also:

    • toBuilder

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

    • builder

      public static AnnotationEntry.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AnnotationEntry.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.