software.amazon.awssdk.services.storagegateway.model

Class ListVolumesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.storagegateway.model.StorageGatewayRequest

software.amazon.awssdk.services.storagegateway.model.ListVolumesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListVolumesRequest.Builder,ListVolumesRequest>

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

A JSON object that contains one or more of the following fields:

• ListVolumesInput$Limit

• ListVolumesInput$Marker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListVolumesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListVolumesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	gatewayARN() Returns the value of the GatewayARN property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	limit() Specifies that the list of volumes returned be limited to the specified number of items.
String	marker() A string that indicates the position at which to begin the returned list of volumes.
List<SdkField<?>>	sdkFields()
static Class<? extends ListVolumesRequest.Builder>	serializableBuilderClass()
ListVolumesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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()

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

Returns:

A string that indicates the position at which to begin the returned list of volumes. Obtain the marker from the response of a previous List iSCSI Volumes request.

limit

public final Integer limit()

Specifies that the list of volumes returned be limited to the specified number of items.

Returns:

Specifies that the list of volumes returned be limited to the specified number of items.

toBuilder

public ListVolumesRequest.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<ListVolumesRequest.Builder,ListVolumesRequest>

Specified by:

toBuilder in class StorageGatewayRequest

Returns:

a builder for type T

builder

public static ListVolumesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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.