com.amazonaws.services.s3.model

Class UploadObjectRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.AbstractPutObjectRequest

com.amazonaws.services.s3.model.UploadObjectRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, MaterialsDescriptionProvider, S3DataSource, SSEAwsKeyManagementParamsProvider, SSECustomerKeyProvider, Serializable, Cloneable

public class UploadObjectRequest
extends AbstractPutObjectRequest
implements MaterialsDescriptionProvider, Serializable

Used to request the client-side encryption and upload of a large S3 object via pipelined parallel multi-part uploads.

See Also:

AmazonS3EncryptionClient.uploadObject(UploadObjectRequest), Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.amazonaws.services.s3.model.S3DataSource

S3DataSource.Utils

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UploadObjectRequest(String bucketName, String key, File file)
UploadObjectRequest(String bucketName, String key, InputStream input, ObjectMetadata metadata)

Method Summary

Modifier and Type	Method and Description
UploadObjectRequest	clone() Returns a clone (as deep as possible) of this request object.
long	getDiskLimit() Returns the maximum size (in bytes) of additional disk space that will be consumed for this request; or Long.MAX_VALUE if there is no limit.
ExecutorService	getExecutorService() Returns a custom executor service for concurrent uploads; or null there is no customization.
Map<String,String>	getMaterialsDescription() Returns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from any EncryptionMaterialsAccessor
MultiFileOutputStream	getMultiFileOutputStream() Returns a custom multi-file output stream; or null if the default is to be used.
long	getPartSize() Returns the part-size used for muti-part upload for this request.
UploadObjectObserver	getUploadObjectObserver() Returns a custom upload-object observer; or null there is no customization.
ObjectMetadata	getUploadPartMetadata() Gets the optional metadata to be included in each UploadPart request.
void	setMaterialsDescription(Map<String,String> materialsDescription) Sets the materials description for the encryption materials to be used with the current request.
void	setUploadPartMetadata(ObjectMetadata partUploadMetadata) Sets the optional metadata to be included in each UploadPart request.
UploadObjectRequest	withDiskLimit(long diskLimit) Configured the maximum disk space (in bytes) that will be consumed for this request.
UploadObjectRequest	withExecutorService(ExecutorService executorService) Configure a custom executor service for concurrent uploads.
UploadObjectRequest	withMaterialsDescription(Map<String,String> materialsDescription) Fluent API for setMaterialsDescription(Map).
UploadObjectRequest	withMultiFileOutputStream(MultiFileOutputStream multiFileOutputStream) Configure a custom multi-file output stream; or null if the default is to be used.
UploadObjectRequest	withPartSize(long partSize) Configured the part size for multi-part upload.
UploadObjectRequest	withUploadObjectObserver(UploadObjectObserver uploadObjectObserver) Configure a custom upload-object observer; or null if the default is to be used.
<T extends UploadObjectRequest> T	withUploadPartMetadata(ObjectMetadata partUploadMetadata) Fluent API for setUploadPartMetadata(ObjectMetadata).

Methods inherited from class com.amazonaws.services.s3.model.AbstractPutObjectRequest

copyPutObjectBaseTo, getAccessControlList, getBucketName, getCannedAcl, getFile, getInputStream, getKey, getMetadata, getObjectLockLegalHoldStatus, getObjectLockMode, getObjectLockRetainUntilDate, getProgressListener, getRedirectLocation, getSSEAwsKeyManagementParams, getSSECustomerKey, getStorageClass, getTagging, setAccessControlList, setBucketName, setCannedAcl, setFile, setInputStream, setKey, setMetadata, setObjectLockLegalHoldStatus, setObjectLockLegalHoldStatus, setObjectLockMode, setObjectLockMode, setObjectLockRetainUntilDate, setProgressListener, setRedirectLocation, setSSEAwsKeyManagementParams, setSSECustomerKey, setStorageClass, setStorageClass, setTagging, withAccessControlList, withBucketName, withCannedAcl, withFile, withInputStream, withKey, withMetadata, withObjectLockLegalHoldStatus, withObjectLockLegalHoldStatus, withObjectLockMode, withObjectLockMode, withObjectLockRetainUntilDate, withProgressListener, withRedirectLocation, withSSEAwsKeyManagementParams, withSSECustomerKey, withStorageClass, withStorageClass, withTagging

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UploadObjectRequest

public UploadObjectRequest(String bucketName,
                           String key,
                           File file)

UploadObjectRequest

public UploadObjectRequest(String bucketName,
                           String key,
                           InputStream input,
                           ObjectMetadata metadata)

Method Detail

getPartSize

public long getPartSize()

Returns the part-size used for muti-part upload for this request. This part size will be used as a reference for the multi-part uploads but the physical part size may vary.

withPartSize

public UploadObjectRequest withPartSize(long partSize)

Configured the part size for multi-part upload. Must be at least MIN_PART_SIZE. This part size will be used as a reference for the multi-part uploads but the physical part size may vary.

Returns:

this object for method chaining purposes

getDiskLimit

public long getDiskLimit()

Returns the maximum size (in bytes) of additional disk space that will be consumed for this request; or Long.MAX_VALUE if there is no limit.

withDiskLimit

public UploadObjectRequest withDiskLimit(long diskLimit)

Configured the maximum disk space (in bytes) that will be consumed for this request. The maximum disk space must be at least twice the size of partSize.

Returns:

this object for method chaining purposes

getExecutorService

public ExecutorService getExecutorService()

Returns a custom executor service for concurrent uploads; or null there is no customization.

withExecutorService

public UploadObjectRequest withExecutorService(ExecutorService executorService)

Configure a custom executor service for concurrent uploads.

Returns:

this object for method chaining purposes

getMultiFileOutputStream

public MultiFileOutputStream getMultiFileOutputStream()

Returns a custom multi-file output stream; or null if the default is to be used.

withMultiFileOutputStream

public UploadObjectRequest withMultiFileOutputStream(MultiFileOutputStream multiFileOutputStream)

Configure a custom multi-file output stream; or null if the default is to be used.

Returns:

this object for method chaining purposes

getUploadObjectObserver

public UploadObjectObserver getUploadObjectObserver()

Returns a custom upload-object observer; or null there is no customization.

withUploadObjectObserver

public UploadObjectRequest withUploadObjectObserver(UploadObjectObserver uploadObjectObserver)

Configure a custom upload-object observer; or null if the default is to be used.

Returns:

this object for method chaining purposes

getMaterialsDescription

public Map<String,String> getMaterialsDescription()

Description copied from interface: MaterialsDescriptionProvider

Returns an unmodifiable view of the MaterialsDescription which the caller can use to load EncryptionMaterials from any EncryptionMaterialsAccessor

Specified by:

getMaterialsDescription in interface MaterialsDescriptionProvider

Returns:

materials description.

setMaterialsDescription

public void setMaterialsDescription(Map<String,String> materialsDescription)

Sets the materials description for the encryption materials to be used with the current request.

Parameters:

materialsDescription - the materialsDescription to set

withMaterialsDescription

public UploadObjectRequest withMaterialsDescription(Map<String,String> materialsDescription)

Fluent API for setMaterialsDescription(Map).

getUploadPartMetadata

public ObjectMetadata getUploadPartMetadata()

Gets the optional metadata to be included in each UploadPart request.

setUploadPartMetadata

public void setUploadPartMetadata(ObjectMetadata partUploadMetadata)

Sets the optional metadata to be included in each UploadPart request.

withUploadPartMetadata

public <T extends UploadObjectRequest> T withUploadPartMetadata(ObjectMetadata partUploadMetadata)

Fluent API for setUploadPartMetadata(ObjectMetadata).

clone

public UploadObjectRequest clone()

Returns a clone (as deep as possible) of this request object.

Overrides:

clone in class AbstractPutObjectRequest