com.amazonaws.services.glacier.model

Class DescribeJobRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.DescribeJobRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class DescribeJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the DescribeJob operation.

This operation returns information about a job you previously initiated, including the job initiation date, the user who initiated the job, the job status code/message and the Amazon SNS topic to notify after Amazon Glacier completes the job. For more information about initiating a job, see InitiateJob.

NOTE: This operation enables you to check the status of your job. However, it is strongly recommended that you set up an Amazon SNS topic and specify it in your initiate job request so that Amazon Glacier can notify the topic after it completes the job.

A job ID will not expire for at least 24 hours after Amazon Glacier completes the job.

An AWS account has full permission to perform all operations (actions). However, AWS Identity and Access Management (IAM) users don't have any permissions by default. You must grant them explicit permission to perform specific actions. For more information, see Access Control Using AWS Identity and Access Management (IAM) .

For information about the underlying REST API, go to Working with Archives in Amazon Glacier in the Amazon Glacier Developer Guide .

See Also:

AmazonGlacier.describeJob(DescribeJobRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
DescribeJobRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAccountId() The AccountId value is the AWS account ID of the account that owns the vault.
String	getJobId() The ID of the job to describe.
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 ID of the job to describe.
void	setVaultName(String vaultName) The name of the vault.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeJobRequest	withAccountId(String accountId) The AccountId value is the AWS account ID of the account that owns the vault.
DescribeJobRequest	withJobId(String jobId) The ID of the job to describe.
DescribeJobRequest	withVaultName(String vaultName) The name of the vault.

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

DescribeJobRequest

public DescribeJobRequest()

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

DescribeJobRequest

public DescribeJobRequest(String accountId,
                  String vaultName,
                  String jobId)

Constructs a new DescribeJobRequest 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 '-' (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 ('-') in the ID.

vaultName - The name of the vault.

jobId - The ID of the job to describe.

DescribeJobRequest

public DescribeJobRequest(String vaultName,
                  String jobId)

Constructs a new DescribeJobRequest 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 ID of the job to describe.

Method Detail

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 '-' (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 ('-') 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 '-' (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 ('-') in the ID.

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 '-' (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 ('-') 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 '-' (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 ('-') in the ID.

withAccountId

public DescribeJobRequest 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 '-' (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 ('-') in the ID.

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

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 '-' (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 ('-') in the ID.

Returns:

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

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

withVaultName

public DescribeJobRequest withVaultName(String vaultName)

The name of the vault.

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

Parameters:

vaultName - The name of the vault.

Returns:

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

getJobId

public String getJobId()

The ID of the job to describe.

Returns:

The ID of the job to describe.

setJobId

public void setJobId(String jobId)

The ID of the job to describe.

Parameters:

jobId - The ID of the job to describe.

withJobId

public DescribeJobRequest withJobId(String jobId)

The ID of the job to describe.

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

Parameters:

jobId - The ID of the job to describe.

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