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

Class ListLegalHoldsResponse

java.lang.Object

com.ibm.cos.v2.core.SdkResponse

com.ibm.cos.v2.awscore.AwsResponse

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

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListLegalHoldsResponse.Builder,ListLegalHoldsResponse>

public class ListLegalHoldsResponse
extends S3Response
implements ToCopyableBuilder<ListLegalHoldsResponse.Builder,ListLegalHoldsResponse>

Response object returned from S3Client.listLegalHolds(ListLegalHoldsRequest) operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListLegalHoldsResponse.Builder

Constructor Summary

Constructors

Constructor and Description
ListLegalHoldsResponse(com.ibm.cos.v2.services.s3.model.ListLegalHoldsResponse.BuilderImpl builder) Constructs a new ListLegalHoldsResponse object and initializes all required and optional object fields.

Method Summary

Modifier and Type	Method and Description
static ListLegalHoldsResponse.Builder	builder()
Instant	createTime() Gets creation time for the object/
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 SdkResponse.
int	hashCode()
List<LegalHold>	legalHolds() Gets the list of legal holds for the object.
Instant	retentionExpirationDate() Gets the retention expiration date for the object.
long	retentionPeriod() Gets the retention period for the object.
List<SdkField<?>>	sdkFields()
ListLegalHoldsResponse.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.

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response

responseMetadata

Methods inherited from class com.ibm.cos.v2.core.SdkResponse

sdkHttpResponse

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

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

sdkFieldNameToField

Constructor Detail

ListLegalHoldsResponse

public ListLegalHoldsResponse(com.ibm.cos.v2.services.s3.model.ListLegalHoldsResponse.BuilderImpl builder)

Constructs a new ListLegalHoldsResponse object and initializes all required and optional object fields.

Method Detail

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.

createTime

public Instant createTime()

Gets creation time for the object/

Returns:

Creation time for the object

legalHolds

public List<LegalHold> legalHolds()

Gets the list of legal holds for the object.

retentionPeriod

public long retentionPeriod()

Gets the retention period for the object.

Returns:

the object's retention period

retentionExpirationDate

public Instant retentionExpirationDate()

Gets the retention expiration date for the object.

Returns:

The object's retention expiration date

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static ListLegalHoldsResponse.Builder builder()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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