public static interface PutObjectLegalHoldRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<PutObjectLegalHoldRequest.Builder,PutObjectLegalHoldRequest>
Modifier and Type | Method and Description |
---|---|
PutObjectLegalHoldRequest.Builder |
bucket(String bucket)
The bucket name containing the object that you want to place a legal hold on.
|
PutObjectLegalHoldRequest.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectLegalHoldRequest.Builder |
checksumAlgorithm(String checksumAlgorithm)
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
PutObjectLegalHoldRequest.Builder |
contentMD5(String contentMD5)
The MD5 hash for the request body.
|
PutObjectLegalHoldRequest.Builder |
expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
PutObjectLegalHoldRequest.Builder |
key(String key)
The key name for the object that you want to place a legal hold on.
|
default PutObjectLegalHoldRequest.Builder |
legalHold(Consumer<ObjectLockLegalHold.Builder> legalHold)
Container element for the legal hold configuration you want to apply to the specified object.
|
PutObjectLegalHoldRequest.Builder |
legalHold(ObjectLockLegalHold legalHold)
Container element for the legal hold configuration you want to apply to the specified object.
|
PutObjectLegalHoldRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutObjectLegalHoldRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutObjectLegalHoldRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectLegalHoldRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
PutObjectLegalHoldRequest.Builder |
versionId(String versionId)
The version ID of the object that you want to place a legal hold on.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutObjectLegalHoldRequest.Builder bucket(String bucket)
The bucket name containing the object that you want to place a legal hold on.
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 containing the object that you want to place a legal hold on.
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.
PutObjectLegalHoldRequest.Builder key(String key)
The key name for the object that you want to place a legal hold on.
key
- The key name for the object that you want to place a legal hold on.PutObjectLegalHoldRequest.Builder legalHold(ObjectLockLegalHold legalHold)
Container element for the legal hold configuration you want to apply to the specified object.
legalHold
- Container element for the legal hold configuration you want to apply to the specified object.default PutObjectLegalHoldRequest.Builder legalHold(Consumer<ObjectLockLegalHold.Builder> legalHold)
Container element for the legal hold configuration you want to apply to the specified object.
This is a convenience method that creates an instance of theObjectLockLegalHold.Builder
avoiding the
need to create one manually via ObjectLockLegalHold.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to legalHold(ObjectLockLegalHold)
.
legalHold
- a consumer that will call methods on ObjectLockLegalHold.Builder
legalHold(ObjectLockLegalHold)
PutObjectLegalHoldRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectLegalHoldRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
PutObjectLegalHoldRequest.Builder versionId(String versionId)
The version ID of the object that you want to place a legal hold on.
versionId
- The version ID of the object that you want to place a legal hold on.PutObjectLegalHoldRequest.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.
PutObjectLegalHoldRequest.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
PutObjectLegalHoldRequest.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
PutObjectLegalHoldRequest.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).PutObjectLegalHoldRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutObjectLegalHoldRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.