public static interface PutObjectAclRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
Modifier and Type | Method and Description |
---|---|
PutObjectAclRequest.Builder |
accessControlPolicy(AccessControlPolicy accessControlPolicy)
Contains the elements that set the ACL permissions for an object per grantee.
|
default PutObjectAclRequest.Builder |
accessControlPolicy(Consumer<AccessControlPolicy.Builder> accessControlPolicy)
Contains the elements that set the ACL permissions for an object per grantee.
|
PutObjectAclRequest.Builder |
acl(ObjectCannedACL acl)
The canned ACL to apply to the object.
|
PutObjectAclRequest.Builder |
acl(String acl)
The canned ACL to apply to the object.
|
PutObjectAclRequest.Builder |
bucket(String bucket)
The bucket name that contains the object to which you want to attach the ACL.
|
PutObjectAclRequest.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectAclRequest.Builder |
checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectAclRequest.Builder |
contentMD5(String contentMD5)
The base64-encoded 128-bit MD5 digest of the data.
|
PutObjectAclRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
PutObjectAclRequest.Builder |
grantFullControl(String grantFullControl)
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
|
PutObjectAclRequest.Builder |
grantRead(String grantRead)
Allows grantee to list the objects in the bucket.
|
PutObjectAclRequest.Builder |
grantReadACP(String grantReadACP)
Allows grantee to read the bucket ACL.
|
PutObjectAclRequest.Builder |
grantWrite(String grantWrite)
Allows grantee to create new objects in the bucket.
|
PutObjectAclRequest.Builder |
grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable bucket.
|
PutObjectAclRequest.Builder |
key(String key)
Key for which the PUT action was initiated.
|
PutObjectAclRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutObjectAclRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutObjectAclRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectAclRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectAclRequest.Builder |
versionId(String versionId)
VersionId used to reference a specific version of the object.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutObjectAclRequest.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
PutObjectAclRequest.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
PutObjectAclRequest.Builder accessControlPolicy(AccessControlPolicy accessControlPolicy)
Contains the elements that set the ACL permissions for an object per grantee.
accessControlPolicy
- Contains the elements that set the ACL permissions for an object per grantee.default PutObjectAclRequest.Builder accessControlPolicy(Consumer<AccessControlPolicy.Builder> accessControlPolicy)
Contains the elements that set the ACL permissions for an object per grantee.
This is a convenience method that creates an instance of theAccessControlPolicy.Builder
avoiding the
need to create one manually via AccessControlPolicy.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to accessControlPolicy(AccessControlPolicy)
.
accessControlPolicy
- a consumer that will call methods on AccessControlPolicy.Builder
accessControlPolicy(AccessControlPolicy)
PutObjectAclRequest.Builder bucket(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.
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.
PutObjectAclRequest.Builder contentMD5(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.
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.
PutObjectAclRequest.Builder checksumAlgorithm(String 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.
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.
ChecksumAlgorithm
,
ChecksumAlgorithm
PutObjectAclRequest.Builder checksumAlgorithm(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.
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.
ChecksumAlgorithm
,
ChecksumAlgorithm
PutObjectAclRequest.Builder grantFullControl(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.
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.
PutObjectAclRequest.Builder grantRead(String grantRead)
Allows grantee to list the objects in the bucket.
This action is not supported by Amazon S3 on Outposts.
grantRead
- Allows grantee to list the objects in the bucket.
This action is not supported by Amazon S3 on Outposts.
PutObjectAclRequest.Builder grantReadACP(String grantReadACP)
Allows grantee to read the bucket ACL.
This action is not supported by Amazon S3 on Outposts.
grantReadACP
- Allows grantee to read the bucket ACL.
This action is not supported by Amazon S3 on Outposts.
PutObjectAclRequest.Builder grantWrite(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.
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.
PutObjectAclRequest.Builder grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable bucket.
This action is not supported by Amazon S3 on Outposts.
grantWriteACP
- Allows grantee to write the ACL for the applicable bucket.
This action is not supported by Amazon S3 on Outposts.
PutObjectAclRequest.Builder key(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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in
the Amazon S3 User Guide.
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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
see What is S3 on
Outposts in the Amazon S3 User Guide.
PutObjectAclRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectAclRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectAclRequest.Builder versionId(String versionId)
VersionId used to reference a specific version of the object.
versionId
- VersionId used to reference a specific version of the object.PutObjectAclRequest.Builder expectedBucketOwner(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).
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).PutObjectAclRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutObjectAclRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.