software.amazon.awssdk.services.s3.model

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(value="software.amazon.awssdk:codegen")
public final class PutObjectLegalHoldRequest
extends S3Request
implements ToCopyableBuilder<PutObjectLegalHoldRequest.Builder,PutObjectLegalHoldRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutObjectLegalHoldRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() The bucket containing the object that you want to place a Legal Hold on.
static PutObjectLegalHoldRequest.Builder	builder()
String	contentMD5() The MD5 signature for the configuration included in your request.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

bucket

public String bucket()

The bucket containing the object that you want to place a Legal Hold on.

Returns:

The bucket containing the object that you want to place a Legal Hold on.

key

public 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 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 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 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 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 String contentMD5()

The MD5 signature for the configuration included in your request.

Returns:

The MD5 signature for the configuration included in your request.

toBuilder

public PutObjectLegalHoldRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutObjectLegalHoldRequest.Builder,PutObjectLegalHoldRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static PutObjectLegalHoldRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.