Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.amazonaws.services.s3.model
Class UploadPartRequest

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

public class UploadPartRequest
extends AmazonWebServiceRequest

Contains the parameters used for the UploadPart operation on Amazon S3.

Required Parameters: BucketName, Key, UploadId, PartNumber

Constructor Summary
UploadPartRequest()
           
 
Method Summary
 java.lang.String getBucketName()
          Returns the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.
 java.io.File getFile()
          Returns the file containing the data to upload.
 long getFileOffset()
          Returns the optional offset in the specified file, at which to begin uploading data for this part.
 ProgressListener getGeneralProgressListener()
          Returns the optional progress listener for receiving updates about object download status.
 java.io.InputStream getInputStream()
          Returns the stream containing the data to upload for the new part.
 java.lang.String getKey()
          Returns the key of the initiated multipart upload.
 java.lang.String getMd5Digest()
          Returns the optional, but recommended, MD5 hash of the content of this part.
 int getPartNumber()
          Returns the part number describing this part's position relative to the other parts in the multipart upload.
 long getPartSize()
          Returns the size of this part, in bytes.
 ProgressListener getProgressListener()
          Deprecated. use getGeneralProgressListener() instead.
 SSECustomerKey getSSECustomerKey()
          Returns the optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.
 java.lang.String getUploadId()
          Returns the ID of the existing, initiated multipart upload with which this new part will be associated.
 boolean isLastPart()
          Returns true if the creator of this request has indicated this part is the last part being uploaded in a multipart upload.
 void setBucketName(java.lang.String bucketName)
          Sets the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.
 void setFile(java.io.File file)
          Sets the file containing the data to upload.
 void setFileOffset(long fileOffset)
          Sets the optional offset in the specified file, at which to begin uploading data for this part.
 void setGeneralProgressListener(ProgressListener generalProgressListener)
          Sets the optional progress listener for receiving updates about object download status.
 void setInputStream(java.io.InputStream inputStream)
          Sets the stream containing the data to upload for the new part.
 void setKey(java.lang.String key)
          Sets the key of the initiated multipart upload.
 void setLastPart(boolean isLastPart)
          Marks this part as the last part being uploaded in a multipart upload.
 void setMd5Digest(java.lang.String md5Digest)
          Sets the optional, but recommended, MD5 hash of the content of this part.
 void setPartNumber(int partNumber)
          Sets the part number describing this part's position relative to the other parts in the multipart upload.
 void setPartSize(long partSize)
          Sets the size of this part, in bytes.
 void setProgressListener(ProgressListener progressListener)
          Deprecated. use setGeneralProgressListener(ProgressListener) instead.
 void setSSECustomerKey(SSECustomerKey sseKey)
          Sets the optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.
 void setUploadId(java.lang.String uploadId)
          Sets the ID of the existing, initiated multipart upload with which this new part will be associated.
 UploadPartRequest withBucketName(java.lang.String bucketName)
          Sets the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated, and returns this updated object so that additional method calls can be chained together.
 UploadPartRequest withFile(java.io.File file)
          Sets the file containing the data to upload, and returns this updated UploadPartRequest object so that additional method calls can be chained together.
 UploadPartRequest withFileOffset(long fileOffset)
          Sets the optional offset in the specified file, at which to begin uploading data for this part, and returns this updated UploadPartRequest object so that additional method calls can be chained together.
 UploadPartRequest withGeneralProgressListener(ProgressListener progressListener)
          Sets the optional progress listener for receiving updates about object upload status, and returns this updated object so that additional method calls can be chained together.
 UploadPartRequest withInputStream(java.io.InputStream inputStream)
          Sets the stream containing the data to upload for the new part, and returns this updated object so that additional method calls can be chained together.
 UploadPartRequest withKey(java.lang.String key)
          Sets the key of the initiated multipart upload, and returns this updated object so that additional method calls can be chained together.
 UploadPartRequest withLastPart(boolean isLastPart)
          Marks this part as the last part being uploaded in a multipart upload, and returns this updated request object so that additional method calls can be chained together.
 UploadPartRequest withMD5Digest(java.lang.String md5Digest)
          Sets the optional, but recommended, MD5 hash of the content of this part.
 UploadPartRequest withPartNumber(int partNumber)
          Sets the part number describing this part's position relative to the other parts in the multipart upload.
 UploadPartRequest withPartSize(long partSize)
          Sets the size of this part, in bytes, and returns this updated UploadPartRequest object so that additional method calls can be chained together.
 UploadPartRequest withProgressListener(ProgressListener progressListener)
          Deprecated. use withGeneralProgressListener(ProgressListener) instead.
 UploadPartRequest withSSECustomerKey(SSECustomerKey sseKey)
          Sets the optional customer-provided server-side encryption key to use to encrypt the object part being uploaded, and returns the updated request object so that additional method calls can be chained together.
 UploadPartRequest withUploadId(java.lang.String uploadId)
          Sets the ID of the existing, initiated multipart upload with which this new part will be associated, and returns this updated UploadPartRequest object so that additional method calls can be chained together.
 
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setDelegationToken, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UploadPartRequest

public UploadPartRequest()
Method Detail

setInputStream

public void setInputStream(java.io.InputStream inputStream)
Sets the stream containing the data to upload for the new part.

Parameters:
inputStream - the stream containing the data to upload for the new part.

getInputStream

public java.io.InputStream getInputStream()
Returns the stream containing the data to upload for the new part.

Returns:
the stream containing the data to upload for the new part.

withInputStream

public UploadPartRequest withInputStream(java.io.InputStream inputStream)
Sets the stream containing the data to upload for the new part, and returns this updated object so that additional method calls can be chained together.

Parameters:
inputStream - the stream containing the data to upload for the new part.
Returns:
The updated UploadPartRequest object.

getBucketName

public java.lang.String getBucketName()
Returns the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.

Returns:
the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.

setBucketName

public void setBucketName(java.lang.String bucketName)
Sets the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.

Parameters:
bucketName - the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.

withBucketName

public UploadPartRequest withBucketName(java.lang.String bucketName)
Sets the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated, and returns this updated object so that additional method calls can be chained together.

Parameters:
bucketName - the name of the bucket containing the existing, initiated multipart upload, with which this new part will be associated.
Returns:
This updated UploadPartRequest object.

getKey

public java.lang.String getKey()
Returns the key of the initiated multipart upload.

Returns:
the key of the initiated multipart upload.

setKey

public void setKey(java.lang.String key)
Sets the key of the initiated multipart upload.

Parameters:
key - the key of the initiated multipart upload.

withKey

public UploadPartRequest withKey(java.lang.String key)
Sets the key of the initiated multipart upload, and returns this updated object so that additional method calls can be chained together.

Parameters:
key - the key of the initiated multipart upload.
Returns:
This updated UploadPartRequest object.

getUploadId

public java.lang.String getUploadId()
Returns the ID of the existing, initiated multipart upload with which this new part will be associated.

Returns:
the ID of the existing, initiated multipart upload with which this new part will be associated.

setUploadId

public void setUploadId(java.lang.String uploadId)
Sets the ID of the existing, initiated multipart upload with which this new part will be associated.

Parameters:
uploadId - the ID of the existing, initiated multipart upload with which this new part will be associated.

withUploadId

public UploadPartRequest withUploadId(java.lang.String uploadId)
Sets the ID of the existing, initiated multipart upload with which this new part will be associated, and returns this updated UploadPartRequest object so that additional method calls can be chained together.

Parameters:
uploadId - the ID of the existing, initiated multipart upload with which this new part will be associated.
Returns:
This updated UploadPartRequest object.

getPartNumber

public int getPartNumber()
Returns the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

Returns:
the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

setPartNumber

public void setPartNumber(int partNumber)
Sets the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

Parameters:
partNumber - the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

withPartNumber

public UploadPartRequest withPartNumber(int partNumber)
Sets the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).

Returns this updated UploadPartRequest object so that additional method calls can be chained together.

Parameters:
partNumber - the part number describing this part's position relative to the other parts in the multipart upload. Part number must be between 1 and 10,000 (inclusive).
Returns:
This updated UploadPartRequest object.

getPartSize

public long getPartSize()
Returns the size of this part, in bytes.

Returns:
the size of this part, in bytes.

setPartSize

public void setPartSize(long partSize)
Sets the size of this part, in bytes.

Parameters:
partSize - the size of this part, in bytes.

withPartSize

public UploadPartRequest withPartSize(long partSize)
Sets the size of this part, in bytes, and returns this updated UploadPartRequest object so that additional method calls can be chained together.

Parameters:
partSize - the size of this part, in bytes.
Returns:
This updated UploadPartRequest object.

getMd5Digest

public java.lang.String getMd5Digest()
Returns the optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.

Returns:
The optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.

setMd5Digest

public void setMd5Digest(java.lang.String md5Digest)
Sets the optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.

Parameters:
md5Digest - The optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.

withMD5Digest

public UploadPartRequest withMD5Digest(java.lang.String md5Digest)
Sets the optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.

Returns this updated UploadPartRequest object so that additional method calls can be chained together.

Parameters:
md5Digest - The optional, but recommended, MD5 hash of the content of this part. If specified, this value will be sent to Amazon S3 to verify the data integrity when the data reaches Amazon S3.
Returns:
This updated UploadPartRequest object.

getFile

public java.io.File getFile()
Returns the file containing the data to upload. Exactly one File or InputStream must be specified as the input to this operation.

Returns:
The file containing the data to upload. Exactly one File or InputStream must be specified as the input to this operation.

setFile

