Package software.amazon.awssdk.services.storagegateway.model

Interface CachediSCSIVolume.Builder

All Superinterfaces:
Buildable, CopyableBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>, SdkBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>, SdkPojo
Enclosing class:
CachediSCSIVolume
public static interface CachediSCSIVolume.Builder extends SdkPojo, CopyableBuilder<CachediSCSIVolume.Builder,CachediSCSIVolume>

  • Method Details

    • volumeARN

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

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

      CachediSCSIVolume.Builder volumeType(String volumeType)

      One of the VolumeType enumeration values that describes the type of the volume.

      Parameters:
      volumeType - One of the VolumeType enumeration values that describes the type of the volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeStatus

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

      CachediSCSIVolume.Builder volumeAttachmentStatus(String volumeAttachmentStatus)

      A value that indicates whether a storage volume is attached to or detached 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 or detached 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

      CachediSCSIVolume.Builder volumeSizeInBytes(Long volumeSizeInBytes)

      The size, in bytes, of the volume capacity.

      Parameters:
      volumeSizeInBytes - The size, in bytes, of the volume capacity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeProgress

      CachediSCSIVolume.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 cached 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 cached volume is not restoring or bootstrapping.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceSnapshotId

      CachediSCSIVolume.Builder sourceSnapshotId(String sourceSnapshotId)

      If the cached 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 cached 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.

    • volumeiSCSIAttributes

      CachediSCSIVolume.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 CachediSCSIVolume.Builder volumeiSCSIAttributes(Consumer<VolumeiSCSIAttributes.Builder> volumeiSCSIAttributes)

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

      This is a convenience method 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:

    • createdDate

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

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

      If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.

      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.

      If you use a delete tool that overwrites the data on your volume with random data, your usage will not be reduced. This is because the random data is not compressible. If you want to reduce the amount of billed storage on your volume, we recommend overwriting your files with zeros to compress the data to a negligible amount of actual storage.

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

    • kmsKey

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

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