com.ibm.cos.v2.services.s3.model

Class PutObjectRetentionRequest

java.lang.Object

com.ibm.cos.v2.core.SdkRequest

com.ibm.cos.v2.awscore.AwsRequest

com.ibm.cos.v2.services.s3.model.S3Request

com.ibm.cos.v2.services.s3.model.PutObjectRetentionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>

@Generated(value="com.ibm.cos.v2:codegen")
public final class PutObjectRetentionRequest
extends S3Request
implements ToCopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutObjectRetentionRequest.Builder

Method Summary

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 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 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.
Map<String,SdkField<?>>	sdkFieldNameToField()
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.

Methods inherited from class com.ibm.cos.v2.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

copy

Method Detail

bucket

public final String bucket()

The bucket name that contains the object you want to apply this Object Retention configuration to.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 that contains the object you want to apply this Object Retention configuration to.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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 apply this Object Retention configuration to.

Returns:

The key name for the object that you want to apply this Object Retention configuration to.

retention

public final ObjectLockRetention retention()

The container element for the Object Retention configuration.

Returns:

The container element for the Object Retention configuration.

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 return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

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 return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().

Returns:

The value of the RequestPayer property for this object.

See Also:

RequestPayer

versionId

public final String versionId()

The version ID for the object that you want to apply this Object Retention configuration to.

Returns:

The version ID for the object that you want to apply this Object Retention configuration to.

bypassGovernanceRetention

public final Boolean bypassGovernanceRetention()

Indicates whether this action should bypass Governance-mode restrictions.

Returns:

Indicates whether this action should bypass Governance-mode restrictions.

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 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().

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 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.

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 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().

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 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.

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 PutObjectRetentionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutObjectRetentionRequest.Builder,PutObjectRetentionRequest>

Specified by:

toBuilder in class S3Request

builder

public static PutObjectRetentionRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutObjectRetentionRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo