com.amazonaws.services.storagegateway.model

Class DescribeTapesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.DescribeTapesRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeTapesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeTapes operation.

Returns a description of the specified Amazon Resource Name (ARN) of virtual tapes. If a TapeARN is not specified, returns a description of all virtual tapes associated with the specified gateway.

See Also:

AWSStorageGateway.describeTapes(DescribeTapesRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeTapesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeTapesRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getGatewayARN() The Amazon Resource Name (ARN) of the gateway.
Integer	getLimit() Specifies that the number of virtual tapes described be limited to the specified number.
String	getMarker() A marker value, obtained in a previous call to DescribeTapes.
List<String>	getTapeARNs() Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
int	hashCode()
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
void	setLimit(Integer limit) Specifies that the number of virtual tapes described be limited to the specified number.
void	setMarker(String marker) A marker value, obtained in a previous call to DescribeTapes.
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.
DescribeTapesRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
DescribeTapesRequest	withLimit(Integer limit) Specifies that the number of virtual tapes described be limited to the specified number.
DescribeTapesRequest	withMarker(String marker) A marker value, obtained in a previous call to DescribeTapes.
DescribeTapesRequest	withTapeARNs(Collection<String> tapeARNs) Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual tapes you want to describe.
DescribeTapesRequest	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, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeTapesRequest

public DescribeTapesRequest()

Method Detail

getGatewayARN

public String getGatewayARN()

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Returns:

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

setGatewayARN

public void setGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

withGatewayARN

public DescribeTapesRequest withGatewayARN(String gatewayARN)

The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

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

Constraints:
Length: 50 - 500

Parameters:

gatewayARN - The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and region.

Returns:

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

getTapeARNs

public List<String> getTapeARNs()

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

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, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

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. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

Parameters:

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, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

withTapeARNs

public DescribeTapesRequest withTapeARNs(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, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

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. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

Returns:

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

withTapeARNs

public DescribeTapesRequest withTapeARNs(Collection<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, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

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. If this parameter is not specified, AWS Storage Gateway returns a description of all virtual tapes associated with the specified gateway.

Returns:

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

getMarker

public String getMarker()

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.

Constraints:
Length: 1 - 1000

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.

setMarker

public void setMarker(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.

Constraints:
Length: 1 - 1000

Parameters:

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.

withMarker

public DescribeTapesRequest withMarker(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 reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 1000

Parameters:

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 reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

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.

Constraints:
Range: 1 -

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.

setLimit

public void setLimit(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.

Constraints:
Range: 1 -

Parameters:

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.

withLimit

public DescribeTapesRequest withLimit(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 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 described be limited to the specified number. Amazon Web Services may impose its own limit, if this field is not set.

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