com.amazonaws.services.glacier.model
Class ListMultipartUploadsRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.glacier.model.ListMultipartUploadsRequest

All Implemented Interfaces:

Serializable

public class ListMultipartUploadsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the ListMultipartUploads operation.

This operation lists in-progress multipart uploads for the specified vault. An in-progress multipart upload is a multipart upload that has been initiated by an InitiateMultipartUpload request, but has not yet been completed or aborted. The list returned in the List Multipart Upload response has no guaranteed order.

The List Multipart Uploads operation supports pagination. By default, this operation returns up to 1,000 multipart uploads in the response. You should always check the response for a marker at which to continue the list; if there are no more items the marker is null . To return a list of multipart uploads that begins at a specific upload, set the marker request parameter to the value you obtained from a previous List Multipart Upload request. You can also limit the number of uploads returned in the response by specifying the limit parameter in the request.

Note the difference between this operation and listing parts (ListParts). The List Multipart Uploads operation lists all multipart uploads for a vault and does not require a multipart upload ID. The List Parts operation requires a multipart upload ID since parts are associated with a single upload.

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 the underlying REST API, go to Working with Archives in Amazon Glacier and List Multipart Uploads in the Amazon Glacier Developer Guide .

See Also:

AmazonGlacier.listMultipartUploads(ListMultipartUploadsRequest), Serialized Form

Constructor Summary

ListMultipartUploadsRequest()
Default constructor for a new ListMultipartUploadsRequest object.

ListMultipartUploadsRequest(String vaultName)
Constructs a new ListMultipartUploadsRequest object.

ListMultipartUploadsRequest(String accountId, String vaultName)
Constructs a new ListMultipartUploadsRequest object.

Method Summary

boolean	equals(Object obj)
String	getAccountId() The AccountId is the AWS Account ID.
String	getLimit() Specifies the maximum number of uploads returned in the response body.
String	getUploadIdMarker() An opaque string used for pagination.
String	getVaultName() The name of the vault.
int	hashCode()
void	setAccountId(String accountId) The AccountId is the AWS Account ID.
void	setLimit(String limit) Specifies the maximum number of uploads returned in the response body.
void	setUploadIdMarker(String uploadIdMarker) An opaque string used for pagination.
void	setVaultName(String vaultName) The name of the vault.
String	toString() Returns a string representation of this object; useful for testing and debugging.
ListMultipartUploadsRequest	withAccountId(String accountId) The AccountId is the AWS Account ID.
ListMultipartUploadsRequest	withLimit(String limit) Specifies the maximum number of uploads returned in the response body.
ListMultipartUploadsRequest	withUploadIdMarker(String uploadIdMarker) An opaque string used for pagination.
ListMultipartUploadsRequest	withVaultName(String vaultName) The name of the vault.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListMultipartUploadsRequest

public ListMultipartUploadsRequest()

Default constructor for a new ListMultipartUploadsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

ListMultipartUploadsRequest

public ListMultipartUploadsRequest(String vaultName)

Constructs a new ListMultipartUploadsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

vaultName - The name of the vault.

ListMultipartUploadsRequest

public ListMultipartUploadsRequest(String accountId,
                                   String vaultName)

Constructs a new ListMultipartUploadsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', 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 hyphens in it.

vaultName - The name of the vault.

Method Detail

getAccountId

public String getAccountId()

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', 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 hyphens in it.

Returns:

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', 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 hyphens in it.

setAccountId

public void setAccountId(String accountId)

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', 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 hyphens in it.

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', 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 hyphens in it.

withAccountId

public ListMultipartUploadsRequest withAccountId(String accountId)

The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', 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 hyphens in it.

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

Parameters:

accountId - The AccountId is the AWS Account ID. You can specify either the AWS Account ID or optionally a '-', 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 hyphens in it.

Returns:

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

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

withVaultName

public ListMultipartUploadsRequest withVaultName(String vaultName)

The name of the vault.

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

Parameters:

vaultName - The name of the vault.

Returns:

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

getUploadIdMarker

public String getUploadIdMarker()

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

Returns:

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

setUploadIdMarker

public void setUploadIdMarker(String uploadIdMarker)

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

Parameters:

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

withUploadIdMarker

public ListMultipartUploadsRequest withUploadIdMarker(String uploadIdMarker)

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

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

Parameters:

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

Returns:

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

getLimit

public String getLimit()

Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

Returns:

Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

setLimit

public void setLimit(String limit)

Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

Parameters:

limit - Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

withLimit

public ListMultipartUploadsRequest withLimit(String limit)

Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

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

Parameters:

limit - Specifies the maximum number of uploads returned in the response body. If this value is not specified, the List Uploads operation returns up to 1,000 uploads.

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