Class ListVaultsRequest

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

public class ListVaultsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Provides options to retrieve the vault list owned by the calling user's account. The list provides metadata information for each vault.

See Also:
  • Constructor Details

    • ListVaultsRequest

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

      public ListVaultsRequest(String accountId)
      Constructs a new ListVaultsRequest 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. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens (apos-apos) in the ID.
    • ListVaultsRequest

      public ListVaultsRequest(String accountId, String marker, String limit)
      Constructs a new ListVaultsRequest 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. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens (apos-apos) in the ID.
      marker - A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
      limit - The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.
  • Method Details

    • setAccountId

      public void setAccountId(String accountId)

      The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens (apos-apos) in the ID.

      Parameters:
      accountId - The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens (apos-apos) in the ID.
    • getAccountId

      public String getAccountId()

      The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens (apos-apos) in the ID.

      Returns:
      The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens (apos-apos) in the ID.
    • withAccountId

      public ListVaultsRequest withAccountId(String accountId)

      The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your account ID, do not include any hyphens (apos-apos) in the ID.

      Parameters:
      accountId - The AccountId value is the AWS account ID. This value must match the AWS account ID associated with the credentials used to sign the request. 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 specify your 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.
    • setMarker

      public void setMarker(String marker)

      A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

      Parameters:
      marker - A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
    • getMarker

      public String getMarker()

      A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

      Returns:
      A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
    • withMarker

      public ListVaultsRequest withMarker(String marker)

      A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

      Parameters:
      marker - A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setLimit

      public void setLimit(String limit)

      The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.

      Parameters:
      limit - The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.
    • getLimit

      public String getLimit()

      The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.

      Returns:
      The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.
    • withLimit

      public ListVaultsRequest withLimit(String limit)

      The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.

      Parameters:
      limit - The maximum number of items returned in the response. If you don't specify a value, the List Vaults operation returns up to 1,000 items.
      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 ListVaultsRequest 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: