Package com.amazonaws.services.glacier.model

Class ListPartsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.glacier.model.ListPartsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class ListPartsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Provides options for retrieving a list of parts of an archive that have been uploaded in a specific multipart upload.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor	Description
ListPartsRequest()	Default constructor for ListPartsRequest object.
ListPartsRequest(String vaultName, String uploadId)	Constructs a new ListPartsRequest object.
ListPartsRequest(String accountId, String vaultName, String uploadId)	Constructs a new ListPartsRequest object.

Method Summary

Modifier and Type	Method	Description
ListPartsRequest	clone()	Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAccountId()	The AccountId value is the AWS account ID of the account that owns the vault.
String	getLimit()	Specifies the maximum number of parts returned in the response body.
String	getMarker()	An opaque string used for pagination.
String	getUploadId()	The upload ID of the multipart upload.
String	getVaultName()	The name of the vault.
int	hashCode()
void	setAccountId(String accountId)	The AccountId value is the AWS account ID of the account that owns the vault.
void	setLimit(String limit)	Specifies the maximum number of parts returned in the response body.
void	setMarker(String marker)	An opaque string used for pagination.
void	setUploadId(String uploadId)	The upload ID of the multipart upload.
void	setVaultName(String vaultName)	The name of the vault.
String	toString()	Returns a string representation of this object; useful for testing and debugging.
ListPartsRequest	withAccountId(String accountId)	The AccountId value is the AWS account ID of the account that owns the vault.
ListPartsRequest	withLimit(String limit)	Specifies the maximum number of parts returned in the response body.
ListPartsRequest	withMarker(String marker)	An opaque string used for pagination.
ListPartsRequest	withUploadId(String uploadId)	The upload ID of the multipart upload.
ListPartsRequest	withVaultName(String vaultName)	The name of the vault.

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ListPartsRequest

public ListPartsRequest()

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

ListPartsRequest

public ListPartsRequest(String vaultName,
                        String uploadId)

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

Parameters:

vaultName - The name of the vault.

uploadId - The upload ID of the multipart upload.

ListPartsRequest

public ListPartsRequest(String accountId,
                        String vaultName,
                        String uploadId)

Constructs a new ListPartsRequest 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 of the account that owns the vault. 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 use an account ID, do not include any hyphens (apos-apos) in the ID.

vaultName - The name of the vault.

uploadId - The upload ID of the multipart upload.

Method Detail

setAccountId

public void setAccountId(String accountId)

The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens (apos-apos) in the ID.

Parameters:

accountId - The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens (apos-apos) in the ID.

getAccountId

public String getAccountId()

The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens (apos-apos) in the ID.

Returns:

The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens (apos-apos) in the ID.

withAccountId

public ListPartsRequest withAccountId(String accountId)

The AccountId value is the AWS account ID of the account that owns the vault. 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 use an account ID, do not include any hyphens (apos-apos) in the ID.

Parameters:

accountId - The AccountId value is the AWS account ID of the account that owns the vault. 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 use an 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.

setVaultName

public void setVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

getVaultName

public String getVaultName()

The name of the vault.

Returns:

The name of the vault.

withVaultName

public ListPartsRequest withVaultName(String vaultName)

The name of the vault.

Parameters:

vaultName - The name of the vault.

Returns:

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

setUploadId

public void setUploadId(String uploadId)

The upload ID of the multipart upload.

Parameters:

uploadId - The upload ID of the multipart upload.

getUploadId

public String getUploadId()

The upload ID of the multipart upload.

Returns:

The upload ID of the multipart upload.

withUploadId

public ListPartsRequest withUploadId(String uploadId)

The upload ID of the multipart upload.

Parameters:

uploadId - The upload ID of the multipart upload.

Returns:

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

setMarker

public void setMarker(String marker)

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

Parameters:

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

getMarker

public String getMarker()

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

Returns:

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

withMarker

public ListPartsRequest withMarker(String marker)

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

Parameters:

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

Returns:

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

setLimit

public void setLimit(String limit)

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

Parameters:

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

getLimit

public String getLimit()

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

Returns:

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

withLimit

public ListPartsRequest withLimit(String limit)

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

Parameters:

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

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 ListPartsRequest 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()