Tape (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.storagegateway.model.Tape

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Tape
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a virtual tape object.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Tape()

Constructors
Constructor and Description
`Tape()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Tape`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getKMSKey()`
`Date`	`getPoolEntryDate()` The date that the tape enters a custom tape pool.
`String`	`getPoolId()` The ID of the pool that contains tapes that will be archived.
`Double`	`getProgress()` For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
`Date`	`getRetentionStartDate()` The date that the tape is first archived with tape retention lock enabled.
`String`	`getTapeARN()` The Amazon Resource Name (ARN) of the virtual tape.
`String`	`getTapeBarcode()` The barcode that identifies a specific virtual tape.
`Date`	`getTapeCreatedDate()` The date the virtual tape was created.
`Long`	`getTapeSizeInBytes()` The size, in bytes, of the virtual tape capacity.
`String`	`getTapeStatus()` The current state of the virtual tape.
`Long`	`getTapeUsedInBytes()` The size, in bytes, of data stored on the virtual tape.
`String`	`getVTLDevice()` The virtual tape library (VTL) device that the virtual tape is associated with.
`Boolean`	`getWorm()` If the tape is archived as write-once-read-many (WORM), this value is `true`.
`int`	`hashCode()`
`Boolean`	`isWorm()` If the tape is archived as write-once-read-many (WORM), this value is `true`.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setKMSKey(String kMSKey)`
`void`	`setPoolEntryDate(Date poolEntryDate)` The date that the tape enters a custom tape pool.
`void`	`setPoolId(String poolId)` The ID of the pool that contains tapes that will be archived.
`void`	`setProgress(Double progress)` For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
`void`	`setRetentionStartDate(Date retentionStartDate)` The date that the tape is first archived with tape retention lock enabled.
`void`	`setTapeARN(String tapeARN)` The Amazon Resource Name (ARN) of the virtual tape.
`void`	`setTapeBarcode(String tapeBarcode)` The barcode that identifies a specific virtual tape.
`void`	`setTapeCreatedDate(Date tapeCreatedDate)` The date the virtual tape was created.
`void`	`setTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the virtual tape capacity.
`void`	`setTapeStatus(String tapeStatus)` The current state of the virtual tape.
`void`	`setTapeUsedInBytes(Long tapeUsedInBytes)` The size, in bytes, of data stored on the virtual tape.
`void`	`setVTLDevice(String vTLDevice)` The virtual tape library (VTL) device that the virtual tape is associated with.
`void`	`setWorm(Boolean worm)` If the tape is archived as write-once-read-many (WORM), this value is `true`.
`String`	`toString()` Returns a string representation of this object.
`Tape`	`withKMSKey(String kMSKey)`
`Tape`	`withPoolEntryDate(Date poolEntryDate)` The date that the tape enters a custom tape pool.
`Tape`	`withPoolId(String poolId)` The ID of the pool that contains tapes that will be archived.
`Tape`	`withProgress(Double progress)` For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
`Tape`	`withRetentionStartDate(Date retentionStartDate)` The date that the tape is first archived with tape retention lock enabled.
`Tape`	`withTapeARN(String tapeARN)` The Amazon Resource Name (ARN) of the virtual tape.
`Tape`	`withTapeBarcode(String tapeBarcode)` The barcode that identifies a specific virtual tape.
`Tape`	`withTapeCreatedDate(Date tapeCreatedDate)` The date the virtual tape was created.
`Tape`	`withTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the virtual tape capacity.
`Tape`	`withTapeStatus(String tapeStatus)` The current state of the virtual tape.
`Tape`	`withTapeUsedInBytes(Long tapeUsedInBytes)` The size, in bytes, of data stored on the virtual tape.
`Tape`	`withVTLDevice(String vTLDevice)` The virtual tape library (VTL) device that the virtual tape is associated with.
`Tape`	`withWorm(Boolean worm)` If the tape is archived as write-once-read-many (WORM), this value is `true`.

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

- Constructor Detail
  - Tape
```
public Tape()
```
- Method Detail
  - setTapeARN
```
public void setTapeARN(String tapeARN)
```
    The Amazon Resource Name (ARN) of the virtual tape.
    
    Parameters:
    
    tapeARN - The Amazon Resource Name (ARN) of the virtual tape.
  - getTapeARN
```
public String getTapeARN()
```
    The Amazon Resource Name (ARN) of the virtual tape.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the virtual tape.
  - withTapeARN
```
public Tape withTapeARN(String tapeARN)
```
    The Amazon Resource Name (ARN) of the virtual tape.
    
    Parameters:
    
    tapeARN - The Amazon Resource Name (ARN) of the virtual tape.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTapeBarcode
```
public void setTapeBarcode(String tapeBarcode)
```
    The barcode that identifies a specific virtual tape.
    
    Parameters:
    
    tapeBarcode - The barcode that identifies a specific virtual tape.
  - getTapeBarcode
```
public String getTapeBarcode()
```
    The barcode that identifies a specific virtual tape.
    
    Returns:
    
    The barcode that identifies a specific virtual tape.
  - withTapeBarcode
```
public Tape withTapeBarcode(String tapeBarcode)
```
    The barcode that identifies a specific virtual tape.
    
    Parameters:
    
    tapeBarcode - The barcode that identifies a specific virtual tape.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTapeCreatedDate
```
public void setTapeCreatedDate(Date tapeCreatedDate)
```
    The date the virtual tape was created.
    
    Parameters:
    
    tapeCreatedDate - The date the virtual tape was created.
  - getTapeCreatedDate
```
public Date getTapeCreatedDate()
```
    The date the virtual tape was created.
    
    Returns:
    
    The date the virtual tape was created.
  - withTapeCreatedDate
```
public Tape withTapeCreatedDate(Date tapeCreatedDate)
```
    The date the virtual tape was created.
    
    Parameters:
    
    tapeCreatedDate - The date the virtual tape was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTapeSizeInBytes
```
public void setTapeSizeInBytes(Long tapeSizeInBytes)
```
    The size, in bytes, of the virtual tape capacity.
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the virtual tape capacity.
  - getTapeSizeInBytes
```
public Long getTapeSizeInBytes()
```
    The size, in bytes, of the virtual tape capacity.
    
    Returns:
    
    The size, in bytes, of the virtual tape capacity.
  - withTapeSizeInBytes
```
public Tape withTapeSizeInBytes(Long tapeSizeInBytes)
```
    The size, in bytes, of the virtual tape capacity.
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the virtual tape capacity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTapeStatus
```
public void setTapeStatus(String tapeStatus)
```
    The current state of the virtual tape.
    
    Parameters:
    
    tapeStatus - The current state of the virtual tape.
  - getTapeStatus
```
public String getTapeStatus()
```
    The current state of the virtual tape.
    
    Returns:
    
    The current state of the virtual tape.
  - withTapeStatus
```
public Tape withTapeStatus(String tapeStatus)
```
    The current state of the virtual tape.
    
    Parameters:
    
    tapeStatus - The current state of the virtual tape.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVTLDevice
```
public void setVTLDevice(String vTLDevice)
```
    The virtual tape library (VTL) device that the virtual tape is associated with.
    
    Parameters:
    
    vTLDevice - The virtual tape library (VTL) device that the virtual tape is associated with.
  - getVTLDevice
```
public String getVTLDevice()
```
    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.
  - withVTLDevice
```
public Tape withVTLDevice(String vTLDevice)
```
    The virtual tape library (VTL) device that the virtual tape is associated with.
    
    Parameters:
    
    vTLDevice - The virtual tape library (VTL) device that the virtual tape is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProgress
```
public void setProgress(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).
    
    Parameters:
    
    progress - For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
    
    Range: 0 (not started) to 100 (complete).
  - getProgress
```
public Double getProgress()
```
    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).
  - withProgress
```
public Tape withProgress(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTapeUsedInBytes
```
public void setTapeUsedInBytes(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.
    
    Parameters:
    
    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.
  - getTapeUsedInBytes
```
public Long getTapeUsedInBytes()
```
    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.
  - withTapeUsedInBytes
```
public Tape withTapeUsedInBytes(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKMSKey
```
public void setKMSKey(String kMSKey)
```
    Parameters:
    
    kMSKey -
  - getKMSKey
```
public String getKMSKey()
```
    Returns:
  - withKMSKey
```
public Tape withKMSKey(String kMSKey)
```
    Parameters:
    
    kMSKey -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPoolId
```
public void setPoolId(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.
    
    Parameters:
    
    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.
  - getPoolId
```
public String getPoolId()
```
    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.
  - withPoolId
```
public Tape withPoolId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorm
```
public void setWorm(Boolean worm)
```
    If the tape is archived as write-once-read-many (WORM), this value is true.
    
    Parameters:
    
    worm - If the tape is archived as write-once-read-many (WORM), this value is true.
  - getWorm
```
public Boolean getWorm()
```
    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.
  - withWorm
```
public Tape withWorm(Boolean worm)
```
    If the tape is archived as write-once-read-many (WORM), this value is true.
    
    Parameters:
    
    worm - If the tape is archived as write-once-read-many (WORM), this value is true.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isWorm
```
public Boolean isWorm()
```
    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.
  - setRetentionStartDate
```
public void setRetentionStartDate(Date retentionStartDate)
```
    The date that the tape is first archived with tape retention lock enabled.
    
    Parameters:
    
    retentionStartDate - The date that the tape is first archived with tape retention lock enabled.
  - getRetentionStartDate
```
public Date getRetentionStartDate()
```
    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.
  - withRetentionStartDate
```
public Tape withRetentionStartDate(Date retentionStartDate)
```
    The date that the tape is first archived with tape retention lock enabled.
    
    Parameters:
    
    retentionStartDate - The date that the tape is first archived with tape retention lock enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPoolEntryDate
```
public void setPoolEntryDate(Date poolEntryDate)
```
    The date that the tape enters a custom tape pool.
    
    Parameters:
    
    poolEntryDate - The date that the tape enters a custom tape pool.
  - getPoolEntryDate
```
public Date getPoolEntryDate()
```
    The date that the tape enters a custom tape pool.
    
    Returns:
    
    The date that the tape enters a custom tape pool.
  - withPoolEntryDate
```
public Tape withPoolEntryDate(Date poolEntryDate)
```
    The date that the tape enters a custom tape pool.
    
    Parameters:
    
    poolEntryDate - The date that the tape enters a custom tape pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Tape clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class Tape

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tape

Method Detail

setTapeARN

getTapeARN

withTapeARN

setTapeBarcode

getTapeBarcode

withTapeBarcode

setTapeCreatedDate

getTapeCreatedDate

withTapeCreatedDate

setTapeSizeInBytes

getTapeSizeInBytes

withTapeSizeInBytes

setTapeStatus

getTapeStatus

withTapeStatus

setVTLDevice

getVTLDevice

withVTLDevice

setProgress

getProgress

withProgress

setTapeUsedInBytes

getTapeUsedInBytes

withTapeUsedInBytes

setKMSKey

getKMSKey

withKMSKey

setPoolId

getPoolId

withPoolId

setWorm

getWorm

withWorm

isWorm

setRetentionStartDate

getRetentionStartDate

withRetentionStartDate

setPoolEntryDate

getPoolEntryDate

withPoolEntryDate

toString

equals

hashCode

clone

marshall