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(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

Method Summary

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.
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.
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.

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 String tapeARN()

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

Returns:

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

tapeBarcode

public String tapeBarcode()

The barcode that identifies a specific virtual tape.

Returns:

The barcode that identifies a specific virtual tape.

tapeCreatedDate

public Instant tapeCreatedDate()

The date the virtual tape was created.

Returns:

The date the virtual tape was created.

tapeSizeInBytes

public Long tapeSizeInBytes()

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

Returns:

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

tapeStatus

public String tapeStatus()

The current state of the virtual tape.

Returns:

The current state of the virtual tape.

vtlDevice

public 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 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 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 String kmsKey()

Returns the value of the KMSKey property for this object.

Returns:

The value of the KMSKey property for this object.

poolId

public 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 (Glacier or 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 (Glacier or Deep Archive) that corresponds to the pool.

Valid values: "GLACIER", "DEEP_ARCHIVE"

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo