StorediSCSIVolume (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.storagegateway.model.StorediSCSIVolume

All Implemented Interfaces:: StructuredPojo, ToCopyableBuilder<StorediSCSIVolume.Builder,StorediSCSIVolume>

@Generated(value="software.amazon.awssdk:codegen")
public final class StorediSCSIVolume
extends Object
implements StructuredPojo, ToCopyableBuilder<StorediSCSIVolume.Builder,StorediSCSIVolume>

Describes an iSCSI stored volume.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StorediSCSIVolume.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StorediSCSIVolume.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StorediSCSIVolume.Builder`	`builder()`
`Instant`	`createdDate()` The date the volume was created.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`Boolean`	`preservedExistingData()` Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
`static Class<? extends StorediSCSIVolume.Builder>`	`serializableBuilderClass()`
`String`	`sourceSnapshotId()` If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g.
`StorediSCSIVolume.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`volumeARN()` The Amazon Resource Name (ARN) of the storage volume.
`String`	`volumeDiskId()` The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
`String`	`volumeId()` The unique identifier of the volume, e.g.
`VolumeiSCSIAttributes`	`volumeiSCSIAttributes()` An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
`Double`	`volumeProgress()` Represents the percentage complete if the volume is restoring or bootstrapping that represents the percent of data transferred.
`Long`	`volumeSizeInBytes()` The size of the volume in bytes.
`String`	`volumeStatus()` One of the VolumeStatus values that indicates the state of the storage volume.
`String`	`volumeType()` One of the VolumeType enumeration values describing the type of the volume.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - volumeARN
```
public String volumeARN()
```
    The Amazon Resource Name (ARN) of the storage volume.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the storage volume.
  - volumeId
```
public String volumeId()
```
    The unique identifier of the volume, e.g. vol-AE4B946D.
    
    Returns:
    
    The unique identifier of the volume, e.g. vol-AE4B946D.
  - volumeType
```
public String volumeType()
```
    One of the VolumeType enumeration values describing the type of the volume.
    
    Returns:
    
    One of the VolumeType enumeration values describing the type of the volume.
  - volumeStatus
```
public String volumeStatus()
```
    One of the VolumeStatus values that indicates the state of the storage volume.
    
    Returns:
    
    One of the VolumeStatus values that indicates the state of the storage volume.
  - volumeSizeInBytes
```
public Long volumeSizeInBytes()
```
    The size of the volume in bytes.
    
    Returns:
    
    The size of the volume in bytes.
  - volumeProgress
```
public 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.
    
    Returns:
    
    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.
  - volumeDiskId
```
public String volumeDiskId()
```
    The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
    
    Returns:
    
    The ID of the local disk that was specified in the CreateStorediSCSIVolume operation.
  - sourceSnapshotId
```
public 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.
    
    Returns:
    
    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.
  - preservedExistingData
```
public Boolean preservedExistingData()
```
    Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
    
    Valid Values: true, false
    
    Returns:
    
    Indicates if when the stored volume was created, existing data on the underlying local disk was preserved.
    
    Valid Values: true, false
  - volumeiSCSIAttributes
```
public VolumeiSCSIAttributes volumeiSCSIAttributes()
```
    An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
    
    Returns:
    
    An VolumeiSCSIAttributes object that represents a collection of iSCSI attributes for one stored volume.
  - createdDate
```
public Instant createdDate()
```
    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
    
    Returns:
    
    The date the volume was created. Volumes created prior to March 28, 2017 don’t have this time stamp.
  - toBuilder
```
public StorediSCSIVolume.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StorediSCSIVolume.Builder,StorediSCSIVolume>
    
    Returns:
    
    a builder for type T
  - builder
```
public static StorediSCSIVolume.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StorediSCSIVolume.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - 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.

Class StorediSCSIVolume

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

volumeARN

volumeId

volumeType

volumeStatus

volumeSizeInBytes

volumeProgress

volumeDiskId

sourceSnapshotId

preservedExistingData

volumeiSCSIAttributes

createdDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

marshall