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

Class DescribeStorediScsiVolumesResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

software.amazon.awssdk.services.storagegateway.model.DescribeStorediScsiVolumesResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeStorediScsiVolumesResponse.Builder,DescribeStorediScsiVolumesResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeStorediScsiVolumesResponse
extends StorageGatewayResponse
implements ToCopyableBuilder<DescribeStorediScsiVolumesResponse.Builder,DescribeStorediScsiVolumesResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeStorediScsiVolumesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeStorediScsiVolumesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStorediSCSIVolumes()	For responses, this returns true if the service returned a value for the StorediSCSIVolumes property.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeStorediScsiVolumesResponse.Builder>	serializableBuilderClass()
List<StorediSCSIVolume>	storediSCSIVolumes()	Describes a single unit of output from DescribeStorediSCSIVolumes.
DescribeStorediScsiVolumesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.storagegateway.model.StorageGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasStorediSCSIVolumes

public final boolean hasStorediSCSIVolumes()

For responses, this returns true if the service returned a value for the StorediSCSIVolumes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

storediSCSIVolumes

public final List<StorediSCSIVolume> storediSCSIVolumes()

Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

• ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

• LunNumber: The logical disk number.

• NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

• NetworkInterfacePort: The port used to communicate with iSCSI targets.

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

• SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

• StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

• TargetARN: The Amazon Resource Name (ARN) of the volume target.

• VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

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

• VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

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

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

• VolumeSizeInBytes: The size of the volume in bytes.

• VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

• VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStorediSCSIVolumes() method.

Returns:

Describes a single unit of output from DescribeStorediSCSIVolumes. The following fields are returned:

• ChapEnabled: Indicates whether mutual CHAP is enabled for the iSCSI target.

• LunNumber: The logical disk number.

• NetworkInterfaceId: The network interface ID of the stored volume that initiator use to map the stored volume as an iSCSI target.

• NetworkInterfacePort: The port used to communicate with iSCSI targets.

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

• SourceSnapshotId: If the stored volume was created from a snapshot, this field contains the snapshot ID used, e.g. snap-1122aabb. Otherwise, this field is not included.

• StorediSCSIVolumes: An array of StorediSCSIVolume objects where each object contains metadata about one stored volume.

• TargetARN: The Amazon Resource Name (ARN) of the volume target.

• VolumeARN: The Amazon Resource Name (ARN) of the stored volume.

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

• VolumeId: The unique identifier of the storage volume, e.g. vol-1122AABB.

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

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

• VolumeSizeInBytes: The size of the volume in bytes.

• VolumeStatus: One of the VolumeStatus values that indicates the state of the volume.

• VolumeType: One of the enumeration values describing the type of the volume. Currently, only STORED volumes are supported.

toBuilder

public DescribeStorediScsiVolumesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeStorediScsiVolumesResponse.Builder,DescribeStorediScsiVolumesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeStorediScsiVolumesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeStorediScsiVolumesResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo