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

Class AddLegalHoldRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AddLegalHoldRequest.Builder,AddLegalHoldRequest>

public class AddLegalHoldRequest
extends S3Request
implements SdkPojo, ToCopyableBuilder<AddLegalHoldRequest.Builder,AddLegalHoldRequest>

Request object representing the parameters required to add a legal hold on an object in IBM Cloud Object Storage.

A legal hold prevents the object from being modified or deleted until explicitly released. This model wraps bucket, key, and optional legal hold identifier metadata.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AddLegalHoldRequest.Builder Builder for constructing AddLegalHoldRequest objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AddLegalHoldRequest(com.ibm.cos.v2.services.s3.model.AddLegalHoldRequest.BuilderImpl builder) Constructs an immutable request instance based on the builder.

Method Summary

Modifier and Type	Method and Description
String	bucket()
static AddLegalHoldRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	key()
String	legalHoldId()
List<SdkField<?>>	sdkFields() Returns SdkField metadata describing this request.
static Class<? extends AddLegalHoldRequest.Builder>	serializableBuilderClass()
AddLegalHoldRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

sdkFieldNameToField

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

copy

Constructor Detail

AddLegalHoldRequest

protected AddLegalHoldRequest(com.ibm.cos.v2.services.s3.model.AddLegalHoldRequest.BuilderImpl builder)

Constructs an immutable request instance based on the builder.

Method Detail

bucket

public String bucket()

Returns:

bucket name

key

public String key()

Returns:

object key

legalHoldId

public String legalHoldId()

Returns:

legal hold ID

toBuilder

public AddLegalHoldRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AddLegalHoldRequest.Builder,AddLegalHoldRequest>

Specified by:

toBuilder in class S3Request

builder

public static AddLegalHoldRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AddLegalHoldRequest.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 List<SdkField<?>> sdkFields()

Returns SdkField metadata describing this request. Used internally for (un)marshalling.

Specified by:

sdkFields in interface SdkPojo