software.amazon.awssdk.services.storagegateway.model

Interface TapeArchive.Builder

All Superinterfaces:

Buildable, CopyableBuilder<TapeArchive.Builder,TapeArchive>, SdkBuilder<TapeArchive.Builder,TapeArchive>, SdkPojo

Enclosing class:

TapeArchive

public static interface TapeArchive.Builder
extends SdkPojo, CopyableBuilder<TapeArchive.Builder,TapeArchive>

Method Summary

Modifier and Type	Method and Description
TapeArchive.Builder	completionTime(Instant completionTime) The time that the archiving of the virtual tape was completed.
TapeArchive.Builder	kmsKey(String kmsKey) Sets the value of the KMSKey property for this object.
TapeArchive.Builder	poolEntryDate(Instant poolEntryDate) The time that the tape entered the custom tape pool.
TapeArchive.Builder	poolId(String poolId) The ID of the pool that was used to archive the tape.
TapeArchive.Builder	retentionStartDate(Instant retentionStartDate) If the archived tape is subject to tape retention lock, the date that the archived tape started being retained.
TapeArchive.Builder	retrievedTo(String retrievedTo) The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being retrieved to.
TapeArchive.Builder	tapeARN(String tapeARN) The Amazon Resource Name (ARN) of an archived virtual tape.
TapeArchive.Builder	tapeBarcode(String tapeBarcode) The barcode that identifies the archived virtual tape.
TapeArchive.Builder	tapeCreatedDate(Instant tapeCreatedDate) The date the virtual tape was created.
TapeArchive.Builder	tapeSizeInBytes(Long tapeSizeInBytes) The size, in bytes, of the archived virtual tape.
TapeArchive.Builder	tapeStatus(String tapeStatus) The current state of the archived virtual tape.
TapeArchive.Builder	tapeUsedInBytes(Long tapeUsedInBytes) The size, in bytes, of data stored on the virtual tape.
TapeArchive.Builder	worm(Boolean worm) Set to true if the archived tape is stored as write-once-read-many (WORM).

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

tapeARN

TapeArchive.Builder tapeARN(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.

tapeBarcode

TapeArchive.Builder tapeBarcode(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.

tapeCreatedDate

TapeArchive.Builder tapeCreatedDate(Instant 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.

tapeSizeInBytes

TapeArchive.Builder tapeSizeInBytes(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.

completionTime

TapeArchive.Builder completionTime(Instant 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.

retrievedTo

TapeArchive.Builder retrievedTo(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.

tapeStatus

TapeArchive.Builder tapeStatus(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.

tapeUsedInBytes

TapeArchive.Builder tapeUsedInBytes(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.

kmsKey

TapeArchive.Builder kmsKey(String kmsKey)

Sets the value of the KMSKey property for this object.

Parameters:

kmsKey - The new value for the KMSKey property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

poolId

TapeArchive.Builder poolId(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.

Valid Values: GLACIER | DEEP_ARCHIVE

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.

Valid Values: GLACIER | DEEP_ARCHIVE

Returns:

Returns a reference to this object so that method calls can be chained together.

worm

TapeArchive.Builder worm(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.

retentionStartDate

TapeArchive.Builder retentionStartDate(Instant 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.

poolEntryDate

TapeArchive.Builder poolEntryDate(Instant 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.