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

Class ListLegalHoldsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListLegalHoldsRequest.Builder,ListLegalHoldsRequest>

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

Request object containing all the options for listing legal holds associated with a specific object in a Cloud Object Storage (COS) bucket.

This class allows users to specify the bucket name and object key to filter the legal holds to be listed. It also supports specifying an optional WORM (Write Once Read Many) mirror destination, which is applicable when mirroring is enabled on the bucket.

Instances of this class are immutable and can be created or modified using the provided ListLegalHoldsRequest.Builder.

See Also:

ListLegalHoldsRequest.Builder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListLegalHoldsRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	bucket() Returns the name of the bucket which contains the specified object.
static ListLegalHoldsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<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() Returns the name of the object to perform the list against.
List<SdkField<?>>	sdkFields()
static Class<? extends ListLegalHoldsRequest.Builder>	serializableBuilderClass()
ListLegalHoldsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	wormMirrorDestination() Returns the optional mirror-destination value for WORM mirroring

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

Method Detail

toBuilder

public ListLegalHoldsRequest.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<ListLegalHoldsRequest.Builder,ListLegalHoldsRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static ListLegalHoldsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListLegalHoldsRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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.

bucket

public String bucket()

Returns the name of the bucket which contains the specified object.

Returns:

The name of the bucket which contains the specified object.

key

public String key()

Returns the name of the object to perform the list against.

Returns:

The name of the object to perform the list against.

wormMirrorDestination

public String wormMirrorDestination()

Returns the optional mirror-destination value for WORM mirroring

Returns:

The optional mirror-destination value