com.amazonaws.services.glacier.model

Class ListVaultsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.ListVaultsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
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:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ListVaultsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountId() The AccountId value is the AWS account ID.
String	getLimit() The maximum number of vaults to be returned.
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 vaults to be returned.
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 vaults to be returned.
ListVaultsRequest	withMarker(String marker) A string used for pagination.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

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 '-' (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 vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Method Detail

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.

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.

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.

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:

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 vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Parameters:

limit - The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

getLimit

public String getLimit()

The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Returns:

The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

withLimit

public ListVaultsRequest withLimit(String limit)

The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

Parameters:

limit - The maximum number of vaults to be returned. The default limit is 1000. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

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 ListVaultsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()