Package software.amazon.awssdk.services.opensearchserverless.model

Class CollectionSummary

java.lang.Object

software.amazon.awssdk.services.opensearchserverless.model.CollectionSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CollectionSummary.Builder,CollectionSummary>

@Generated("software.amazon.awssdk:codegen")
public final class CollectionSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CollectionSummary.Builder,CollectionSummary>

Details about each OpenSearch Serverless collection.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CollectionSummary.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the collection.
static CollectionSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The unique identifier of the collection.
String	name()	The name of the collection.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CollectionSummary.Builder>	serializableBuilderClass()
CollectionStatus	status()	The current status of the collection.
String	statusAsString()	The current status of the collection.
CollectionSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

arn

public final String arn()

The Amazon Resource Name (ARN) of the collection.

Returns:

The Amazon Resource Name (ARN) of the collection.

id

public final String id()

The unique identifier of the collection.

Returns:

The unique identifier of the collection.

name

public final String name()

The name of the collection.

Returns:

The name of the collection.

status

public final CollectionStatus status()

The current status of the collection.

If the service returns an enum value that is not available in the current SDK version, status will return CollectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the collection.

See Also:

CollectionStatus

statusAsString

public final String statusAsString()

The current status of the collection.

If the service returns an enum value that is not available in the current SDK version, status will return CollectionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current status of the collection.

See Also:

CollectionStatus

toBuilder

public CollectionSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CollectionSummary.Builder,CollectionSummary>

builder

public static CollectionSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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