Interface UpdateCollectionGroupRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateCollectionGroupRequest

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

Method Summary

Modifier and Type	Method	Description
default UpdateCollectionGroupRequest.Builder	capacityLimits(Consumer<CollectionGroupCapacityLimits.Builder> capacityLimits)	The updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
UpdateCollectionGroupRequest.Builder	capacityLimits(CollectionGroupCapacityLimits capacityLimits)	The updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
UpdateCollectionGroupRequest.Builder	clientToken(String clientToken)	Unique, case-sensitive identifier to ensure idempotency of the request.
UpdateCollectionGroupRequest.Builder	description(String description)	A new description for the collection group.
UpdateCollectionGroupRequest.Builder	id(String id)	The unique identifier of the collection group to update.
UpdateCollectionGroupRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
UpdateCollectionGroupRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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

id

UpdateCollectionGroupRequest.Builder id(String id)

The unique identifier of the collection group to update.

Parameters:

id - The unique identifier of the collection group to update.

Returns:

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

description

UpdateCollectionGroupRequest.Builder description(String description)

A new description for the collection group.

Parameters:

description - A new description for the collection group.

Returns:

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

capacityLimits

UpdateCollectionGroupRequest.Builder capacityLimits(CollectionGroupCapacityLimits capacityLimits)

The updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs). Updates to capacity limits are not incremental. Any field not specified resets to its default value.

Parameters:

capacityLimits - The updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs). Updates to capacity limits are not incremental. Any field not specified resets to its default value.

Returns:

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

capacityLimits

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

The updated capacity limits for the collection group, in OpenSearch Compute Units (OCUs). Updates to capacity limits are not incremental. Any field not specified resets to its default value.

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

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

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

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