Package software.amazon.awssdk.services.storagegateway.model

Class Tape

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

Describes a virtual tape object.

See Also:

  • Method Details

    • tapeARN

      public final String tapeARN()

      The Amazon Resource Name (ARN) of the virtual tape.

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

    • tapeBarcode

      public final String tapeBarcode()

      The barcode that identifies a specific virtual tape.

      Returns:
      The barcode that identifies a specific 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 virtual tape capacity.

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

    • tapeStatus

      public final String tapeStatus()

      The current state of the virtual tape.

      Returns:
      The current state of the virtual tape.

    • vtlDevice

      public final String vtlDevice()

      The virtual tape library (VTL) device that the virtual tape is associated with.

      Returns:
      The virtual tape library (VTL) device that the virtual tape is associated with.

    • progress

      public final Double progress()

      For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

      Range: 0 (not started) to 100 (complete).

      Returns:
      For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.

      Range: 0 (not started) to 100 (complete).

    • 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 contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

      Returns:
      The ID of the pool that contains tapes that will be archived. The tapes in this pool are archived in the S3 storage class that is associated with the pool. When you use your backup application to eject the tape, the tape is archived directly into the storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.

    • worm

      public final Boolean worm()

      If the tape is archived as write-once-read-many (WORM), this value is true.

      Returns:
      If the tape is archived as write-once-read-many (WORM), this value is true.

    • retentionStartDate

      public final Instant retentionStartDate()

      The date that the tape is first archived with tape retention lock enabled.

      Returns:
      The date that the tape is first archived with tape retention lock enabled.

    • poolEntryDate

      public final Instant poolEntryDate()

      The date that the tape enters a custom tape pool.

      Returns:
      The date that the tape enters a custom tape pool.

    • toBuilder

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

    • builder

      public static Tape.Builder builder()

    • serializableBuilderClass

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