Interface PutObjectAclRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>,S3Request.Builder,SdkBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- PutObjectAclRequest
@Mutable @NotThreadSafe public static interface PutObjectAclRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectAclRequest.Builder,PutObjectAclRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default PutObjectAclRequest.BuilderaccessControlPolicy(Consumer<AccessControlPolicy.Builder> accessControlPolicy)Contains the elements that set the ACL permissions for an object per grantee.PutObjectAclRequest.BuilderaccessControlPolicy(AccessControlPolicy accessControlPolicy)Contains the elements that set the ACL permissions for an object per grantee.PutObjectAclRequest.Builderacl(String acl)The canned ACL to apply to the object.PutObjectAclRequest.Builderacl(ObjectCannedACL acl)The canned ACL to apply to the object.PutObjectAclRequest.Builderbucket(String bucket)The bucket name that contains the object to which you want to attach the ACL.PutObjectAclRequest.BuilderchecksumAlgorithm(String checksumAlgorithm)Indicates the algorithm used to create the checksum for the object when you use the SDK.PutObjectAclRequest.BuilderchecksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)Indicates the algorithm used to create the checksum for the object when you use the SDK.PutObjectAclRequest.BuildercontentMD5(String contentMD5)The Base64 encoded 128-bitMD5digest of the data.PutObjectAclRequest.BuilderexpectedBucketOwner(String expectedBucketOwner)The account ID of the expected bucket owner.PutObjectAclRequest.BuildergrantFullControl(String grantFullControl)Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.PutObjectAclRequest.BuildergrantRead(String grantRead)Allows grantee to list the objects in the bucket.PutObjectAclRequest.BuildergrantReadACP(String grantReadACP)Allows grantee to read the bucket ACL.PutObjectAclRequest.BuildergrantWrite(String grantWrite)Allows grantee to create new objects in the bucket.PutObjectAclRequest.BuildergrantWriteACP(String grantWriteACP)Allows grantee to write the ACL for the applicable bucket.PutObjectAclRequest.Builderkey(String key)Key for which the PUT action was initiated.PutObjectAclRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)PutObjectAclRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)PutObjectAclRequest.BuilderrequestPayer(String requestPayer)Sets the value of the RequestPayer property for this object.PutObjectAclRequest.BuilderrequestPayer(RequestPayer requestPayer)Sets the value of the RequestPayer property for this object.PutObjectAclRequest.BuilderversionId(String versionId)Version ID used to reference a specific version of the object.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
acl
PutObjectAclRequest.Builder acl(String acl)
The canned ACL to apply to the object. For more information, see Canned ACL.
- Parameters:
acl- The canned ACL to apply to the object. For more information, see Canned ACL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ObjectCannedACL,ObjectCannedACL
-
acl
PutObjectAclRequest.Builder acl(ObjectCannedACL acl)
The canned ACL to apply to the object. For more information, see Canned ACL.
- Parameters:
acl- The canned ACL to apply to the object. For more information, see Canned ACL.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ObjectCannedACL,ObjectCannedACL
-
accessControlPolicy
PutObjectAclRequest.Builder accessControlPolicy(AccessControlPolicy accessControlPolicy)
Contains the elements that set the ACL permissions for an object per grantee.
- Parameters:
accessControlPolicy- Contains the elements that set the ACL permissions for an object per grantee.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessControlPolicy
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.Builderavoiding the need to create one manually viaAccessControlPolicy.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toaccessControlPolicy(AccessControlPolicy).- Parameters:
accessControlPolicy- a consumer that will call methods onAccessControlPolicy.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
accessControlPolicy(AccessControlPolicy)
-
bucket
PutObjectAclRequest.Builder bucket(String bucket)
The bucket name that contains the object to which you want to attach the ACL.
Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.- Parameters:
bucket- The bucket name that contains the object to which you want to attach the ACL.Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.
S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentMD5
PutObjectAclRequest.Builder contentMD5(String contentMD5)
The Base64 encoded 128-bit
MD5digest 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.
- Parameters:
contentMD5- The Base64 encoded 128-bitMD5digest 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumAlgorithm
PutObjectAclRequest.Builder checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.- Parameters:
checksumAlgorithm- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a correspondingx-amz-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChecksumAlgorithm,ChecksumAlgorithm
-
checksumAlgorithm
PutObjectAclRequest.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding
x-amz-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.- Parameters:
checksumAlgorithm- Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a correspondingx-amz-checksumorx-amz-trailerheader sent. Otherwise, Amazon S3 fails the request with the HTTP status code400 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
ChecksumAlgorithmparameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ChecksumAlgorithm,ChecksumAlgorithm
-
grantFullControl
PutObjectAclRequest.Builder grantFullControl(String grantFullControl)
Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
This functionality is not supported for Amazon S3 on Outposts.
- Parameters:
grantFullControl- Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantRead
PutObjectAclRequest.Builder grantRead(String grantRead)
Allows grantee to list the objects in the bucket.
This functionality is not supported for Amazon S3 on Outposts.
- Parameters:
grantRead- Allows grantee to list the objects in the bucket.This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantReadACP
PutObjectAclRequest.Builder grantReadACP(String grantReadACP)
Allows grantee to read the bucket ACL.
This functionality is not supported for Amazon S3 on Outposts.
- Parameters:
grantReadACP- Allows grantee to read the bucket ACL.This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantWrite
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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantWriteACP
PutObjectAclRequest.Builder grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable bucket.
This functionality is not supported for Amazon S3 on Outposts.
- Parameters:
grantWriteACP- Allows grantee to write the ACL for the applicable bucket.This functionality is not supported for Amazon S3 on Outposts.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
key
PutObjectAclRequest.Builder key(String key)
Key for which the PUT action was initiated.
- Parameters:
key- Key for which the PUT action was initiated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestPayer
PutObjectAclRequest.Builder requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.- Parameters:
requestPayer- The new value for the RequestPayer property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestPayer,RequestPayer
-
requestPayer
PutObjectAclRequest.Builder requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.- Parameters:
requestPayer- The new value for the RequestPayer property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestPayer,RequestPayer
-
versionId
PutObjectAclRequest.Builder versionId(String versionId)
Version ID used to reference a specific version of the object.
This functionality is not supported for directory buckets.
- Parameters:
versionId- Version ID used to reference a specific version of the object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expectedBucketOwner
PutObjectAclRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code
403 Forbidden(access denied).- Parameters:
expectedBucketOwner- The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code403 Forbidden(access denied).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
PutObjectAclRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
PutObjectAclRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-