com.amazonaws.services.s3.model
Class CompleteMultipartUploadRequest

java.lang.Object
  extended by com.amazonaws.AmazonWebServiceRequest
      extended by com.amazonaws.services.s3.model.CompleteMultipartUploadRequest

public class CompleteMultipartUploadRequest
extends AmazonWebServiceRequest

Container for the parameters of the CompleteMultipartUpload operation.

Required Parameters: BucketName, Key, UploadId, PartETags

See Also:
AmazonS3.completeMultipartUpload(CompleteMultipartUploadRequest)

Constructor Summary
CompleteMultipartUploadRequest(String bucketName, String key, String uploadId, List<PartETag> partETags)
          Constructs a new request to complete a multipart upload.
 
Method Summary
 String getBucketName()
          Returns the name of the bucket containing the multipart upload to complete.
 String getKey()
          Returns the key under which the multipart upload to complete is stored.
 List<PartETag> getPartETags()
          Returns the list of part numbers and ETags that identify the individual parts of the multipart upload to complete.
 String getUploadId()
          Returns the ID of the multipart upload to complete.
 void setBucketName(String bucketName)
          Sets the name of the bucket containing the multipart upload to complete.
 void setKey(String key)
          Sets the key under which the multipart upload to complete is stored.
 void setPartETags(List<PartETag> partETags)
          Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete.
 void setUploadId(String uploadId)
          Sets the ID of the multipart upload to complete.
 CompleteMultipartUploadRequest withBucketName(String bucketName)
          Sets the name of the bucket containing the multipart upload to complete, and returns this updated CompleteMultipartUploadRequest so that additional method calls can be chained together.
 CompleteMultipartUploadRequest withKey(String key)
          Sets the key under which the multipart upload to complete is stored, and returns this updated CompleteMultipartUploadRequest object so that additional method calls can be chained together.
 CompleteMultipartUploadRequest withPartETags(Collection<UploadPartResult> uploadPartResultsCollection)
          Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete based on the specified results from part uploads.
 CompleteMultipartUploadRequest withPartETags(List<PartETag> partETags)
          Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete, and returns this updated CompleteMultipartUploadRequest object so that additional method calls can be chained.
 CompleteMultipartUploadRequest withPartETags(UploadPartResult... uploadPartResults)
          Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete based on the specified results from part uploads.
 CompleteMultipartUploadRequest withUploadId(String uploadId)
          Sets the ID of the multipart upload to complete, and returns this updated CompleteMultipartUploadRequest object so that additional method calls can be chained together.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CompleteMultipartUploadRequest

public CompleteMultipartUploadRequest(String bucketName,
                                      String key,
                                      String uploadId,
                                      List<PartETag> partETags)
Constructs a new request to complete a multipart upload.

Parameters:
bucketName - The name of the bucket containing the multipart upload to complete.
key - The key of the multipart upload to complete.
uploadId - The ID of the multipart upload to complete.
partETags - The list of part numbers and ETags to use when completing the multipart upload.
Method Detail

getBucketName

public String getBucketName()
Returns the name of the bucket containing the multipart upload to complete.

Returns:
The name of the bucket containing the multipart upload to complete.

setBucketName

public void setBucketName(String bucketName)
Sets the name of the bucket containing the multipart upload to complete.

Parameters:
bucketName - The name of the bucket containing the multipart upload to complete.

withBucketName

public CompleteMultipartUploadRequest withBucketName(String bucketName)
Sets the name of the bucket containing the multipart upload to complete, and returns this updated CompleteMultipartUploadRequest so that additional method calls can be chained together.

Parameters:
bucketName - The name of the bucket containing the multipart upload to complete.
Returns:
The updated CompleteMultipartUploadRequest.

getKey

public String getKey()
Returns the key under which the multipart upload to complete is stored.

Returns:
The key under which the multipart upload to complete is stored.

setKey

public void setKey(String key)
Sets the key under which the multipart upload to complete is stored.

Parameters:
key - The key under which the multipart upload to complete is stored.

withKey

public CompleteMultipartUploadRequest withKey(String key)
Sets the key under which the multipart upload to complete is stored, and returns this updated CompleteMultipartUploadRequest object so that additional method calls can be chained together.

Parameters:
key - The key under which the multipart upload to complete is stored.
Returns:
This updated CompleteMultipartUploadRequest object.

getUploadId

public String getUploadId()
Returns the ID of the multipart upload to complete.

Returns:
The ID of the multipart upload to complete.

setUploadId

public void setUploadId(String uploadId)
Sets the ID of the multipart upload to complete.

Parameters:
uploadId - The ID of the multipart upload to complete.

withUploadId

public CompleteMultipartUploadRequest withUploadId(String uploadId)
Sets the ID of the multipart upload to complete, and returns this updated CompleteMultipartUploadRequest object so that additional method calls can be chained together.

Parameters:
uploadId - The ID of the multipart upload to complete.
Returns:
This updated CompleteMultipartUploadRequest object.

getPartETags

public List<PartETag> getPartETags()
Returns the list of part numbers and ETags that identify the individual parts of the multipart upload to complete.

Returns:
The list of part numbers and ETags that identify the individual parts of the multipart upload to complete.

setPartETags

public void setPartETags(List<PartETag> partETags)
Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete.

Parameters:
partETags - The list of part numbers and ETags that identify the individual parts of the multipart upload to complete.

withPartETags

public CompleteMultipartUploadRequest withPartETags(List<PartETag> partETags)
Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete, and returns this updated CompleteMultipartUploadRequest object so that additional method calls can be chained.

Parameters:
partETags - The list of part numbers and ETags that identify the individual parts of the multipart upload to complete.
Returns:
This updated CompleteMultipartUploadRequest object.

withPartETags

public CompleteMultipartUploadRequest withPartETags(UploadPartResult... uploadPartResults)
Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete based on the specified results from part uploads.

Parameters:
uploadPartResults - The list of results from the individual part uploads in the multipart upload to complete.
Returns:
This updated CompleteMultipartUploadRequest object.

withPartETags

public CompleteMultipartUploadRequest withPartETags(Collection<UploadPartResult> uploadPartResultsCollection)
Sets the list of part numbers and ETags that identify the individual parts of the multipart upload to complete based on the specified results from part uploads.

Parameters:
uploadPartResultsCollection - The list of results from the individual part uploads in the multipart upload to complete.
Returns:
This updated CompleteMultipartUploadRequest object.


Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.