com.amazonaws.services.glacier.model

Class GetJobOutputRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.GetJobOutputRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetJobOutputRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Provides options for downloading output of an Amazon Glacier job.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetJobOutputRequest() Default constructor for GetJobOutputRequest object.
GetJobOutputRequest(String vaultName, String jobId, String range) Constructs a new GetJobOutputRequest object.
GetJobOutputRequest(String accountId, String vaultName, String jobId, String range) Constructs a new GetJobOutputRequest object.

Method Summary

Modifier and Type	Method and Description
GetJobOutputRequest	clone()
boolean	equals(Object obj)
String	getAccountId() The AccountId value is the AWS account ID of the account that owns the vault.
String	getJobId() The job ID whose data is downloaded.
String	getRange() The range of bytes to retrieve from the output.
String	getVaultName() The name of the vault.
int	hashCode()
void	setAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
void	setJobId(String jobId) The job ID whose data is downloaded.
void	setRange(String range) The range of bytes to retrieve from the output.
void	setVaultName(String vaultName) The name of the vault.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetJobOutputRequest	withAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
GetJobOutputRequest	withJobId(String jobId) The job ID whose data is downloaded.
GetJobOutputRequest	withRange(String range) The range of bytes to retrieve from the output.
GetJobOutputRequest	withVaultName(String vaultName) The name of the vault.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

GetJobOutputRequest

public GetJobOutputRequest()

Default constructor for GetJobOutputRequest object. Callers should use the setter or fluent setter (with...) methods to initialize the object after creating it.

GetJobOutputRequest

public GetJobOutputRequest(String vaultName,
                           String jobId,
                           String range)

Constructs a new GetJobOutputRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

vaultName - The name of the vault.

jobId - The job ID whose data is downloaded.

range - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

GetJobOutputRequest

public GetJobOutputRequest(String accountId,
                           String vaultName,
                           String jobId,
                           String range)

Constructs a new GetJobOutputRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

accountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.

vaultName - The name of the vault.

jobId - The job ID whose data is downloaded.

range - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

Method Detail

setAccountId

public void setAccountId(String accountId)

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.

Parameters:

accountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.

getAccountId

public String getAccountId()

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.

Returns:

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.

withAccountId

public GetJobOutputRequest withAccountId(String accountId)

The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.

Parameters:

accountId - The AccountId value is the AWS account ID of the account that owns the vault. You can either specify an AWS account ID or optionally a single apos-apos (hyphen), in which case Amazon Glacier uses the AWS account ID associated with the credentials used to sign the request. If you use an account ID, do not include any hyphens (apos-apos) in the ID.

Returns:

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

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

withVaultName

public GetJobOutputRequest withVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

Returns:

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

setJobId

public void setJobId(String jobId)

The job ID whose data is downloaded.

Parameters:

jobId - The job ID whose data is downloaded.

getJobId

public String getJobId()

The job ID whose data is downloaded.

Returns:

The job ID whose data is downloaded.

withJobId

public GetJobOutputRequest withJobId(String jobId)

The job ID whose data is downloaded.

Parameters:

jobId - The job ID whose data is downloaded.

Returns:

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

setRange

public void setRange(String range)

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

Parameters:

range - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

getRange

public String getRange()

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

Returns:

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

withRange

public GetJobOutputRequest withRange(String range)

The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

Parameters:

range - The range of bytes to retrieve from the output. For example, if you want to download the first 1,048,576 bytes, specify "Range: bytes=0-1048575". By default, this operation downloads the entire output.

Returns:

Returns a reference to this 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()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetJobOutputRequest clone()

Overrides:

clone in class AmazonWebServiceRequest