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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutObjectLockConfigurationRequest.Builder,PutObjectLockConfigurationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutObjectLockConfigurationRequest
extends S3Request
implements ToCopyableBuilder<PutObjectLockConfigurationRequest.Builder,PutObjectLockConfigurationRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PutObjectLockConfigurationRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	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 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()`
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.

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 whose Object Lock configuration you want to create or replace.
    
    Returns:
    
    The bucket whose Object Lock configuration you want to create or replace.
  - objectLockConfiguration
```
public final ObjectLockConfiguration objectLockConfiguration()
```
    The Object Lock configuration that you want to apply to the specified bucket.
    
    Returns:
    
    The Object Lock configuration that you want to apply to the specified bucket.
  - 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
  - token
```
public final String token()
```
    A token to allow Object Lock to be enabled for an existing bucket.
    
    Returns:
    
    A token to allow Object Lock to be enabled for an existing bucket.
  - 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 PutObjectLockConfigurationRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutObjectLockConfigurationRequest.Builder,PutObjectLockConfigurationRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static PutObjectLockConfigurationRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutObjectLockConfigurationRequest.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

Class PutObjectLockConfigurationRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

bucket

objectLockConfiguration

requestPayer

requestPayerAsString

token

contentMD5

checksumAlgorithm

checksumAlgorithmAsString

expectedBucketOwner

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField