TapeArchive (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TapeArchive
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Represents a virtual tape that is archived in the virtual tape shelf (VTS).

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TapeArchive()

Constructors
Constructor and Description
`TapeArchive()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TapeArchive`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCompletionTime()` The time that the archiving of the virtual tape was completed.
`String`	`getKMSKey()`
`Date`	`getPoolEntryDate()` The time that the tape entered the custom tape pool.
`String`	`getPoolId()` The ID of the pool that was used to archive the tape.
`Date`	`getRetentionStartDate()` If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
`String`	`getRetrievedTo()` The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
`String`	`getTapeARN()` The Amazon Resource Name (ARN) of an archived virtual tape.
`String`	`getTapeBarcode()` The barcode that identifies the archived virtual tape.
`Date`	`getTapeCreatedDate()` The date the virtual tape was created.
`Long`	`getTapeSizeInBytes()` The size, in bytes, of the archived virtual tape.
`String`	`getTapeStatus()` The current state of the archived virtual tape.
`Long`	`getTapeUsedInBytes()` The size, in bytes, of data stored on the virtual tape.
`Boolean`	`getWorm()` Set to `true` if the archived tape is stored as write-once-read-many (WORM).
`int`	`hashCode()`
`Boolean`	`isWorm()` Set to `true` if the archived tape is stored as write-once-read-many (WORM).
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCompletionTime(Date completionTime)` The time that the archiving of the virtual tape was completed.
`void`	`setKMSKey(String kMSKey)`
`void`	`setPoolEntryDate(Date poolEntryDate)` The time that the tape entered the custom tape pool.
`void`	`setPoolId(String poolId)` The ID of the pool that was used to archive the tape.
`void`	`setRetentionStartDate(Date retentionStartDate)` If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
`void`	`setRetrievedTo(String retrievedTo)` The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
`void`	`setTapeARN(String tapeARN)` The Amazon Resource Name (ARN) of an archived virtual tape.
`void`	`setTapeBarcode(String tapeBarcode)` The barcode that identifies the archived virtual tape.
`void`	`setTapeCreatedDate(Date tapeCreatedDate)` The date the virtual tape was created.
`void`	`setTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the archived virtual tape.
`void`	`setTapeStatus(String tapeStatus)` The current state of the archived virtual tape.
`void`	`setTapeUsedInBytes(Long tapeUsedInBytes)` The size, in bytes, of data stored on the virtual tape.
`void`	`setWorm(Boolean worm)` Set to `true` if the archived tape is stored as write-once-read-many (WORM).
`String`	`toString()` Returns a string representation of this object.
`TapeArchive`	`withCompletionTime(Date completionTime)` The time that the archiving of the virtual tape was completed.
`TapeArchive`	`withKMSKey(String kMSKey)`
`TapeArchive`	`withPoolEntryDate(Date poolEntryDate)` The time that the tape entered the custom tape pool.
`TapeArchive`	`withPoolId(String poolId)` The ID of the pool that was used to archive the tape.
`TapeArchive`	`withRetentionStartDate(Date retentionStartDate)` If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
`TapeArchive`	`withRetrievedTo(String retrievedTo)` The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
`TapeArchive`	`withTapeARN(String tapeARN)` The Amazon Resource Name (ARN) of an archived virtual tape.
`TapeArchive`	`withTapeBarcode(String tapeBarcode)` The barcode that identifies the archived virtual tape.
`TapeArchive`	`withTapeCreatedDate(Date tapeCreatedDate)` The date the virtual tape was created.
`TapeArchive`	`withTapeSizeInBytes(Long tapeSizeInBytes)` The size, in bytes, of the archived virtual tape.
`TapeArchive`	`withTapeStatus(String tapeStatus)` The current state of the archived virtual tape.
`TapeArchive`	`withTapeUsedInBytes(Long tapeUsedInBytes)` The size, in bytes, of data stored on the virtual tape.
`TapeArchive`	`withWorm(Boolean worm)` Set to `true` if the archived tape is stored as write-once-read-many (WORM).

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

- Constructor Detail
  - TapeArchive
```
public TapeArchive()
```
- Method Detail
  - setTapeARN
```
public void setTapeARN(String tapeARN)
```
    The Amazon Resource Name (ARN) of an archived virtual tape.
    
    Parameters:
    
    tapeARN - The Amazon Resource Name (ARN) of an archived virtual tape.
  - getTapeARN
```
public String getTapeARN()
```
    The Amazon Resource Name (ARN) of an archived virtual tape.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an archived virtual tape.
  - withTapeARN
```
public TapeArchive withTapeARN(String tapeARN)
```
    The Amazon Resource Name (ARN) of an archived virtual tape.
    
    Parameters:
    
    tapeARN - The Amazon Resource Name (ARN) of an archived 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 the archived virtual tape.
    
    Parameters:
    
    tapeBarcode - The barcode that identifies the archived virtual tape.
  - getTapeBarcode
```
public String getTapeBarcode()
```
    The barcode that identifies the archived virtual tape.
    
    Returns:
    
    The barcode that identifies the archived virtual tape.
  - withTapeBarcode
```
public TapeArchive withTapeBarcode(String tapeBarcode)
```
    The barcode that identifies the archived virtual tape.
    
    Parameters:
    
    tapeBarcode - The barcode that identifies the archived 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 TapeArchive 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 archived virtual tape.
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the archived virtual tape.
  - getTapeSizeInBytes
```
public Long getTapeSizeInBytes()
```
    The size, in bytes, of the archived virtual tape.
    
    Returns:
    
    The size, in bytes, of the archived virtual tape.
  - withTapeSizeInBytes
```
public TapeArchive withTapeSizeInBytes(Long tapeSizeInBytes)
```
    The size, in bytes, of the archived virtual tape.
    
    Parameters:
    
    tapeSizeInBytes - The size, in bytes, of the archived virtual tape.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionTime
```
public void setCompletionTime(Date 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.
    
    Parameters:
    
    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.
  - getCompletionTime
```
public Date getCompletionTime()
```
    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.
  - withCompletionTime
```
public TapeArchive withCompletionTime(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRetrievedTo
```
public void setRetrievedTo(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).
    
    Parameters:
    
    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).
  - getRetrievedTo
```
public String getRetrievedTo()
```
    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).
  - withRetrievedTo
```
public TapeArchive withRetrievedTo(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).
    
    Parameters:
    
    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:
    
    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 archived virtual tape.
    
    Parameters:
    
    tapeStatus - The current state of the archived virtual tape.
  - getTapeStatus
```
public String getTapeStatus()
```
    The current state of the archived virtual tape.
    
    Returns:
    
    The current state of the archived virtual tape.
  - withTapeStatus
```
public TapeArchive withTapeStatus(String tapeStatus)
```
    The current state of the archived virtual tape.
    
    Parameters:
    
    tapeStatus - The current state of the archived virtual tape.
    
    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 TapeArchive 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 TapeArchive 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 was used to archive the tape. The tapes in this pool are archived in the S3 storage class that is associated with the pool.
    
    Parameters:
    
    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.
  - getPoolId
```
public String getPoolId()
```
    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.
  - withPoolId
```
public TapeArchive withPoolId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorm
```
public void setWorm(Boolean worm)
```
    Set to true if the archived tape is stored as write-once-read-many (WORM).
    
    Parameters:
    
    worm - Set to true if the archived tape is stored as write-once-read-many (WORM).
  - getWorm
```
public Boolean getWorm()
```
    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).
  - withWorm
```
public TapeArchive withWorm(Boolean worm)
```
    Set to true if the archived tape is stored as write-once-read-many (WORM).
    
    Parameters:
    
    worm - Set to true if the archived tape is stored as write-once-read-many (WORM).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isWorm
```
public Boolean isWorm()
```
    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).
  - setRetentionStartDate
```
public void setRetentionStartDate(Date retentionStartDate)
```
    If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
    
    Parameters:
    
    retentionStartDate - If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
  - getRetentionStartDate
```
public Date getRetentionStartDate()
```
    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.
  - withRetentionStartDate
```
public TapeArchive withRetentionStartDate(Date retentionStartDate)
```
    If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
    
    Parameters:
    
    retentionStartDate - If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPoolEntryDate
```
public void setPoolEntryDate(Date 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.
    
    Parameters:
    
    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.
  - getPoolEntryDate
```
public Date getPoolEntryDate()
```
    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.
  - withPoolEntryDate
```
public TapeArchive withPoolEntryDate(Date 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.
    
    Parameters:
    
    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:
    
    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 TapeArchive 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.772

Class TapeArchive

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TapeArchive

Method Detail

setTapeARN

getTapeARN

withTapeARN

setTapeBarcode

getTapeBarcode

withTapeBarcode

setTapeCreatedDate

getTapeCreatedDate

withTapeCreatedDate

setTapeSizeInBytes

getTapeSizeInBytes

withTapeSizeInBytes

setCompletionTime

getCompletionTime

withCompletionTime

setRetrievedTo

getRetrievedTo

withRetrievedTo

setTapeStatus

getTapeStatus

withTapeStatus

setTapeUsedInBytes

getTapeUsedInBytes

withTapeUsedInBytes

setKMSKey

getKMSKey

withKMSKey

setPoolId

getPoolId

withPoolId

setWorm

getWorm

withWorm

isWorm

setRetentionStartDate

getRetentionStartDate

withRetentionStartDate

setPoolEntryDate

getPoolEntryDate

withPoolEntryDate

toString

equals

hashCode

clone

marshall