Class ListVaultsRequest
- All Implemented Interfaces:
ReadLimitInfo
,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:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault 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 TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
TheAccountId
value is the AWS account ID.getLimit()
The maximum number of items returned in the response.A string used for pagination.int
hashCode()
void
setAccountId
(String accountId) TheAccountId
value is the AWS account ID.void
The maximum number of items returned in the response.void
A string used for pagination.toString()
Returns a string representation of this object; useful for testing and debugging.withAccountId
(String accountId) TheAccountId
value is the AWS account ID.The maximum number of items returned in the response.withMarker
(String marker) A string used for pagination.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
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
Constructs a new ListVaultsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
accountId
- TheAccountId
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
Constructs a new ListVaultsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.- Parameters:
accountId
- TheAccountId
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
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
- TheAccountId
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
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
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
- TheAccountId
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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 classAmazonWebServiceRequest
- See Also:
-