Interface CreateCollectionGroupRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateCollectionGroupRequest

@Mutable
@NotThreadSafe
public static interface CreateCollectionGroupRequest.Builder
extends OpenSearchServerlessRequest.Builder, SdkPojo, CopyableBuilder<CreateCollectionGroupRequest.Builder,CreateCollectionGroupRequest>

Method Summary

Modifier and Type	Method	Description
default CreateCollectionGroupRequest.Builder	capacityLimits(Consumer<CollectionGroupCapacityLimits.Builder> capacityLimits)	The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
CreateCollectionGroupRequest.Builder	capacityLimits(CollectionGroupCapacityLimits capacityLimits)	The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
CreateCollectionGroupRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier to ensure idempotency of the request.
CreateCollectionGroupRequest.Builder	description(String description)	A description of the collection group.
CreateCollectionGroupRequest.Builder	name(String name)	The name of the collection group.
CreateCollectionGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateCollectionGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateCollectionGroupRequest.Builder	standbyReplicas(String standbyReplicas)	Indicates whether standby replicas should be used for a collection group.
CreateCollectionGroupRequest.Builder	standbyReplicas(StandbyReplicas standbyReplicas)	Indicates whether standby replicas should be used for a collection group.
CreateCollectionGroupRequest.Builder	tags(Collection<Tag> tags)	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.
CreateCollectionGroupRequest.Builder	tags(Consumer<Tag.Builder>... tags)	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.
CreateCollectionGroupRequest.Builder	tags(Tag... tags)	An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection group.

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, sdkFieldNameToField, sdkFields

Method Details

name

CreateCollectionGroupRequest.Builder name(String name)

The name of the collection group.

Parameters:

name - The name of the collection group.

Returns:

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

standbyReplicas

CreateCollectionGroupRequest.Builder standbyReplicas(String standbyReplicas)

Indicates whether standby replicas should be used for a collection group.

Parameters:

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

Returns:

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

See Also:

• StandbyReplicas
• StandbyReplicas

standbyReplicas

CreateCollectionGroupRequest.Builder standbyReplicas(StandbyReplicas standbyReplicas)

Indicates whether standby replicas should be used for a collection group.

Parameters:

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

Returns:

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

See Also:

• StandbyReplicas
• StandbyReplicas

description

CreateCollectionGroupRequest.Builder description(String description)

A description of the collection group.

Parameters:

description - A description of the collection group.

Returns:

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

tags

CreateCollectionGroupRequest.Builder tags(Collection<Tag> tags)

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

Parameters:

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

Returns:

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

tags

CreateCollectionGroupRequest.Builder tags(Tag... tags)

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

Parameters:

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

Returns:

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

tags

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

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

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>)

capacityLimits

CreateCollectionGroupRequest.Builder capacityLimits(CollectionGroupCapacityLimits capacityLimits)

The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.

Parameters:

capacityLimits - The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.

Returns:

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

capacityLimits

default CreateCollectionGroupRequest.Builder capacityLimits(Consumer<CollectionGroupCapacityLimits.Builder> capacityLimits)

The capacity limits for the collection group, in OpenSearch Compute Units (OCUs). These limits control the maximum and minimum capacity for collections within the group.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to capacityLimits(CollectionGroupCapacityLimits).

Parameters:

capacityLimits - a consumer that will call methods on CollectionGroupCapacityLimits.Builder

Returns:

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

See Also:

• capacityLimits(CollectionGroupCapacityLimits)

clientToken

CreateCollectionGroupRequest.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.

overrideConfiguration

CreateCollectionGroupRequest.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

CreateCollectionGroupRequest.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.