public static interface PutObjectRetentionRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>
Modifier and Type | Method and Description |
---|---|
PutObjectRetentionRequest.Builder |
bucket(String bucket)
The bucket name that contains the object you want to apply this Object Retention configuration to.
|
PutObjectRetentionRequest.Builder |
bypassGovernanceRetention(Boolean bypassGovernanceRetention)
Indicates whether this action should bypass Governance-mode restrictions.
|
PutObjectRetentionRequest.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectRetentionRequest.Builder |
checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectRetentionRequest.Builder |
contentMD5(String contentMD5)
The MD5 hash for the request body.
|
PutObjectRetentionRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
PutObjectRetentionRequest.Builder |
key(String key)
The key name for the object that you want to apply this Object Retention configuration to.
|
PutObjectRetentionRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutObjectRetentionRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutObjectRetentionRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectRetentionRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
default PutObjectRetentionRequest.Builder |
retention(Consumer<ObjectLockRetention.Builder> retention)
The container element for the Object Retention configuration.
|
PutObjectRetentionRequest.Builder |
retention(ObjectLockRetention retention)
The container element for the Object Retention configuration.
|
PutObjectRetentionRequest.Builder |
versionId(String versionId)
The version ID for the object that you want to apply this Object Retention configuration to.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutObjectRetentionRequest.Builder bucket(String bucket)
The bucket name that contains the object you want to apply this Object Retention configuration to.
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 you want to apply this Object Retention configuration to.
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.
PutObjectRetentionRequest.Builder key(String key)
The key name for the object that you want to apply this Object Retention configuration to.
key
- The key name for the object that you want to apply this Object Retention configuration to.PutObjectRetentionRequest.Builder retention(ObjectLockRetention retention)
The container element for the Object Retention configuration.
retention
- The container element for the Object Retention configuration.default PutObjectRetentionRequest.Builder retention(Consumer<ObjectLockRetention.Builder> retention)
The container element for the Object Retention configuration.
This is a convenience method that creates an instance of theObjectLockRetention.Builder
avoiding the
need to create one manually via ObjectLockRetention.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to retention(ObjectLockRetention)
.
retention
- a consumer that will call methods on ObjectLockRetention.Builder
retention(ObjectLockRetention)
PutObjectRetentionRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectRetentionRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectRetentionRequest.Builder versionId(String versionId)
The version ID for the object that you want to apply this Object Retention configuration to.
versionId
- The version ID for the object that you want to apply this Object Retention configuration to.PutObjectRetentionRequest.Builder bypassGovernanceRetention(Boolean bypassGovernanceRetention)
Indicates whether this action should bypass Governance-mode restrictions.
bypassGovernanceRetention
- Indicates whether this action should bypass Governance-mode restrictions.PutObjectRetentionRequest.Builder contentMD5(String 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.
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.
PutObjectRetentionRequest.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
PutObjectRetentionRequest.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
PutObjectRetentionRequest.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).PutObjectRetentionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutObjectRetentionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2022. All rights reserved.