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

Class DescribeTapeArchivesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTapeArchivesResponse.Builder,DescribeTapeArchivesResponse>

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

DescribeTapeArchivesOutput

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeTapeArchivesResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeTapeArchivesResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTapeArchives()	For responses, this returns true if the service returned a value for the TapeArchives property.
String	marker()	An opaque string that indicates the position at which the virtual tapes that were fetched for description ended.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTapeArchivesResponse.Builder>	serializableBuilderClass()
List<TapeArchive>	tapeArchives()	An array of virtual tape objects in the virtual tape shelf (VTS).
DescribeTapeArchivesResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasTapeArchives

public final boolean hasTapeArchives()

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

tapeArchives

public final List<TapeArchive> tapeArchives()

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.

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

Returns:

An array of virtual tape objects in the virtual tape shelf (VTS). The description includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the tapes, progress of the description, and tape barcode.

marker

public final String marker()

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

Returns:

An opaque string that indicates the position at which the virtual tapes that were fetched for description ended. Use this marker in your next request to fetch the next set of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to describe, this field does not appear in the response.

toBuilder

public DescribeTapeArchivesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeTapeArchivesResponse.Builder,DescribeTapeArchivesResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeTapeArchivesResponse.Builder builder()

serializableBuilderClass

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