@Generated(value="software.amazon.awssdk:codegen") public final class PutObjectAclRequest extends S3Request implements ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutObjectAclRequest.Builder |
Modifier and Type | Method and Description |
---|---|
AccessControlPolicy |
accessControlPolicy()
Contains the elements that set the ACL permissions for an object per grantee.
|
ObjectCannedACL |
acl()
The canned ACL to apply to the object.
|
String |
aclAsString()
The canned ACL to apply to the object.
|
String |
bucket()
The bucket name that contains the object to which you want to attach the ACL.
|
static PutObjectAclRequest.Builder |
builder() |
ChecksumAlgorithm |
checksumAlgorithm()
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
String |
checksumAlgorithmAsString()
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
String |
contentMD5()
The base64-encoded 128-bit MD5 digest of the data.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
grantFullControl()
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
|
String |
grantRead()
Allows grantee to list the objects in the bucket.
|
String |
grantReadACP()
Allows grantee to read the bucket ACL.
|
String |
grantWrite()
Allows grantee to create new objects in the bucket.
|
String |
grantWriteACP()
Allows grantee to write the ACL for the applicable bucket.
|
int |
hashCode() |
String |
key()
Key for which the PUT action was initiated.
|
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 PutObjectAclRequest.Builder> |
serializableBuilderClass() |
PutObjectAclRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
VersionId used to reference a specific version of the object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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 final 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 final AccessControlPolicy accessControlPolicy()
Contains the elements that set the ACL permissions for an object per grantee.
public final String bucket()
The bucket name that contains the object to which you want to attach the ACL.
When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
public final String contentMD5()
The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
public final ChecksumAlgorithm checksumAlgorithm()
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails
the request with the HTTP status code 400 Bad Request
. For more information, see Checking object
integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
ChecksumAlgorithm
public final String checksumAlgorithmAsString()
Indicates the algorithm used to create the checksum for the object when using the SDK. This header will not
provide any additional functionality if not using the SDK. When sending this header, there must be a
corresponding x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3 fails
the request with the HTTP status code 400 Bad Request
. For more information, see Checking object
integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
x-amz-checksum
or x-amz-trailer
header sent. Otherwise, Amazon S3
fails the request with the HTTP status code 400 Bad Request
. For more information, see Checking
object integrity in the Amazon S3 User Guide.
If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm
parameter.
ChecksumAlgorithm
public final String grantFullControl()
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantRead()
Allows grantee to list the objects in the bucket.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantReadACP()
Allows grantee to read the bucket ACL.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String grantWrite()
Allows grantee to create new objects in the bucket.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.
public final String grantWriteACP()
Allows grantee to write the ACL for the applicable bucket.
This action is not supported by Amazon S3 on Outposts.
This action is not supported by Amazon S3 on Outposts.
public final String key()
Key for which the PUT action was initiated.
When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The
S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
.
When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket
ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in
the Amazon S3 User Guide.
When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
When using this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
public final 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 final 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 final String versionId()
VersionId used to reference a specific version of the object.
public final String expectedBucketOwner()
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
403 Forbidden
(access denied).public PutObjectAclRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
toBuilder
in class S3Request
public static PutObjectAclRequest.Builder builder()
public static Class<? extends PutObjectAclRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.