Class TapeArchive

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

Represents a virtual tape that is archived in the virtual tape shelf (VTS).

See Also:

  • Method Details

    • tapeARN

      public final String tapeARN()

      The Amazon Resource Name (ARN) of an archived virtual tape.

      Returns:
      The Amazon Resource Name (ARN) of an archived virtual tape.

    • tapeBarcode

      public final String tapeBarcode()

      The barcode that identifies the archived virtual tape.

      Returns:
      The barcode that identifies the archived virtual tape.

    • tapeCreatedDate

      public final Instant tapeCreatedDate()

      The date the virtual tape was created.

      Returns:
      The date the virtual tape was created.

    • tapeSizeInBytes

      public final Long tapeSizeInBytes()

      The size, in bytes, of the archived virtual tape.

      Returns:
      The size, in bytes, of the archived virtual tape.

    • completionTime

      public final Instant completionTime()

      The time that the archiving of the virtual tape was completed.

      The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

      Returns:
      The time that the archiving of the virtual tape was completed.

      The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    • retrievedTo

      public final String retrievedTo()

      The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.

      The virtual tape is retrieved from the virtual tape shelf (VTS).

      Returns:
      The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.

      The virtual tape is retrieved from the virtual tape shelf (VTS).

    • tapeStatus

      public final String tapeStatus()

      The current state of the archived virtual tape.

      Returns:
      The current state of the archived virtual tape.

    • tapeUsedInBytes

      public final Long tapeUsedInBytes()

      The size, in bytes, of data stored on the virtual tape.

      This value is not available for tapes created prior to May 13, 2015.

      Returns:
      The size, in bytes, of data stored on the virtual tape.

      This value is not available for tapes created prior to May 13, 2015.

    • kmsKey

      public final String kmsKey()
      Returns the value of the KMSKey property for this object.
      Returns:
      The value of the KMSKey property for this object.

    • poolId

      public final String poolId()

      The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

      Returns:
      The ID of the pool that was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.

    • worm

      public final Boolean worm()

      Set to true if the archived tape is stored as write-once-read-many (WORM).

      Returns:
      Set to true if the archived tape is stored as write-once-read-many (WORM).

    • retentionStartDate

      public final Instant retentionStartDate()

      If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.

      Returns:
      If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.

    • poolEntryDate

      public final Instant poolEntryDate()

      The time that the tape entered the custom tape pool.

      The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

      Returns:
      The time that the tape entered the custom tape pool.

      The default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z' format.

    • toBuilder

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

    • builder

      public static TapeArchive.Builder builder()

    • serializableBuilderClass

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