Interface CollectionGroupDetail.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CollectionGroupDetail.Builder,CollectionGroupDetail>, SdkBuilder<CollectionGroupDetail.Builder,CollectionGroupDetail>, SdkPojo

Enclosing class:

CollectionGroupDetail

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

Method Summary

Modifier and Type	Method	Description
CollectionGroupDetail.Builder	arn(String arn)	The Amazon Resource Name (ARN) of the collection group.
default CollectionGroupDetail.Builder	capacityLimits(Consumer<CollectionGroupCapacityLimits.Builder> capacityLimits)	The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
CollectionGroupDetail.Builder	capacityLimits(CollectionGroupCapacityLimits capacityLimits)	The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).
CollectionGroupDetail.Builder	createdDate(Long createdDate)	The Epoch time when the collection group was created.
default CollectionGroupDetail.Builder	currentCapacity(Consumer<CurrentCapacity.Builder> currentCapacity)	Current search and indexing capacity for the collection group.
CollectionGroupDetail.Builder	currentCapacity(CurrentCapacity currentCapacity)	Current search and indexing capacity for the collection group.
CollectionGroupDetail.Builder	description(String description)	The description of the collection group.
CollectionGroupDetail.Builder	generation(String generation)	The generation of Amazon OpenSearch Serverless for the collection group.
CollectionGroupDetail.Builder	generation(ServerlessGeneration generation)	The generation of Amazon OpenSearch Serverless for the collection group.
CollectionGroupDetail.Builder	id(String id)	The unique identifier of the collection group.
CollectionGroupDetail.Builder	name(String name)	The name of the collection group.
CollectionGroupDetail.Builder	numberOfCollections(Integer numberOfCollections)	The number of collections associated with the collection group.
CollectionGroupDetail.Builder	standbyReplicas(String standbyReplicas)	Indicates whether standby replicas are used for the collection group.
CollectionGroupDetail.Builder	standbyReplicas(StandbyReplicas standbyReplicas)	Indicates whether standby replicas are used for the collection group.
CollectionGroupDetail.Builder	tags(Collection<Tag> tags)	A map of key-value pairs associated with the collection group.
CollectionGroupDetail.Builder	tags(Consumer<Tag.Builder>... tags)	A map of key-value pairs associated with the collection group.
CollectionGroupDetail.Builder	tags(Tag... tags)	A map of key-value pairs associated with the collection group.

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

copy

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

CollectionGroupDetail.Builder id(String id)

The unique identifier of the collection group.

Parameters:

id - The unique identifier of the collection group.

Returns:

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

arn

CollectionGroupDetail.Builder arn(String arn)

The Amazon Resource Name (ARN) of the collection group.

Parameters:

arn - The Amazon Resource Name (ARN) of the collection group.

Returns:

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

name

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

CollectionGroupDetail.Builder standbyReplicas(String standbyReplicas)

Indicates whether standby replicas are used for the collection group.

Parameters:

standbyReplicas - Indicates whether standby replicas are used for the collection group.

Returns:

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

See Also:

• StandbyReplicas
• StandbyReplicas

standbyReplicas

CollectionGroupDetail.Builder standbyReplicas(StandbyReplicas standbyReplicas)

Indicates whether standby replicas are used for the collection group.

Parameters:

standbyReplicas - Indicates whether standby replicas are used for the collection group.

Returns:

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

See Also:

• StandbyReplicas
• StandbyReplicas

description

CollectionGroupDetail.Builder description(String description)

The description of the collection group.

Parameters:

description - The description of the collection group.

Returns:

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

tags

CollectionGroupDetail.Builder tags(Collection<Tag> tags)

A map of key-value pairs associated with the collection group.

Parameters:

tags - A map of key-value pairs associated with the collection group.

Returns:

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

tags

CollectionGroupDetail.Builder tags(Tag... tags)

A map of key-value pairs associated with the collection group.

Parameters:

tags - A map of key-value pairs associated with the collection group.

Returns:

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

tags

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

A map of key-value pairs associated with the 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>)

createdDate

CollectionGroupDetail.Builder createdDate(Long createdDate)

The Epoch time when the collection group was created.

Parameters:

createdDate - The Epoch time when the collection group was created.

Returns:

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

capacityLimits

CollectionGroupDetail.Builder capacityLimits(CollectionGroupCapacityLimits capacityLimits)

The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

Parameters:

capacityLimits - The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

Returns:

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

capacityLimits

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

The capacity limits for the collection group, in OpenSearch Compute Units (OCUs).

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)

currentCapacity

CollectionGroupDetail.Builder currentCapacity(CurrentCapacity currentCapacity)

Current search and indexing capacity for the collection group.

Parameters:

currentCapacity - Current search and indexing capacity for the collection group.

Returns:

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

currentCapacity

default CollectionGroupDetail.Builder currentCapacity(Consumer<CurrentCapacity.Builder> currentCapacity)

Current search and indexing capacity for the collection group.

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

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

Parameters:

currentCapacity - a consumer that will call methods on CurrentCapacity.Builder

Returns:

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

See Also:

• currentCapacity(CurrentCapacity)

numberOfCollections

CollectionGroupDetail.Builder numberOfCollections(Integer numberOfCollections)

The number of collections associated with the collection group.

Parameters:

numberOfCollections - The number of collections associated with the collection group.

Returns:

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

generation

CollectionGroupDetail.Builder generation(String generation)

The generation of Amazon OpenSearch Serverless for the collection group.

Parameters:

generation - The generation of Amazon OpenSearch Serverless for the collection group.

Returns:

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

See Also:

• ServerlessGeneration
• ServerlessGeneration

generation

CollectionGroupDetail.Builder generation(ServerlessGeneration generation)

The generation of Amazon OpenSearch Serverless for the collection group.

Parameters:

generation - The generation of Amazon OpenSearch Serverless for the collection group.

Returns:

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

See Also:

• ServerlessGeneration
• ServerlessGeneration