Package 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("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	Description
static interface	DescribeTapesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeTapesRequest.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	hasTapeARNs()	For responses, this returns true if the service returned a value for the TapeARNs property.
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()
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

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.

hasTapeARNs

public final boolean hasTapeARNs()

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

tapeARNs

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

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTapesRequest.Builder,DescribeTapesRequest>

Specified by:

toBuilder in class StorageGatewayRequest

builder

public static DescribeTapesRequest.Builder builder()

serializableBuilderClass

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

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo