@Generated(value="software.amazon.awssdk:codegen") public final class PutObjectRetentionRequest extends S3Request implements ToCopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutObjectRetentionRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The bucket name that contains the object you want to apply this Object Retention configuration to.
|
static PutObjectRetentionRequest.Builder |
builder() |
Boolean |
bypassGovernanceRetention()
Indicates whether this action should bypass Governance-mode restrictions.
|
ChecksumAlgorithm |
checksumAlgorithm()
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
String |
checksumAlgorithmAsString()
Indicates the algorithm used to create the checksum for the object when using the SDK.
|
String |
contentMD5()
The MD5 hash for the request body.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
key()
The key name for the object that you want to apply this Object Retention configuration to.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
ObjectLockRetention |
retention()
The container element for the Object Retention configuration.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutObjectRetentionRequest.Builder> |
serializableBuilderClass() |
PutObjectRetentionRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
The version ID for the object that you want to apply this Object Retention configuration to.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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.
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.
public final String key()
The key name for the object that you want to apply this Object Retention configuration to.
public final ObjectLockRetention retention()
The container element for the Object Retention configuration.
public final RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String requestPayerAsString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String versionId()
The version ID for the object that you want to apply this Object Retention configuration to.
public final Boolean bypassGovernanceRetention()
Indicates whether this action should bypass Governance-mode restrictions.
public final 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.
For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
public final 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.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
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
public final String checksumAlgorithmAsString()
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.
If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm
will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from checksumAlgorithmAsString()
.
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
public final 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).
403 Forbidden
(access denied).public PutObjectRetentionRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>
toBuilder
in class S3Request
public static PutObjectRetentionRequest.Builder builder()
public static Class<? extends PutObjectRetentionRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.