com.amazonaws.services.s3.model
Class InitiateMultipartUploadRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.s3.model.InitiateMultipartUploadRequest

public class InitiateMultipartUploadRequest
extends AmazonWebServiceRequest

The InitiateMultipartUploadRequest contains the parameters used for the InitiateMultipartUpload method.

Required Parameters: BucketName, Key

See Also:

AmazonS3.initiateMultipartUpload(InitiateMultipartUploadRequest)

Field Summary

ObjectMetadata

objectMetadata Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

Constructor Summary

InitiateMultipartUploadRequest(String bucketName, String key)
Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key.

InitiateMultipartUploadRequest(String bucketName, String key, ObjectMetadata objectMetadata)
Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key, and with the additional specified object metadata.

Method Summary

AccessControlList	getAccessControlList() Returns the optional access control list for the new upload.
String	getBucketName() Returns the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
CannedAccessControlList	getCannedACL() Returns the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
String	getKey() Returns the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
ObjectMetadata	getObjectMetadata() Returns the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
StorageClass	getStorageClass() Returns the optional storage class to use when storing this upload's data in S3.
void	setAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new upload.
void	setBucketName(String bucketName) Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
void	setCannedACL(CannedAccessControlList cannedACL) Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
void	setKey(String key) Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
void	setObjectMetadata(ObjectMetadata objectMetadata) Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
void	setStorageClass(StorageClass storageClass) Sets the optional storage class to use when storing this upload's data in S3.
InitiateMultipartUploadRequest	withAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new upload.
InitiateMultipartUploadRequest	withBucketName(String bucketName) Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.
InitiateMultipartUploadRequest	withCannedACL(CannedAccessControlList acl) Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.
InitiateMultipartUploadRequest	withKey(String key) Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.
InitiateMultipartUploadRequest	withObjectMetadata(ObjectMetadata objectMetadata) Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.
InitiateMultipartUploadRequest	withStorageClass(StorageClass storageClass) Sets the optional storage class to use when storing this upload's data in S3.

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

Field Detail

objectMetadata

public ObjectMetadata objectMetadata

Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

Constructor Detail

InitiateMultipartUploadRequest

public InitiateMultipartUploadRequest(String bucketName,
                                      String key)

Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key.

Parameters:

bucketName - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

key - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

InitiateMultipartUploadRequest

public InitiateMultipartUploadRequest(String bucketName,
                                      String key,
                                      ObjectMetadata objectMetadata)

Constructs a request to initiate a new multipart upload in the specified bucket, stored by the specified key, and with the additional specified object metadata.

Parameters:

bucketName - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

key - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

objectMetadata - Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

Returns:

The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

Parameters:

bucketName - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

withBucketName

public InitiateMultipartUploadRequest withBucketName(String bucketName)

Sets the name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

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

Parameters:

bucketName - The name of the bucket in which to create the new multipart upload, and hence, the eventual object created from the multipart upload.

Returns:

This updated InitiateMultipartUploadRequest object.

getKey

public String getKey()

Returns the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

Returns:

The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

setKey

public void setKey(String key)

Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

Parameters:

key - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

withKey

public InitiateMultipartUploadRequest withKey(String key)

Sets the key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

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

Parameters:

key - The key by which to store the new multipart upload, and hence, the eventual object created from the multipart upload.

Returns:

This updated InitiateMultipartUploadRequest object.

getCannedACL

public CannedAccessControlList getCannedACL()

Returns the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

Returns:

The optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

See Also:

CannedAccessControlList

setCannedACL

public void setCannedACL(CannedAccessControlList cannedACL)

Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

Parameters:

cannedACL - The canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

See Also:

CannedAccessControlList

withCannedACL

public InitiateMultipartUploadRequest withCannedACL(CannedAccessControlList acl)

Sets the optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

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

Parameters:

acl - The optional canned Access Control List (ACL) to set permissions for the new object created when the multipart upload is completed.

Returns:

This updated InitiateMultipartUploadRequest object.

getAccessControlList

public AccessControlList getAccessControlList()

Returns the optional access control list for the new upload. If specified, cannedAcl will be ignored.

setAccessControlList

public void setAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new upload. If specified, cannedAcl will be ignored.

Parameters:

accessControlList - The access control list for the new upload.

withAccessControlList

public InitiateMultipartUploadRequest withAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new upload. If specified, cannedAcl will be ignored. Returns this InitiateMultipartUploadRequest, enabling additional method calls to be chained together.

Parameters:

accessControlList - The access control list for the new upload.

getStorageClass

public StorageClass getStorageClass()

Returns the optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

If not specified, the default is StorageClass.Standard.

Returns:

The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

See Also:

StorageClass

setStorageClass

public void setStorageClass(StorageClass storageClass)

Sets the optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

If not specified, the default is StorageClass.Standard.

Parameters:

storageClass - The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

See Also:

StorageClass

withStorageClass

public InitiateMultipartUploadRequest withStorageClass(StorageClass storageClass)

Sets the optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

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

Parameters:

storageClass - The optional storage class to use when storing this upload's data in S3. If not specified, the default storage class is used.

Returns:

This updated InitiateMultipartUploadRequest object.

getObjectMetadata

public ObjectMetadata getObjectMetadata()

Returns the additional information about the new object being created, such as content type, content encoding, user metadata, etc.

Returns:

The additional information about the new object being created, such as content type, content encoding, user metadata, etc.

setObjectMetadata

public void setObjectMetadata(ObjectMetadata objectMetadata)

Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.

Parameters:

objectMetadata - Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

withObjectMetadata

public InitiateMultipartUploadRequest withObjectMetadata(ObjectMetadata objectMetadata)

Sets the additional information about the new object being created, such as content type, content encoding, user metadata, etc.

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

Parameters:

objectMetadata - Additional information about the new object being created, such as content type, content encoding, user metadata, etc.

Returns:

This updated InitiateMultipartUploadRequest object.