public class PutObjectRequest extends AbstractPutObjectRequest implements java.io.Serializable
Uploads a new object to the specified Amazon S3 bucket. The PutObjectRequest optionally uploads object metadata and applies a canned access control policy to the new object.
Amazon S3 never stores partial objects; if during this call an exception wasn't thrown, the entire object was stored.
Depending on whether a file or input stream is being uploaded, this request has slightly different behavior.
When uploading a file:
When uploading directly from an input stream, content length must be specified before data can be uploaded to Amazon S3. If not provided, the library will have to buffer the contents of the input stream in order to calculate it. Amazon S3 explicitly requires that the content length be sent in the request headers before any of the data is sent.
Amazon S3 is a distributed system. If Amazon S3 receives multiple write requests for the same object nearly simultaneously, all of the objects might be stored. However, only one object will obtain the key.
Note: Amazon S3 does not provide object locking; if this is needed, make sure to build it into the application layer.
If the caller specifies a location constraint when creating a bucket, all objects added to the bucket are stored in the same region as the bucket. For example, if specifying a Europe (EU) region constraint for a bucket, all of that bucket's objects are stored in the EU region.
The specified bucket must already exist and the caller must have
Permission.Write permission to the bucket to upload an object.
If you are uploading or accessing KMS-encrypted objects, you need to specify the correct region of the bucket on your client and configure AWS Signature Version 4 for added security. For more information on how to do this, see http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify -signature-version
S3DataSource.Utils| Constructor and Description |
|---|
PutObjectRequest(java.lang.String bucketName,
java.lang.String key,
java.io.File file)
Constructs a new
PutObjectRequest object to upload a file to the
specified bucket and key. |
PutObjectRequest(java.lang.String bucketName,
java.lang.String key,
java.io.InputStream input,
ObjectMetadata metadata)
Constructs a new
PutObjectRequest object to upload a stream of data to
the specified bucket and key. |
PutObjectRequest(java.lang.String bucketName,
java.lang.String key,
java.lang.String redirectLocation)
Constructs a new
PutObjectRequest object to perform a redirect for the
specified bucket and key. |
| Modifier and Type | Method and Description |
|---|---|
PutObjectRequest |
clone()
Returns a clone (as deep as possible) of this request object.
|
boolean |
isRequesterPays()
Returns true if the user has enabled Requester Pays option when
conducting this operation from Requester Pays Bucket; else false.
|
void |
setRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
PutObjectRequest |
withAccessControlList(AccessControlList accessControlList)
Sets the optional access control list for the new object.
|
PutObjectRequest |
withBucketName(java.lang.String bucketName)
Sets the name of the bucket where this request will upload a new object
to.
|
PutObjectRequest |
withCannedAcl(CannedAccessControlList cannedAcl)
Sets the optional pre-configured access control policy to use for the new
object.
|
PutObjectRequest |
withFile(java.io.File file)
Sets the file containing the data to be uploaded to Amazon S3.
|
PutObjectRequest |
withGeneralProgressListener(ProgressListener generalProgressListener)
Sets the optional progress listener for receiving updates about the progress of the request,
and returns a reference to this object so that method calls can be chained together.
|
PutObjectRequest |
withInputStream(java.io.InputStream inputStream)
Sets the input stream containing the data to be uploaded to Amazon S3.
|
PutObjectRequest |
withKey(java.lang.String key)
Sets the key under which to store the new object.
|
PutObjectRequest |
withMetadata(ObjectMetadata metadata)
Sets the optional metadata instructing Amazon S3 how to handle the
uploaded data (e.g.
|
PutObjectRequest |
withProgressListener(ProgressListener progressListener)
Deprecated.
|
PutObjectRequest |
withRedirectLocation(java.lang.String redirectLocation)
Sets the optional redirect location for the new object.Returns this
AbstractPutObjectRequest, enabling additional method calls to be
chained together. |
PutObjectRequest |
withRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
PutObjectRequest |
withSSEAwsKeyManagementParams(SSEAwsKeyManagementParams sseAwsKeyManagementParams)
Sets the AWS Key Management System parameters used to encrypt the object
on server side.
|
PutObjectRequest |
withSSECustomerKey(SSECustomerKey sseKey)
Sets the optional customer-provided server-side encryption key to use to
encrypt the uploaded object, and returns the updated request object so
that additional method calls can be chained together.
|
PutObjectRequest |
withStorageClass(StorageClass storageClass)
Sets the optional Amazon S3 storage class to use when storing the new
object.
|
PutObjectRequest |
withStorageClass(java.lang.String storageClass)
Sets the optional Amazon S3 storage class to use when storing the new
object.
|
PutObjectRequest |
withTagging(ObjectTagging tagSet)
Sets tagging for this request.
|
getAccessControlList, getBucketName, getCannedAcl, getFile, getInputStream, getKey, getMetadata, getProgressListener, getRedirectLocation, getSSEAwsKeyManagementParams, getSSECustomerKey, getStorageClass, getTagging, setAccessControlList, setBucketName, setCannedAcl, setFile, setInputStream, setKey, setMetadata, setProgressListener, setRedirectLocation, setSSEAwsKeyManagementParams, setSSECustomerKey, setStorageClass, setStorageClass, setTagginggetCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollectorpublic PutObjectRequest(java.lang.String bucketName,
java.lang.String key,
java.io.File file)
PutObjectRequest object to upload a file to the
specified bucket and key. After constructing the request,
users may optionally specify object metadata or a canned ACL as well.bucketName - The name of an existing bucket to which the new object will be
uploaded.key - The key under which to store the new object.file - The path of the file to upload to Amazon S3.public PutObjectRequest(java.lang.String bucketName,
java.lang.String key,
java.lang.String redirectLocation)
PutObjectRequest object to perform a redirect for the
specified bucket and key. After constructing the request,
users may optionally specify object metadata or a canned ACL as well.
The redirect is performed using the
Headers.REDIRECT_LOCATION header.
bucketName - The name of an existing bucket to which the new object will be
uploaded.key - The key under which to store the new object.redirectLocation - Sets the Headers.REDIRECT_LOCATION
header for the new object.public PutObjectRequest(java.lang.String bucketName,
java.lang.String key,
java.io.InputStream input,
ObjectMetadata metadata)
PutObjectRequest object to upload a stream of data to
the specified bucket and key. After constructing the request,
users may optionally specify object metadata or a canned ACL as well.
Content length for the data stream must be specified in the object metadata parameter; Amazon S3 requires it be passed in before the data is uploaded. Failure to specify a content length will cause the entire contents of the input stream to be buffered locally in memory so that the content length can be calculated, which can result in negative performance problems.
bucketName - The name of an existing bucket to which the new object will be
uploaded.key - The key under which to store the new object.input - The stream of data to upload to Amazon S3.metadata - The object metadata. At minimum this specifies the
content length for the stream of data being uploaded.public PutObjectRequest clone()
clone in class AbstractPutObjectRequestjava.lang.CloneNotSupportedExceptionObject.clone()public PutObjectRequest withBucketName(java.lang.String bucketName)
AbstractPutObjectRequest
In order to upload the object, users must have Permission.Write
permission granted.
withBucketName in class AbstractPutObjectRequestbucketName - The name of an existing bucket where this request will
upload a new object to. In order to upload the object, users
must have Permission.Write permission granted.AbstractPutObjectRequest, enabling additional method
calls to be chained together.AbstractPutObjectRequest.getBucketName(),
AbstractPutObjectRequest.setBucketName(String)public PutObjectRequest withKey(java.lang.String key)
AbstractPutObjectRequestwithKey in class AbstractPutObjectRequestkey - The key under which to store the new object.AbstractPutObjectRequest, enabling additional method
calls to be chained together.AbstractPutObjectRequest.getKey(),
AbstractPutObjectRequest.setKey(String)public PutObjectRequest withStorageClass(java.lang.String storageClass)
AbstractPutObjectRequestAbstractPutObjectRequest, enabling
additional method calls to be chained together. If not specified, the
default standard storage class will be used when storing the object.
For more information on Amazon S3 storage classes and available values,
see the StorageClass enumeration.
withStorageClass in class AbstractPutObjectRequeststorageClass - The storage class to use when storing the new object.AbstractPutObjectRequest, enabling additional method
calls to be chained together.AbstractPutObjectRequest.getStorageClass(),
AbstractPutObjectRequest.setStorageClass(StorageClass),
AbstractPutObjectRequest.setStorageClass(String),
AbstractPutObjectRequest.withStorageClass(StorageClass)public PutObjectRequest withStorageClass(StorageClass storageClass)
AbstractPutObjectRequestAbstractPutObjectRequest, enabling
additional method calls to be chained together. If not specified, the
default standard storage class will be used when storing the object.
For more information on Amazon S3 storage classes and available values,
see the StorageClass enumeration.
withStorageClass in class AbstractPutObjectRequeststorageClass - The storage class to use when storing the new object.AbstractPutObjectRequest, enabling additional method
calls to be chained together.AbstractPutObjectRequest.getStorageClass(),
AbstractPutObjectRequest.setStorageClass(StorageClass),
AbstractPutObjectRequest.setStorageClass(String),
AbstractPutObjectRequest.withStorageClass(String)public PutObjectRequest withFile(java.io.File file)
AbstractPutObjectRequestAbstractPutObjectRequest, enabling additional method calls
to be chained together.
Either specify a file or an input stream containing the data to be uploaded to Amazon S3; both cannot be specified.
withFile in class AbstractPutObjectRequestfile - The file containing the data to be uploaded to Amazon S3.AbstractPutObjectRequest, enabling additional method
calls to be chained together.AbstractPutObjectRequest.getFile(),
AbstractPutObjectRequest.setFile(File),
AbstractPutObjectRequest.getInputStream(),
AbstractPutObjectRequest.setInputStream(InputStream)public PutObjectRequest withMetadata(ObjectMetadata metadata)
AbstractPutObjectRequestAbstractPutObjectRequest, enabling
additional method calls to be chained together.
If uploading from an input stream, always specify metadata with the content size set. Otherwise the contents of the input stream have to be buffered in memory before being sent to Amazon S3. This can cause very negative performance impacts.
withMetadata in class AbstractPutObjectRequestmetadata - The optional metadata instructing Amazon S3 how to handle
the uploaded data (e.g. custom user metadata, hooks for
specifying content type, etc.).AbstractPutObjectRequest, enabling additional method
calls to be chained together.AbstractPutObjectRequest.getMetadata(),
AbstractPutObjectRequest.setMetadata(ObjectMetadata)public PutObjectRequest withCannedAcl(CannedAccessControlList cannedAcl)
AbstractPutObjectRequestAbstractPutObjectRequest, enabling
additional method calls to be chained together.withCannedAcl in class AbstractPutObjectRequestcannedAcl - The optional pre-configured access control policy to use
for the new object.AbstractPutObjectRequest, enabling additional method
calls to be chained together.AbstractPutObjectRequest.getCannedAcl(),
AbstractPutObjectRequest.setCannedAcl(CannedAccessControlList)public PutObjectRequest withAccessControlList(AccessControlList accessControlList)
AbstractPutObjectRequestAbstractPutObjectRequest,
enabling additional method calls to be chained together.withAccessControlList in class AbstractPutObjectRequestaccessControlList - The access control list for the new object.public PutObjectRequest withInputStream(java.io.InputStream inputStream)
AbstractPutObjectRequestAbstractPutObjectRequest, enabling additional method
calls to be chained together.
Either specify a file or an input stream containing the data to be uploaded to Amazon S3; both cannot be specified.
withInputStream in class AbstractPutObjectRequestinputStream - The InputStream containing the data to be uploaded to
Amazon S3.AbstractPutObjectRequest.getInputStream(),
AbstractPutObjectRequest.setInputStream(InputStream),
AbstractPutObjectRequest.getFile(),
AbstractPutObjectRequest.setFile(File)public PutObjectRequest withRedirectLocation(java.lang.String redirectLocation)
AbstractPutObjectRequestAbstractPutObjectRequest, enabling additional method calls to be
chained together.withRedirectLocation in class AbstractPutObjectRequestredirectLocation - The redirect location for the new object.public PutObjectRequest withSSECustomerKey(SSECustomerKey sseKey)
AbstractPutObjectRequestwithSSECustomerKey in class AbstractPutObjectRequestsseKey - The optional customer-provided server-side encryption key
to use to encrypt the uploaded object.public PutObjectRequest withTagging(ObjectTagging tagSet)
AbstractPutObjectRequestwithTagging in class AbstractPutObjectRequesttagSet - Object tagging to be attached to this request@Deprecated public PutObjectRequest withProgressListener(ProgressListener progressListener)
AbstractPutObjectRequestwithProgressListener in class AbstractPutObjectRequestprogressListener - The legacy progress listener that is used
exclusively for Amazon S3 client.public PutObjectRequest withSSEAwsKeyManagementParams(SSEAwsKeyManagementParams sseAwsKeyManagementParams)
AbstractPutObjectRequestwithSSEAwsKeyManagementParams in class AbstractPutObjectRequestpublic PutObjectRequest withGeneralProgressListener(ProgressListener generalProgressListener)
AmazonWebServiceRequestwithGeneralProgressListener in class AmazonWebServiceRequestgeneralProgressListener - The new progress listener.public boolean isRequesterPays()
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket
public void setRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket.
isRequesterPays - Enable Requester Pays option for the operation.public PutObjectRequest withRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket.
isRequesterPays - Enable Requester Pays option for the operation.Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.