com.amazonaws.services.glacier.model

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

Container for the parameters to the ListVaults operation.

This operation lists all vaults owned by the calling user's account. The list returned in the response is ASCII-sorted by vault name.

By default, this operation returns up to 1,000 items. If there are more vaults to list, the response marker field contains the vault Amazon Resource Name (ARN) at which to continue the list with a new List Vaults request; otherwise, the marker field is null . To return a list of vaults that begins at a specific vault, set the marker request parameter to the vault ARN you obtained from a previous List Vaults request. You can also limit the number of vaults returned in the response by specifying the limit parameter in the request.

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 conceptual information and underlying REST API, go to Retrieving Vault Metadata in Amazon Glacier and List Vaults in the Amazon Glacier Developer Guide .

See Also:

AmazonGlacier.listVaults(ListVaultsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListVaultsRequest() Default constructor for a new ListVaultsRequest object.
ListVaultsRequest(String accountId) Constructs a new ListVaultsRequest object.
ListVaultsRequest(String accountId, String marker, String limit) Constructs a new ListVaultsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
ListVaultsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAccountId() The AccountId value is the AWS account ID.
String	getLimit() The maximum number of items returned in the response.
String	getMarker() A string used for pagination.
int	hashCode()
void	setAccountId(String accountId) The AccountId value is the AWS account ID.
void	setLimit(String limit) The maximum number of items returned in the response.
void	setMarker(String marker) A string used for pagination.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListVaultsRequest	withAccountId(String accountId) The AccountId value is the AWS account ID.
ListVaultsRequest	withLimit(String limit) The maximum number of items returned in the response.
ListVaultsRequest	withMarker(String marker) A string used for pagination.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

ListVaultsRequest

public ListVaultsRequest()

Default constructor for a new ListVaultsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this 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 '-' (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 ('-') 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 '-' (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 ('-') 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 Detail

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

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

Returns:

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

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.

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.

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.

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

Parameters:

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

Returns:

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

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.

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.

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.

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

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:

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

Object.clone()