Class PutObjectLegalHoldRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.s3.model.S3Request
-
- software.amazon.awssdk.services.s3.model.PutObjectLegalHoldRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutObjectLegalHoldRequest.Builder,PutObjectLegalHoldRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutObjectLegalHoldRequest extends S3Request implements ToCopyableBuilder<PutObjectLegalHoldRequest.Builder,PutObjectLegalHoldRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PutObjectLegalHoldRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
bucket()
The bucket name containing the object that you want to place a legal hold on.static PutObjectLegalHoldRequest.Builder
builder()
ChecksumAlgorithm
checksumAlgorithm()
Indicates the algorithm used to create the checksum for the object when you use the SDK.String
checksumAlgorithmAsString()
Indicates the algorithm used to create the checksum for the object when you use 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 place a legal hold on.ObjectLockLegalHold
legalHold()
Container element for the legal hold configuration you want to apply to the specified object.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 PutObjectLegalHoldRequest.Builder>
serializableBuilderClass()
PutObjectLegalHoldRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
versionId()
The version ID of the object that you want to place a legal hold on.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
bucket
public final String bucket()
The bucket name containing the object that you want to place a legal hold on.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
- Returns:
- The bucket name containing the object that you want to place a legal hold on.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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.
-
key
public final String key()
The key name for the object that you want to place a legal hold on.
- Returns:
- The key name for the object that you want to place a legal hold on.
-
legalHold
public final ObjectLockLegalHold legalHold()
Container element for the legal hold configuration you want to apply to the specified object.
- Returns:
- Container element for the legal hold configuration you want to apply to the specified object.
-
requestPayer
public final RequestPayer requestPayer()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
requestPayerAsString
public final String requestPayerAsString()
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
RequestPayer
-
versionId
public final String versionId()
The version ID of the object that you want to place a legal hold on.
- Returns:
- The version ID of the object that you want to place a legal hold on.
-
contentMD5
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.
- Returns:
- 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.
-
checksumAlgorithm
public final ChecksumAlgorithm 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.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- 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. - See Also:
ChecksumAlgorithm
-
checksumAlgorithmAsString
public final String checksumAlgorithmAsString()
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.If the service returns an enum value that is not available in the current SDK version,
checksumAlgorithm
will returnChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- Returns:
- 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. - See Also:
ChecksumAlgorithm
-
expectedBucketOwner
public final String 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).- Returns:
- 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).
-
toBuilder
public PutObjectLegalHoldRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutObjectLegalHoldRequest.Builder,PutObjectLegalHoldRequest>
- Specified by:
toBuilder
in classS3Request
-
builder
public static PutObjectLegalHoldRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutObjectLegalHoldRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-