@Generated(value="software.amazon.awssdk:codegen") public final class PutObjectLockConfigurationRequest extends S3Request implements ToCopyableBuilder<PutObjectLockConfigurationRequest.Builder,PutObjectLockConfigurationRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
PutObjectLockConfigurationRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The bucket whose Object Lock configuration you want to create or replace.
|
static PutObjectLockConfigurationRequest.Builder |
builder() |
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() |
ObjectLockConfiguration |
objectLockConfiguration()
The Object Lock configuration that you want to apply to the specified bucket.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends PutObjectLockConfigurationRequest.Builder> |
serializableBuilderClass() |
PutObjectLockConfigurationRequest.Builder |
toBuilder() |
String |
token()
A token to allow Object Lock to be enabled for an existing bucket.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String bucket()
The bucket whose Object Lock configuration you want to create or replace.
public final ObjectLockConfiguration objectLockConfiguration()
The Object Lock configuration that you want to apply to the specified bucket.
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 token()
A token to allow Object Lock to be enabled for an existing bucket.
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 PutObjectLockConfigurationRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<PutObjectLockConfigurationRequest.Builder,PutObjectLockConfigurationRequest>
toBuilder
in class S3Request
public static PutObjectLockConfigurationRequest.Builder builder()
public static Class<? extends PutObjectLockConfigurationRequest.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.