Class ObjectVersion

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

The version of an object.

See Also:

  • Method Details

    • eTag

      public final String eTag()

      The entity tag is an MD5 hash of that version of the object.

      Returns:
      The entity tag is an MD5 hash of that version of the object.

    • checksumAlgorithm

      public final List<ChecksumAlgorithm> checksumAlgorithm()

      The algorithm that was used to create a checksum of the object.

      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 algorithm that was used to create a checksum of the object.

    • 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 algorithm that was used to create a checksum of the object.

      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 algorithm that was used to create a checksum of the object.

    • checksumType

      public final ChecksumType checksumType()

      The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

      Returns:
      The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
      See Also:

    • checksumTypeAsString

      public final String checksumTypeAsString()

      The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

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

      Returns:
      The checksum type that is used to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.
      See Also:

    • size

      public final Long size()

      Size in bytes of the object.

      Returns:
      Size in bytes of the object.

    • storageClass

      public final ObjectVersionStorageClass storageClass()

      The class of storage used to store the object.

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

      Returns:
      The class of storage used to store the object.
      See Also:

    • storageClassAsString

      public final String storageClassAsString()

      The class of storage used to store the object.

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

      Returns:
      The class of storage used to store the object.
      See Also:

    • key

      public final String key()

      The object key.

      Returns:
      The object key.

    • versionId

      public final String versionId()

      Version ID of an object.

      Returns:
      Version ID of an object.

    • isLatest

      public final Boolean isLatest()

      Specifies whether the object is (true) or is not (false) the latest version of an object.

      Returns:
      Specifies whether the object is (true) or is not (false) the latest version of an object.

    • lastModified

      public final Instant lastModified()

      Date and time when the object was last modified.

      Returns:
      Date and time when the object was last modified.

    • owner

      public final Owner owner()

      Specifies the owner of the object.

      Returns:
      Specifies the owner of the object.

    • restoreStatus

      public final RestoreStatus restoreStatus()

      Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

      Returns:
      Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

    • toBuilder

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

    • builder

      public static ObjectVersion.Builder builder()

    • serializableBuilderClass

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