Interface ListCollectionGroupsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<ListCollectionGroupsResponse.Builder,ListCollectionGroupsResponse>, OpenSearchServerlessResponse.Builder, SdkBuilder<ListCollectionGroupsResponse.Builder,ListCollectionGroupsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

ListCollectionGroupsResponse

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

Method Summary

Modifier and Type	Method	Description
ListCollectionGroupsResponse.Builder	collectionGroupSummaries(Collection<CollectionGroupSummary> collectionGroupSummaries)	Details about each collection group.
ListCollectionGroupsResponse.Builder	collectionGroupSummaries(Consumer<CollectionGroupSummary.Builder>... collectionGroupSummaries)	Details about each collection group.
ListCollectionGroupsResponse.Builder	collectionGroupSummaries(CollectionGroupSummary... collectionGroupSummaries)	Details about each collection group.
ListCollectionGroupsResponse.Builder	nextToken(String nextToken)	When nextToken is returned, there are more results available.

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

copy

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

build, responseMetadata, responseMetadata

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

collectionGroupSummaries

ListCollectionGroupsResponse.Builder collectionGroupSummaries(Collection<CollectionGroupSummary> collectionGroupSummaries)

Details about each collection group.

Parameters:

collectionGroupSummaries - Details about each collection group.

Returns:

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

collectionGroupSummaries

ListCollectionGroupsResponse.Builder collectionGroupSummaries(CollectionGroupSummary... collectionGroupSummaries)

Details about each collection group.

Parameters:

collectionGroupSummaries - Details about each collection group.

Returns:

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

collectionGroupSummaries

ListCollectionGroupsResponse.Builder collectionGroupSummaries(Consumer<CollectionGroupSummary.Builder>... collectionGroupSummaries)

Details about each collection group.

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

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

Parameters:

collectionGroupSummaries - a consumer that will call methods on CollectionGroupSummary.Builder

Returns:

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

See Also:

• collectionGroupSummaries(java.util.Collection<CollectionGroupSummary>)

nextToken

ListCollectionGroupsResponse.Builder nextToken(String nextToken)

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Parameters:

nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

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