Tape (AWS Java SDK :: Services :: AWS Storage Gateway 2.17.46 API)

java.lang.Object
- software.amazon.awssdk.services.storagegateway.model.Tape

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Tape.Builder,Tape>

@Generated(value="software.amazon.awssdk:codegen")
public final class Tape
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Tape.Builder,Tape>

Describes a virtual tape object.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Tape.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Tape.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Tape.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`kmsKey()` Returns the value of the KMSKey property for this object.
`Instant`	`poolEntryDate()` The date that the tape enters a custom tape pool.
`String`	`poolId()` The ID of the pool that contains tapes that will be archived.
`Double`	`progress()` For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
`Instant`	`retentionStartDate()` The date that the tape is first archived with tape retention lock enabled.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Tape.Builder>`	`serializableBuilderClass()`
`String`	`tapeARN()` The Amazon Resource Name (ARN) of the virtual tape.
`String`	`tapeBarcode()` The barcode that identifies a specific virtual tape.
`Instant`	`tapeCreatedDate()` The date the virtual tape was created.
`Long`	`tapeSizeInBytes()` The size, in bytes, of the virtual tape capacity.
`String`	`tapeStatus()` The current state of the virtual tape.
`Long`	`tapeUsedInBytes()` The size, in bytes, of data stored on the virtual tape.
`Tape.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`vtlDevice()` The virtual tape library (VTL) device that the virtual tape is associated with.
`Boolean`	`worm()` If the tape is archived as write-once-read-many (WORM), this value is `true`.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
    
    Valid Values: GLACIER | DEEP_ARCHIVE
    
    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.
    
    Valid Values: GLACIER | DEEP_ARCHIVE
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Tape.Builder,Tape>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Tape

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

tapeARN

tapeBarcode

tapeCreatedDate

tapeSizeInBytes

tapeStatus

vtlDevice

progress

tapeUsedInBytes

kmsKey

poolId

worm

retentionStartDate

poolEntryDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields