|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.storagegateway.model.DescribeTapesRequest
public class DescribeTapesRequest
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.
AWSStorageGateway.describeTapes(DescribeTapesRequest)
,
Serialized FormConstructor Summary | |
---|---|
DescribeTapesRequest()
|
Method Summary | |
---|---|
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 |
---|
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DescribeTapesRequest()
Method Detail |
---|
public String getGatewayARN()
Constraints:
Length: 50 - 500
public void setGatewayARN(String gatewayARN)
Constraints:
Length: 50 - 500
gatewayARN
- The Amazon Resource Name (ARN) of the gateway. Use the
ListGateways operation to return a list of gateways for your
account and region.public DescribeTapesRequest withGatewayARN(String gatewayARN)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 50 - 500
gatewayARN
- The Amazon Resource Name (ARN) of the gateway. Use the
ListGateways operation to return a list of gateways for your
account and region.
public List<String> getTapeARNs()
public void setTapeARNs(Collection<String> tapeARNs)
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.public DescribeTapesRequest withTapeARNs(String... tapeARNs)
Returns a reference to this object so that method calls can be chained together.
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.
public DescribeTapesRequest withTapeARNs(Collection<String> tapeARNs)
Returns a reference to this object so that method calls can be chained together.
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.
public String getMarker()
DescribeTapes
. This marker indicates which page of
results to retrieve. If not specified, the first page of results is retrieved.
Constraints:
Length: 1 - 1000
DescribeTapes
. This marker indicates which page of
results to retrieve. If not specified, the first page of results is retrieved.
public void setMarker(String marker)
DescribeTapes
. This marker indicates which page of
results to retrieve. If not specified, the first page of results is retrieved.
Constraints:
Length: 1 - 1000
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.
public DescribeTapesRequest withMarker(String marker)
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
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.
public Integer getLimit()
Constraints:
Range: 1 -
public void setLimit(Integer limit)
Constraints:
Range: 1 -
limit
- Specifies that the number of virtual tapes described be limited to the
specified number. public DescribeTapesRequest withLimit(Integer limit)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Range: 1 -
limit
- Specifies that the number of virtual tapes described be limited to the
specified number. public String toString()
toString
in class Object
Object.toString()
public int hashCode()
hashCode
in class Object
public boolean equals(Object obj)
equals
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |