Interface PutObjectLockConfigurationRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<PutObjectLockConfigurationRequest.Builder,
,PutObjectLockConfigurationRequest> S3Request.Builder
,SdkBuilder<PutObjectLockConfigurationRequest.Builder,
,PutObjectLockConfigurationRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutObjectLockConfigurationRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe bucket whose Object Lock configuration you want to create or replace.checksumAlgorithm
(String checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.checksumAlgorithm
(ChecksumAlgorithm checksumAlgorithm) Indicates the algorithm used to create the checksum for the object when you use the SDK.contentMD5
(String contentMD5) The MD5 hash for the request body.expectedBucketOwner
(String expectedBucketOwner) The account ID of the expected bucket owner.objectLockConfiguration
(Consumer<ObjectLockConfiguration.Builder> objectLockConfiguration) The Object Lock configuration that you want to apply to the specified bucket.objectLockConfiguration
(ObjectLockConfiguration objectLockConfiguration) The Object Lock configuration that you want to apply to the specified bucket.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.requestPayer
(String requestPayer) Sets the value of the RequestPayer property for this object.requestPayer
(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.A token to allow Object Lock to be enabled for an existing bucket.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, sdkFields
-
Method Details
-
bucket
The bucket whose Object Lock configuration you want to create or replace.
- Parameters:
bucket
- The bucket whose Object Lock configuration you want to create or replace.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectLockConfiguration
PutObjectLockConfigurationRequest.Builder objectLockConfiguration(ObjectLockConfiguration objectLockConfiguration) The Object Lock configuration that you want to apply to the specified bucket.
- Parameters:
objectLockConfiguration
- The Object Lock configuration that you want to apply to the specified bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectLockConfiguration
default PutObjectLockConfigurationRequest.Builder objectLockConfiguration(Consumer<ObjectLockConfiguration.Builder> objectLockConfiguration) The Object Lock configuration that you want to apply to the specified bucket.
This is a convenience method that creates an instance of theObjectLockConfiguration.Builder
avoiding the need to create one manually viaObjectLockConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toobjectLockConfiguration(ObjectLockConfiguration)
.- Parameters:
objectLockConfiguration
- a consumer that will call methods onObjectLockConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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:
-
token
A token to allow Object Lock to be enabled for an existing bucket.
- Parameters:
token
- A token to allow Object Lock to be enabled for an existing bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentMD5
The MD5 hash for the request body.
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 MD5 hash for the request body.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
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-checksum
orx-amz-trailer
header 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
ChecksumAlgorithm
parameter.- 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-checksum
orx-amz-trailer
header 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
ChecksumAlgorithm
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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-checksum
orx-amz-trailer
header 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
ChecksumAlgorithm
parameter.- 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-checksum
orx-amz-trailer
header 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
ChecksumAlgorithm
parameter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
PutObjectLockConfigurationRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
PutObjectLockConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-