com.amazonaws.services.storagegateway.model

Class CancelRetrievalRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.storagegateway.model.CancelRetrievalRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CancelRetrievalRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CancelRetrieval operation.

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. The virtual tape is returned to the VTS.

See Also:

AWSStorageGateway.cancelRetrieval(CancelRetrievalRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CancelRetrievalRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CancelRetrievalRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getGatewayARN() The Amazon Resource Name (ARN) of the gateway.
String	getTapeARN() The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
int	hashCode()
void	setGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
void	setTapeARN(String tapeARN) The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CancelRetrievalRequest	withGatewayARN(String gatewayARN) The Amazon Resource Name (ARN) of the gateway.
CancelRetrievalRequest	withTapeARN(String tapeARN) The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

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

CancelRetrievalRequest

public CancelRetrievalRequest()

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

getTapeARN

public String getTapeARN()

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

Constraints:
Length: 50 - 500

Returns:

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

setTapeARN

public void setTapeARN(String tapeARN)

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

Constraints:
Length: 50 - 500

Parameters:

tapeARN - The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

withTapeARN

public CancelRetrievalRequest withTapeARN(String tapeARN)

The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

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

Constraints:
Length: 50 - 500

Parameters:

tapeARN - The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval for.

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