com.amazonaws.services.storagegateway.model

Class DescribeTapeArchivesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.DescribeTapeArchivesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeTapeArchivesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeTapeArchives operation.

Returns a description of specified virtual tapes in the virtual tape shelf (VTS).

If a specific TapeARN is not specified, AWS Storage Gateway returns a description of all virtual tapes found in the VTS associated with your account.

See Also:

AWSStorageGateway.describeTapeArchives(DescribeTapeArchivesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeTapeArchivesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeTapeArchivesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
Integer	getLimit() Specifies that the number of virtual tapes descried be limited to the specified number.
String	getMarker() An opaque string that indicates the position at which to begin describing virtual tapes.
List<String>	getTapeARNs() Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
int	hashCode()
void	setLimit(Integer limit) Specifies that the number of virtual tapes descried be limited to the specified number.
void	setMarker(String marker) An opaque string that indicates the position at which to begin describing virtual tapes.
void	setTapeARNs(Collection<String> tapeARNs) Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeTapeArchivesRequest	withLimit(Integer limit) Specifies that the number of virtual tapes descried be limited to the specified number.
DescribeTapeArchivesRequest	withMarker(String marker) An opaque string that indicates the position at which to begin describing virtual tapes.
DescribeTapeArchivesRequest	withTapeARNs(Collection<String> tapeARNs) Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
DescribeTapeArchivesRequest	withTapeARNs(String... tapeARNs) Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeTapeArchivesRequest

public DescribeTapeArchivesRequest()

Method Detail

getTapeARNs

public List<String> getTapeARNs()

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Returns:

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

setTapeARNs

public void setTapeARNs(Collection<String> tapeARNs)

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Parameters:

tapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

withTapeARNs

public DescribeTapeArchivesRequest withTapeARNs(String... tapeARNs)

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

NOTE: This method appends the values to the existing list (if any). Use setTapeARNs(java.util.Collection) or withTapeARNs(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

withTapeARNs

public DescribeTapeArchivesRequest withTapeARNs(Collection<String> tapeARNs)

Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tapeARNs - Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.

Returns:

A reference to this updated object so that method calls can be chained together.

getMarker

public String getMarker()

An opaque string that indicates the position at which to begin describing virtual tapes.

Constraints:
Length: 1 - 1000

Returns:

An opaque string that indicates the position at which to begin describing virtual tapes.

setMarker

public void setMarker(String marker)

An opaque string that indicates the position at which to begin describing virtual tapes.

Constraints:
Length: 1 - 1000

Parameters:

marker - An opaque string that indicates the position at which to begin describing virtual tapes.

withMarker

public DescribeTapeArchivesRequest withMarker(String marker)

An opaque string that indicates the position at which to begin describing virtual tapes.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1000

Parameters:

marker - An opaque string that indicates the position at which to begin describing virtual tapes.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

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

Constraints:
Range: 1 -

Returns:

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

setLimit

public void setLimit(Integer limit)

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

Constraints:
Range: 1 -

Parameters:

limit - Specifies that the number of virtual tapes descried be limited to the specified number.

withLimit

public DescribeTapeArchivesRequest withLimit(Integer limit)

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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 1 -

Parameters:

limit - Specifies that the number of virtual tapes descried be limited to the specified number.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeTapeArchivesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()