software.amazon.awssdk.services.storagegateway.model

Interface Tape.Builder

All Superinterfaces:

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

Enclosing class:

Tape

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

Method Summary

Modifier and Type	Method and Description
Tape.Builder	kmsKey(String kmsKey) Sets the value of the KMSKey property for this object.
Tape.Builder	poolEntryDate(Instant poolEntryDate) The date that the tape enters a custom tape pool.
Tape.Builder	poolId(String poolId) The ID of the pool that contains tapes that will be archived.
Tape.Builder	progress(Double progress) For archiving virtual tapes, indicates how much data remains to be uploaded before archiving is complete.
Tape.Builder	retentionStartDate(Instant retentionStartDate) The date that the tape is first archived with tape retention lock enabled.
Tape.Builder	tapeARN(String tapeARN) The Amazon Resource Name (ARN) of the virtual tape.
Tape.Builder	tapeBarcode(String tapeBarcode) The barcode that identifies a specific virtual tape.
Tape.Builder	tapeCreatedDate(Instant tapeCreatedDate) The date the virtual tape was created.
Tape.Builder	tapeSizeInBytes(Long tapeSizeInBytes) The size, in bytes, of the virtual tape capacity.
Tape.Builder	tapeStatus(String tapeStatus) The current state of the virtual tape.
Tape.Builder	tapeUsedInBytes(Long tapeUsedInBytes) The size, in bytes, of data stored on the virtual tape.
Tape.Builder	vtlDevice(String vtlDevice) The virtual tape library (VTL) device that the virtual tape is associated with.
Tape.Builder	worm(Boolean worm) If the tape is archived as write-once-read-many (WORM), this value is true.

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

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

tapeBarcode

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

tapeCreatedDate

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

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

tapeStatus

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

vtlDevice

Tape.Builder vtlDevice(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.

progress

Tape.Builder progress(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.

tapeUsedInBytes

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

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

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

worm

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

retentionStartDate

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

poolEntryDate

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