software.amazon.awssdk.services.storagegateway.model

Class DescribeTapesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTapesRequest.Builder,DescribeTapesRequest>

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

DescribeTapesInput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeTapesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeTapesRequest.Builder	builder()
boolean	equals(Object obj)
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 number of virtual tapes described be limited to the specified number.
String	marker() A marker value, obtained in a previous call to DescribeTapes.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTapesRequest.Builder>	serializableBuilderClass()
List<String>	tapeARNs() Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
DescribeTapesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

Returns the value of the GatewayARN property for this object.

Returns:

The value of the GatewayARN property for this object.

tapeARNs

public List<String> tapeARNs()

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

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

Returns:

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe. If this parameter is not specified, Tape gateway returns a description of all virtual tapes associated with the specified gateway.

marker

public String marker()

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

Returns:

A marker value, obtained in a previous call to DescribeTapes. This marker indicates which page of results to retrieve.

If not specified, the first page of results is retrieved.

limit

public Integer limit()

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

Returns:

Specifies that the number of virtual tapes described be limited to the specified number.

Amazon Web Services may impose its own limit, if this field is not set.

toBuilder

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

Specified by:

toBuilder in class StorageGatewayRequest

Returns:

a builder for type T

builder

public static DescribeTapesRequest.Builder builder()

serializableBuilderClass

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

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