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

Class ListVolumesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListVolumesResponse.Builder,ListVolumesResponse>

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

A JSON object containing the following fields:

• ListVolumesOutput$Marker

• ListVolumesOutput$VolumeInfos

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListVolumesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ListVolumesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	gatewayARN()	Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasVolumeInfos()	For responses, this returns true if the service returned a value for the VolumeInfos property.
String	marker()	Use the marker in your next request to continue pagination of iSCSI volumes.
List<SdkField<?>>	sdkFields()
static Class<? extends ListVolumesResponse.Builder>	serializableBuilderClass()
ListVolumesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<VolumeInfo>	volumeInfos()	An array of VolumeInfo objects, where each object describes an iSCSI volume.

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

gatewayARN

public final String gatewayARN()

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

marker

public final String marker()

Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

Returns:

Use the marker in your next request to continue pagination of iSCSI volumes. If there are no more volumes to list, this field does not appear in the response body.

hasVolumeInfos

public final boolean hasVolumeInfos()

For responses, this returns true if the service returned a value for the VolumeInfos 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.

volumeInfos

public final List<VolumeInfo> volumeInfos()

An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".

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 hasVolumeInfos() method.

Returns:

An array of VolumeInfo objects, where each object describes an iSCSI volume. If no volumes are defined for the gateway, then VolumeInfos is an empty array "[]".

toBuilder

public ListVolumesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListVolumesResponse.Builder,ListVolumesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListVolumesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ListVolumesResponse.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