@Generated(value="software.amazon.awssdk:codegen") public final class PutObjectRequest extends S3Request implements ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutObjectRequest.Builder |
Modifier and Type | Method and Description |
---|---|
ObjectCannedACL |
acl()
The canned ACL to apply to the object.
|
String |
aclAsString()
The canned ACL to apply to the object.
|
String |
bucket()
Bucket name to which the PUT operation was initiated.
|
static PutObjectRequest.Builder |
builder() |
String |
cacheControl()
Can be used to specify caching behavior along the request/reply chain.
|
String |
contentDisposition()
Specifies presentational information for the object.
|
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.
|
String |
contentLanguage()
The language the content is in.
|
Long |
contentLength()
Size of the body in bytes.
|
String |
contentMD5()
The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864.
|
String |
contentType()
A standard MIME type describing the format of the contents.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account id of the expected bucket owner.
|
Instant |
expires()
The date and time at which the object is no longer cacheable.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
|
String |
grantRead()
Allows grantee to read the object data and its metadata.
|
String |
grantReadACP()
Allows grantee to read the object ACL.
|
String |
grantWriteACP()
Allows grantee to write the ACL for the applicable object.
|
int |
hashCode() |
boolean |
hasMetadata()
Returns true if the Metadata property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
String |
key()
Object key for which the PUT operation was initiated.
|
Map<String,String> |
metadata()
A map of metadata to store with the object in S3.
|
ObjectLockLegalHoldStatus |
objectLockLegalHoldStatus()
Specifies whether a legal hold will be applied to this object.
|
String |
objectLockLegalHoldStatusAsString()
Specifies whether a legal hold will be applied to this object.
|
ObjectLockMode |
objectLockMode()
The Object Lock mode that you want to apply to this object.
|
String |
objectLockModeAsString()
The Object Lock mode that you want to apply to this object.
|
Instant |
objectLockRetainUntilDate()
The date and time when you want this object's Object Lock to expire.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutObjectRequest.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
|
String |
serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
|
String |
sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
String |
sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
String |
sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
String |
ssekmsEncryptionContext()
Specifies the AWS KMS Encryption Context to use for object encryption.
|
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. |
StorageClass |
storageClass()
If you don't specify, S3 Standard is the default storage class.
|
String |
storageClassAsString()
If you don't specify, S3 Standard is the default storage class.
|
String |
tagging()
The tag-set for the object.
|
PutObjectRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
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.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public ObjectCannedACL acl()
The canned ACL to apply to the object. For more information, see Canned ACL.
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclAsString()
.
ObjectCannedACL
public String aclAsString()
The canned ACL to apply to the object. For more information, see Canned ACL.
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclAsString()
.
ObjectCannedACL
public 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.
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.
public 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.
public String contentDisposition()
Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
public 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.
public String contentLanguage()
The language the content is in.
public 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.
public 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.
public 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.
public 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.
public String grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
public String grantRead()
Allows grantee to read the object data and its metadata.
public String grantReadACP()
Allows grantee to read the object ACL.
public String grantWriteACP()
Allows grantee to write the ACL for the applicable object.
public String key()
Object key for which the PUT operation was initiated.
public boolean hasMetadata()
public Map<String,String> metadata()
A map of metadata to store with the object in S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasMetadata()
to see if a value was sent in this field.
public ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
ServerSideEncryption
public String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
ServerSideEncryption
public StorageClass storageClass()
If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
StorageClass
public String storageClassAsString()
If you don't specify, S3 Standard is the default storage class. Amazon S3 supports other storage classes.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
StorageClass
public 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.
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.
public String sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
public 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.
x-amz-server-side-encryption-customer-algorithm
header.public 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.
public 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.
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.
public 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.
public RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public String requestPayerAsString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public String tagging()
The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
public ObjectLockMode objectLockMode()
The Object Lock mode that you want to apply to this object.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public String objectLockModeAsString()
The Object Lock mode that you want to apply to this object.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public Instant objectLockRetainUntilDate()
The date and time when you want this object's Object Lock to expire.
public ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
public String objectLockLegalHoldStatusAsString()
Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
public 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.
403 (Access Denied)
error.public PutObjectRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutObjectRequest.Builder,PutObjectRequest>
toBuilder
in class S3Request
public static PutObjectRequest.Builder builder()
public static Class<? extends PutObjectRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsRequest
public boolean equals(Object obj)
equals
in class AwsRequest
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2020. All rights reserved.