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

Class CollectionDetail

java.lang.Object

software.amazon.awssdk.services.opensearchserverless.model.CollectionDetail

All Implemented Interfaces:

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

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

Details about each OpenSearch Serverless collection, including the collection endpoint and the OpenSearch Dashboards endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CollectionDetail.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The Amazon Resource Name (ARN) of the collection.
static CollectionDetail.Builder	builder()
String	collectionEndpoint()	Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.
Long	createdDate()	The Epoch time when the collection was created.
String	dashboardEndpoint()	Collection-specific endpoint used to access OpenSearch Dashboards.
String	description()	A description of the collection.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureCode()	A failure code associated with the request.
String	failureMessage()	A message associated with the failure code.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	A unique identifier for the collection.
String	kmsKeyArn()	The ARN of the Amazon Web Services KMS key used to encrypt the collection.
Long	lastModifiedDate()	The date and time when the collection was last modified.
String	name()	The name of the collection.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CollectionDetail.Builder>	serializableBuilderClass()
StandbyReplicas	standbyReplicas()	Details about an OpenSearch Serverless collection.
String	standbyReplicasAsString()	Details about an OpenSearch Serverless collection.
CollectionStatus	status()	The current status of the collection.
String	statusAsString()	The current status of the collection.
CollectionDetail.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
CollectionType	type()	The type of collection.
String	typeAsString()	The type of collection.

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.

collectionEndpoint

public final String collectionEndpoint()

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

Returns:

Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

createdDate

public final Long createdDate()

The Epoch time when the collection was created.

Returns:

The Epoch time when the collection was created.

dashboardEndpoint

public final String dashboardEndpoint()

Collection-specific endpoint used to access OpenSearch Dashboards.

Returns:

Collection-specific endpoint used to access OpenSearch Dashboards.

description

public final String description()

A description of the collection.

Returns:

A description of the collection.

failureCode

public final String failureCode()

A failure code associated with the request.

Returns:

A failure code associated with the request.

failureMessage

public final String failureMessage()

A message associated with the failure code.

Returns:

A message associated with the failure code.

id

public final String id()

A unique identifier for the collection.

Returns:

A unique identifier for the collection.

kmsKeyArn

public final String kmsKeyArn()

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

Returns:

The ARN of the Amazon Web Services KMS key used to encrypt the collection.

lastModifiedDate

public final Long lastModifiedDate()

The date and time when the collection was last modified.

Returns:

The date and time when the collection was last modified.

name

public final String name()

The name of the collection.

Returns:

The name of the collection.

standbyReplicas

public final StandbyReplicas standbyReplicas()

Details about an OpenSearch Serverless collection.

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

Returns:

Details about an OpenSearch Serverless collection.

See Also:

StandbyReplicas

standbyReplicasAsString

public final String standbyReplicasAsString()

Details about an OpenSearch Serverless collection.

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

Returns:

Details about an OpenSearch Serverless collection.

See Also:

StandbyReplicas

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

type

public final CollectionType type()

The type of collection.

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

Returns:

The type of collection.

See Also:

CollectionType

typeAsString

public final String typeAsString()

The type of collection.

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

Returns:

The type of collection.

See Also:

CollectionType

toBuilder

public CollectionDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CollectionDetail.Builder,CollectionDetail>

builder

public static CollectionDetail.Builder builder()

serializableBuilderClass

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