public static interface PutObjectRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
Modifier and Type | Method and Description |
---|---|
PutObjectRequest.Builder |
acl(ObjectCannedACL acl)
The canned ACL to apply to the object.
|
PutObjectRequest.Builder |
acl(String acl)
The canned ACL to apply to the object.
|
PutObjectRequest.Builder |
bucket(String bucket)
Bucket name to which the PUT operation was initiated.
|
PutObjectRequest.Builder |
cacheControl(String cacheControl)
Can be used to specify caching behavior along the request/reply chain.
|
PutObjectRequest.Builder |
contentDisposition(String contentDisposition)
Specifies presentational information for the object.
|
PutObjectRequest.Builder |
contentEncoding(String contentEncoding)
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be
applied to obtain the media-type referenced by the Content-Type header field.
|
PutObjectRequest.Builder |
contentLanguage(String contentLanguage)
The language the content is in.
|
PutObjectRequest.Builder |
contentLength(Long contentLength)
Size of the body in bytes.
|
PutObjectRequest.Builder |
contentMD5(String contentMD5)
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864.
|
PutObjectRequest.Builder |
contentType(String contentType)
A standard MIME type describing the format of the contents.
|
PutObjectRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account id of the expected bucket owner.
|
PutObjectRequest.Builder |
expires(Instant expires)
The date and time at which the object is no longer cacheable.
|
PutObjectRequest.Builder |
grantFullControl(String grantFullControl)
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
|
PutObjectRequest.Builder |
grantRead(String grantRead)
Allows grantee to read the object data and its metadata.
|
PutObjectRequest.Builder |
grantReadACP(String grantReadACP)
Allows grantee to read the object ACL.
|
PutObjectRequest.Builder |
grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable object.
|
PutObjectRequest.Builder |
key(String key)
Object key for which the PUT operation was initiated.
|
PutObjectRequest.Builder |
metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
|
PutObjectRequest.Builder |
objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object.
|
PutObjectRequest.Builder |
objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object.
|
PutObjectRequest.Builder |
objectLockMode(ObjectLockMode objectLockMode)
The Object Lock mode that you want to apply to this object.
|
PutObjectRequest.Builder |
objectLockMode(String objectLockMode)
The Object Lock mode that you want to apply to this object.
|
PutObjectRequest.Builder |
objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when you want this object's Object Lock to expire.
|
PutObjectRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutObjectRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutObjectRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectRequest.Builder |
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).
|
PutObjectRequest.Builder |
serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).
|
PutObjectRequest.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
PutObjectRequest.Builder |
sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
PutObjectRequest.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
PutObjectRequest.Builder |
ssekmsEncryptionContext(String ssekmsEncryptionContext)
Specifies the AWS KMS Encryption Context to use for object encryption.
|
PutObjectRequest.Builder |
ssekmsKeyId(String ssekmsKeyId)
If
x-amz-server-side-encryption is present and has the value of aws:kms , this
header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer
master key (CMK) that was used for the object. |
PutObjectRequest.Builder |
storageClass(StorageClass storageClass)
If you don't specify, S3 Standard is the default storage class.
|
PutObjectRequest.Builder |
storageClass(String storageClass)
If you don't specify, S3 Standard is the default storage class.
|
PutObjectRequest.Builder |
tagging(String tagging)
The tag-set for the object.
|
PutObjectRequest.Builder |
tagging(Tagging tagging) |
PutObjectRequest.Builder |
websiteRedirectLocation(String websiteRedirectLocation)
If the bucket is configured as a website, redirects requests for this object to another object in the same
bucket or to an external URL.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutObjectRequest.Builder acl(String acl)
The canned ACL to apply to the object. For more information, see Canned ACL.
acl
- The canned ACL to apply to the object. For more information, see Canned ACL.ObjectCannedACL
,
ObjectCannedACL
PutObjectRequest.Builder acl(ObjectCannedACL acl)
The canned ACL to apply to the object. For more information, see Canned ACL.
acl
- The canned ACL to apply to the object. For more information, see Canned ACL.ObjectCannedACL
,
ObjectCannedACL
PutObjectRequest.Builder bucket(String bucket)
Bucket name to which the PUT operation was initiated.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
bucket
- Bucket name to which the PUT operation was initiated.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
PutObjectRequest.Builder cacheControl(String cacheControl)
Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
cacheControl
- Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616
/rfc2616-sec14.html#sec14.9.PutObjectRequest.Builder contentDisposition(String contentDisposition)
Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
contentDisposition
- Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.PutObjectRequest.Builder contentEncoding(String contentEncoding)
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/ rfc2616-sec14.html#sec14.11.
contentEncoding
- Specifies what content encodings have been applied to the object and thus what decoding mechanisms
must be applied to obtain the media-type referenced by the Content-Type header field. For more
information, see http://www.w3
.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.PutObjectRequest.Builder contentLanguage(String contentLanguage)
The language the content is in.
contentLanguage
- The language the content is in.PutObjectRequest.Builder contentLength(Long contentLength)
Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
contentLength
- Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.PutObjectRequest.Builder contentMD5(String contentMD5)
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
contentMD5
- The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This
header can be used as a message integrity check to verify that the data is the same data that was
originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an
end-to-end integrity check. For more information about REST request authentication, see REST
Authentication.PutObjectRequest.Builder contentType(String contentType)
A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
contentType
- A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.PutObjectRequest.Builder expires(Instant expires)
The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
expires
- The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.PutObjectRequest.Builder grantFullControl(String grantFullControl)
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
grantFullControl
- Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.PutObjectRequest.Builder grantRead(String grantRead)
Allows grantee to read the object data and its metadata.
grantRead
- Allows grantee to read the object data and its metadata.PutObjectRequest.Builder grantReadACP(String grantReadACP)
Allows grantee to read the object ACL.
grantReadACP
- Allows grantee to read the object ACL.PutObjectRequest.Builder grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable object.
grantWriteACP
- Allows grantee to write the ACL for the applicable object.PutObjectRequest.Builder key(String key)
Object key for which the PUT operation was initiated.
key
- Object key for which the PUT operation was initiated.PutObjectRequest.Builder metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
metadata
- A map of metadata to store with the object in S3.PutObjectRequest.Builder serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).ServerSideEncryption
,
ServerSideEncryption
PutObjectRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).ServerSideEncryption
,
ServerSideEncryption
PutObjectRequest.Builder storageClass(String storageClass)
If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.
storageClass
- If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage
classes.StorageClass
,
StorageClass
PutObjectRequest.Builder storageClass(StorageClass storageClass)
If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.
storageClass
- If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage
classes.StorageClass
,
StorageClass
PutObjectRequest.Builder websiteRedirectLocation(String websiteRedirectLocation)
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
websiteRedirectLocation
- If the bucket is configured as a website, redirects requests for this object to another object in the
same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
For information about object metadata, see Object Key and
Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
PutObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
sseCustomerAlgorithm
- Specifies the algorithm to use to when encrypting the object (for example, AES256).PutObjectRequest.Builder sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to
store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.
sseCustomerKey
- Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is
used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The
key must be appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.PutObjectRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
sseCustomerKeyMD5
- Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this
header for a message integrity check to ensure that the encryption key was transmitted without error.PutObjectRequest.Builder ssekmsKeyId(String ssekmsKeyId)
If x-amz-server-side-encryption
is present and has the value of aws:kms
, this
header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed customer
master key (CMK) that was used for the object.
If the value of x-amz-server-side-encryption
is aws:kms
, this header specifies the
ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify
x-amz-server-side-encryption:aws:kms
, but do not provide
x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS to
protect the data.
ssekmsKeyId
- If x-amz-server-side-encryption
is present and has the value of aws:kms
,
this header specifies the ID of the AWS Key Management Service (AWS KMS) symmetrical customer managed
customer master key (CMK) that was used for the object.
If the value of x-amz-server-side-encryption
is aws:kms
, this header
specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If
you specify x-amz-server-side-encryption:aws:kms
, but do not provide
x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS
to protect the data.
PutObjectRequest.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)
Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
ssekmsEncryptionContext
- Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a
base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.PutObjectRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectRequest.Builder tagging(String tagging)
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
tagging
- The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example,
"Key1=Value1")PutObjectRequest.Builder tagging(Tagging tagging)
PutObjectRequest.Builder objectLockMode(String objectLockMode)
The Object Lock mode that you want to apply to this object.
objectLockMode
- The Object Lock mode that you want to apply to this object.ObjectLockMode
,
ObjectLockMode
PutObjectRequest.Builder objectLockMode(ObjectLockMode objectLockMode)
The Object Lock mode that you want to apply to this object.
objectLockMode
- The Object Lock mode that you want to apply to this object.ObjectLockMode
,
ObjectLockMode
PutObjectRequest.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when you want this object's Object Lock to expire.
objectLockRetainUntilDate
- The date and time when you want this object's Object Lock to expire.PutObjectRequest.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
objectLockLegalHoldStatus
- Specifies whether a legal hold will be applied to this object. For more information about S3 Object
Lock, see Object Lock.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
PutObjectRequest.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
objectLockLegalHoldStatus
- Specifies whether a legal hold will be applied to this object. For more information about S3 Object
Lock, see Object Lock.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
PutObjectRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will
fail with an HTTP 403 (Access Denied)
error.
expectedBucketOwner
- The account id of the expected bucket owner. If the bucket is owned by a different account, the
request will fail with an HTTP 403 (Access Denied)
error.PutObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2020. All rights reserved.