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>

  • Method Details

    • 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()
      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<DescribeStorediScsiVolumesResponse.Builder,DescribeStorediScsiVolumesResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.