public void setFile(java.io.File file)
Sets the file containing the data to upload. Exactly one File or InputStream must be specified as the input to this operation.

Parameters:
file - The file containing the data to upload. Exactly one File or InputStream must be specified as the input to this operation.

withFile

public UploadPartRequest withFile(java.io.File file)
Sets the file containing the data to upload, and returns this updated UploadPartRequest object so that additional method calls can be chained together.

Exactly one File or InputStream must be specified as the input to this operation.

Parameters:
file - The file containing the data to upload. Exactly one File or InputStream must be specified as the input to this operation.
Returns:
This updated UploadPartRequest object.

getFileOffset

public long getFileOffset()
Returns the optional offset in the specified file, at which to begin uploading data for this part. If not specified, data will be read from the beginning of the file.

Returns:
The optional offset in the specified file, at which to begin uploading data for this part. If not specified, data will be read from the beginning of the file.

setFileOffset

public void setFileOffset(long fileOffset)
Sets the optional offset in the specified file, at which to begin uploading data for this part. If not specified, data will be read from the beginning of the file.

Parameters:
fileOffset - The optional offset in the specified file, at which to begin uploading data for this part. If not specified, data will be read from the beginning of the file.

withFileOffset

public UploadPartRequest withFileOffset(long fileOffset)
Sets the optional offset in the specified file, at which to begin uploading data for this part, and returns this updated UploadPartRequest object so that additional method calls can be chained together.

If not specified, data will be read from the beginning of the file.

Parameters:
fileOffset - The optional offset in the specified file, at which to begin uploading data for this part. If not specified, data will be read from the beginning of the file.
Returns:
This updated UploadPartRequest object.

setProgressListener

@Deprecated
public void setProgressListener(ProgressListener progressListener)
Deprecated. use setGeneralProgressListener(ProgressListener) instead.

Sets the optional progress listener for receiving updates about object upload status.

Parameters:
progressListener - The legacy progress listener that is used exclusively for Amazon S3 client.

getProgressListener

@Deprecated
public ProgressListener getProgressListener()
Deprecated. use getGeneralProgressListener() instead.

Returns the optional progress listener for receiving updates about object upload status.

Returns:
the optional progress listener for receiving updates about object upload status.

withProgressListener

@Deprecated
public UploadPartRequest withProgressListener(ProgressListener progressListener)
Deprecated. use withGeneralProgressListener(ProgressListener) instead.

Sets the optional progress listener for receiving updates about object upload status, and returns this updated object so that additional method calls can be chained together.

Parameters:
progressListener - The legacy progress listener that is used exclusively for Amazon S3 client.
Returns:
This updated UploadPartRequest object.

isLastPart

public boolean isLastPart()
Returns true if the creator of this request has indicated this part is the last part being uploaded in a multipart upload.

Returns:
True if the creator of this request has indicated this part is the last part being uploaded in a multipart upload.

setLastPart

public void setLastPart(boolean isLastPart)
Marks this part as the last part being uploaded in a multipart upload.

Parameters:
isLastPart - Whether or not this is the last part being uploaded in a multipart upload.

withLastPart

public UploadPartRequest withLastPart(boolean isLastPart)
Marks this part as the last part being uploaded in a multipart upload, and returns this updated request object so that additional method calls can be chained together.

Parameters:
isLastPart - Whether or not this is the last part being uploaded in a multipart upload.
Returns:
This updated request object so that additional method calls can be chained together.

getSSECustomerKey

public SSECustomerKey getSSECustomerKey()
Returns the optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.

Returns:
The optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.

setSSECustomerKey

public void setSSECustomerKey(SSECustomerKey sseKey)
Sets the optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.

Parameters:
sseKey - The optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.

withSSECustomerKey

public UploadPartRequest withSSECustomerKey(SSECustomerKey sseKey)
Sets the optional customer-provided server-side encryption key to use to encrypt the object part being uploaded, and returns the updated request object so that additional method calls can be chained together.

Parameters:
sseKey - The optional customer-provided server-side encryption key to use to encrypt the object part being uploaded.
Returns:
This updated request object so that additional method calls can be chained together.

setGeneralProgressListener

public void setGeneralProgressListener(ProgressListener generalProgressListener)
Sets the optional progress listener for receiving updates about object download status.

Parameters:
generalProgressListener - The new progress listener.

getGeneralProgressListener

public ProgressListener getGeneralProgressListener()
Returns the optional progress listener for receiving updates about object download status.

Returns:
the optional progress listener for receiving updates about object download status.

withGeneralProgressListener

public UploadPartRequest withGeneralProgressListener(ProgressListener progressListener)
Sets the optional progress listener for receiving updates about object upload status, and returns this updated object so that additional method calls can be chained together.

Parameters:
generalProgressListener - The new progress listener.
Returns:
This updated UploadPartRequest object.
Overview  Package   Class  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2010 Amazon Web Services, Inc. All Rights Reserved.