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

Class CreateCollectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest

software.amazon.awssdk.services.opensearchserverless.model.CreateCollectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateCollectionRequest
extends OpenSearchServerlessRequest
implements ToCopyableBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateCollectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateCollectionRequest.Builder	builder()
String	clientToken()	Unique, case-sensitive identifier to ensure idempotency of the request.
String	description()	Description of the collection.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	Name of the collection.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCollectionRequest.Builder>	serializableBuilderClass()
StandbyReplicas	standbyReplicas()	Indicates whether standby replicas should be used for a collection.
String	standbyReplicasAsString()	Indicates whether standby replicas should be used for a collection.
List<Tag>	tags()	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
CreateCollectionRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

clientToken

public final String clientToken()

Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:

Unique, case-sensitive identifier to ensure idempotency of the request.

description

public final String description()

Description of the collection.

Returns:

Description of the collection.

name

public final String name()

Name of the collection.

Returns:

Name of the collection.

standbyReplicas

public final StandbyReplicas standbyReplicas()

Indicates whether standby replicas should be used for a 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:

Indicates whether standby replicas should be used for a collection.

See Also:

StandbyReplicas

standbyReplicasAsString

public final String standbyReplicasAsString()

Indicates whether standby replicas should be used for a 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:

Indicates whether standby replicas should be used for a collection.

See Also:

StandbyReplicas

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

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 CreateCollectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>

Specified by:

toBuilder in class OpenSearchServerlessRequest

builder

public static CreateCollectionRequest.Builder builder()

serializableBuilderClass

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo