Class ListJobsRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.glacier.model.ListJobsRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ListJobsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Provides options for retrieving a job list for an Amazon Glacier vault.

See Also:
  • Constructor Details

    • ListJobsRequest

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

      public ListJobsRequest(String vaultName)
      Constructs a new ListJobsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
      Parameters:
      vaultName - The name of the vault.
    • ListJobsRequest

      public ListJobsRequest(String accountId, String vaultName)
      Constructs a new ListJobsRequest 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.
  • Method Details

    • 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 ListJobsRequest 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 ListJobsRequest 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.
    • setLimit

      public void setLimit(String limit)

      Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

      Parameters:
      limit - Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.
    • getLimit

      public String getLimit()

      Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

      Returns:
      Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.
    • withLimit

      public ListJobsRequest withLimit(String limit)

      Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.

      Parameters:
      limit - Specifies that the response be limited to the specified number of items or fewer. If not specified, the List Jobs operation returns up to 1,000 jobs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setMarker

      public void setMarker(String marker)

      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

      Parameters:
      marker - An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.
    • getMarker

      public String getMarker()

      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

      Returns:
      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.
    • withMarker

      public ListJobsRequest withMarker(String marker)

      An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.

      Parameters:
      marker - An opaque string used for pagination. This value specifies the job at which the listing of jobs should begin. Get the marker value from a previous List Jobs response. You need only include the marker if you are continuing the pagination of results started in a previous List Jobs request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setStatuscode

      public void setStatuscode(String statuscode)

      Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

      Parameters:
      statuscode - Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
    • getStatuscode

      public String getStatuscode()

      Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

      Returns:
      Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
    • withStatuscode

      public ListJobsRequest withStatuscode(String statuscode)

      Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".

      Parameters:
      statuscode - Specifies the type of job status to return. You can specify the following values: "InProgress", "Succeeded", or "Failed".
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setCompleted

      public void setCompleted(String completed)

      Specifies the state of the jobs to return. You can specify true or false.

      Parameters:
      completed - Specifies the state of the jobs to return. You can specify true or false.
    • getCompleted

      public String getCompleted()

      Specifies the state of the jobs to return. You can specify true or false.

      Returns:
      Specifies the state of the jobs to return. You can specify true or false.
    • withCompleted

      public ListJobsRequest withCompleted(String completed)

      Specifies the state of the jobs to return. You can specify true or false.

      Parameters:
      completed - Specifies the state of the jobs to return. You can specify true or false.
      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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ListJobsRequest 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: