software.amazon.awssdk.services.storagegateway.model

Interface StorediSCSIVolume.Builder

All Superinterfaces:

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

Enclosing class:

StorediSCSIVolume

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

Method Summary

Modifier and Type	Method and Description
StorediSCSIVolume.Builder	createdDate(Instant createdDate) The date the volume was created.
StorediSCSIVolume.Builder	kmsKey(String kmsKey) Sets the value of the KMSKey property for this object.
StorediSCSIVolume.Builder	preservedExistingData(Boolean preservedExistingData) Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
StorediSCSIVolume.Builder	sourceSnapshotId(String sourceSnapshotId) If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.
StorediSCSIVolume.Builder	targetName(String targetName) The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN.
StorediSCSIVolume.Builder	volumeARN(String volumeARN) The Amazon Resource Name (ARN) of the storage volume.
StorediSCSIVolume.Builder	volumeAttachmentStatus(String volumeAttachmentStatus) A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway.
StorediSCSIVolume.Builder	volumeDiskId(String volumeDiskId) The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
StorediSCSIVolume.Builder	volumeId(String volumeId) The unique identifier of the volume, e.g., vol-AE4B946D.
default StorediSCSIVolume.Builder	volumeiSCSIAttributes(Consumer<VolumeiSCSIAttributes.Builder> volumeiSCSIAttributes) An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
StorediSCSIVolume.Builder	volumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes) An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
StorediSCSIVolume.Builder	volumeProgress(Double volumeProgress) Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred.
StorediSCSIVolume.Builder	volumeSizeInBytes(Long volumeSizeInBytes) The size of the volume in bytes.
StorediSCSIVolume.Builder	volumeStatus(String volumeStatus) One of the VolumeStatus values that indicates the state of the storage volume.
StorediSCSIVolume.Builder	volumeType(String volumeType) One of the VolumeType enumeration values describing the type of the volume.
StorediSCSIVolume.Builder	volumeUsedInBytes(Long volumeUsedInBytes) The size of the data stored on the volume in bytes.

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

volumeARN

StorediSCSIVolume.Builder volumeARN(String volumeARN)

The Amazon Resource Name (ARN) of the storage volume.

Parameters:

volumeARN - The Amazon Resource Name (ARN) of the storage volume.

Returns:

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

volumeId

StorediSCSIVolume.Builder volumeId(String volumeId)

The unique identifier of the volume, e.g., vol-AE4B946D.

Parameters:

volumeId - The unique identifier of the volume, e.g., vol-AE4B946D.

Returns:

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

volumeType

StorediSCSIVolume.Builder volumeType(String volumeType)

One of the VolumeType enumeration values describing the type of the volume.

Parameters:

volumeType - One of the VolumeType enumeration values describing the type of the volume.

Returns:

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

volumeStatus

StorediSCSIVolume.Builder volumeStatus(String volumeStatus)

One of the VolumeStatus values that indicates the state of the storage volume.

Parameters:

volumeStatus - One of the VolumeStatus values that indicates the state of the storage volume.

Returns:

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

volumeAttachmentStatus

StorediSCSIVolume.Builder volumeAttachmentStatus(String volumeAttachmentStatus)

A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Parameters:

volumeAttachmentStatus - A value that indicates whether a storage volume is attached to, detached from, or is in the process of detaching from a gateway. For more information, see Moving your volumes to a different gateway.

Returns:

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

volumeSizeInBytes

StorediSCSIVolume.Builder volumeSizeInBytes(Long volumeSizeInBytes)

The size of the volume in bytes.

Parameters:

volumeSizeInBytes - The size of the volume in bytes.

Returns:

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

volumeProgress

StorediSCSIVolume.Builder volumeProgress(Double volumeProgress)

Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

Parameters:

volumeProgress - Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred. This field does not appear in the response if the stored volume is not restoring or bootstrapping.

Returns:

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

volumeDiskId

StorediSCSIVolume.Builder volumeDiskId(String volumeDiskId)

The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Parameters:

volumeDiskId - The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.

Returns:

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

sourceSnapshotId

StorediSCSIVolume.Builder sourceSnapshotId(String sourceSnapshotId)

If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Parameters:

sourceSnapshotId - If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not included.

Returns:

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

preservedExistingData

StorediSCSIVolume.Builder preservedExistingData(Boolean preservedExistingData)

Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

Parameters:

preservedExistingData - Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.

Valid Values: true | false

Returns:

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

volumeiSCSIAttributes

StorediSCSIVolume.Builder volumeiSCSIAttributes(VolumeiSCSIAttributes volumeiSCSIAttributes)

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Parameters:

volumeiSCSIAttributes - An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

Returns:

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

volumeiSCSIAttributes

default StorediSCSIVolume.Builder volumeiSCSIAttributes(Consumer<VolumeiSCSIAttributes.Builder> volumeiSCSIAttributes)

An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.

This is a convenience that creates an instance of the VolumeiSCSIAttributes.Builder avoiding the need to create one manually via VolumeiSCSIAttributes.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volumeiSCSIAttributes(VolumeiSCSIAttributes).

Parameters:

volumeiSCSIAttributes - a consumer that will call methods on VolumeiSCSIAttributes.Builder

Returns:

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

See Also:

volumeiSCSIAttributes(VolumeiSCSIAttributes)

createdDate

StorediSCSIVolume.Builder createdDate(Instant createdDate)

The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Parameters:

createdDate - The date the volume was created. Volumes created prior to March 28, 2017 don’t have this timestamp.

Returns:

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

volumeUsedInBytes

StorediSCSIVolume.Builder volumeUsedInBytes(Long volumeUsedInBytes)

The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

Parameters:

volumeUsedInBytes - The size of the data stored on the volume in bytes. This value is calculated based on the number of blocks that are touched, instead of the actual amount of data written. This value can be useful for sequential write patterns but less accurate for random write patterns. VolumeUsedInBytes is different from the compressed size of the volume, which is the value that is used to calculate your bill.

This value is not available for volumes created prior to May 13, 2015, until you store data on the volume.

Returns:

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

kmsKey

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

targetName

StorediSCSIVolume.Builder targetName(String targetName)

The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Parameters:

targetName - The name of the iSCSI target used by an initiator to connect to a volume and used as a suffix for the target ARN. For example, specifying TargetName as myvolume results in the target ARN of arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume . The target name must be unique across all volumes on a gateway.

If you don't specify a value, Storage Gateway uses the value that was previously used for this volume as the new target name.

Returns:

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