Interface CreateCollectionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>, OpenSearchServerlessRequest.Builder, SdkBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateCollectionRequest

public static interface CreateCollectionRequest.Builder
extends OpenSearchServerlessRequest.Builder, SdkPojo, CopyableBuilder<CreateCollectionRequest.Builder,CreateCollectionRequest>

Method Summary

Modifier and Type	Method	Description
CreateCollectionRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier to ensure idempotency of the request.
CreateCollectionRequest.Builder	description(String description)	Description of the collection.
CreateCollectionRequest.Builder	name(String name)	Name of the collection.
CreateCollectionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateCollectionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateCollectionRequest.Builder	standbyReplicas(String standbyReplicas)	Indicates whether standby replicas should be used for a collection.
CreateCollectionRequest.Builder	standbyReplicas(StandbyReplicas standbyReplicas)	Indicates whether standby replicas should be used for a collection.
CreateCollectionRequest.Builder	tags(Collection<Tag> tags)	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
CreateCollectionRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
CreateCollectionRequest.Builder	tags(Tag... tags)	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.
CreateCollectionRequest.Builder	type(String type)	The type of collection.
CreateCollectionRequest.Builder	type(CollectionType type)	The type of collection.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

clientToken

CreateCollectionRequest.Builder clientToken(String clientToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateCollectionRequest.Builder description(String description)

Description of the collection.

Parameters:

description - Description of the collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

CreateCollectionRequest.Builder name(String name)

Name of the collection.

Parameters:

name - Name of the collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

standbyReplicas

CreateCollectionRequest.Builder standbyReplicas(String standbyReplicas)

Indicates whether standby replicas should be used for a collection.

Parameters:

standbyReplicas - Indicates whether standby replicas should be used for a collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StandbyReplicas
• StandbyReplicas

standbyReplicas

CreateCollectionRequest.Builder standbyReplicas(StandbyReplicas standbyReplicas)

Indicates whether standby replicas should be used for a collection.

Parameters:

standbyReplicas - Indicates whether standby replicas should be used for a collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• StandbyReplicas
• StandbyReplicas

tags

CreateCollectionRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateCollectionRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

CreateCollectionRequest.Builder tags(Consumer<Tag.Builder>... tags)

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

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• tags(java.util.Collection<Tag>)

type

CreateCollectionRequest.Builder type(String type)

The type of collection.

Parameters:

type - The type of collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• CollectionType
• CollectionType

type

CreateCollectionRequest.Builder type(CollectionType type)

The type of collection.

Parameters:

type - The type of collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• CollectionType
• CollectionType

overrideConfiguration

CreateCollectionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateCollectionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.