Interface SearchChannelsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ChimeSdkMessagingRequest.Builder, CopyableBuilder<SearchChannelsRequest.Builder,SearchChannelsRequest>, SdkBuilder<SearchChannelsRequest.Builder,SearchChannelsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchChannelsRequest

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

Method Summary

Modifier and Type	Method	Description
SearchChannelsRequest.Builder	chimeBearer(String chimeBearer)	The AppInstanceUserArn of the user making the API call.
SearchChannelsRequest.Builder	fields(Collection<SearchField> fields)	A list of the Field objects in the channel being searched.
SearchChannelsRequest.Builder	fields(Consumer<SearchField.Builder>... fields)	A list of the Field objects in the channel being searched.
SearchChannelsRequest.Builder	fields(SearchField... fields)	A list of the Field objects in the channel being searched.
SearchChannelsRequest.Builder	maxResults(Integer maxResults)	The maximum number of channels that you want returned.
SearchChannelsRequest.Builder	nextToken(String nextToken)	The token returned from previous API requests until the number of channels is reached.
SearchChannelsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchChannelsRequest.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.services.chimesdkmessaging.model.ChimeSdkMessagingRequest.Builder

build

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

chimeBearer

SearchChannelsRequest.Builder chimeBearer(String chimeBearer)

The AppInstanceUserArn of the user making the API call.

Parameters:

chimeBearer - The AppInstanceUserArn of the user making the API call.

Returns:

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

fields

SearchChannelsRequest.Builder fields(Collection<SearchField> fields)

A list of the Field objects in the channel being searched.

Parameters:

fields - A list of the Field objects in the channel being searched.

Returns:

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

fields

SearchChannelsRequest.Builder fields(SearchField... fields)

A list of the Field objects in the channel being searched.

Parameters:

fields - A list of the Field objects in the channel being searched.

Returns:

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

fields

SearchChannelsRequest.Builder fields(Consumer<SearchField.Builder>... fields)

A list of the Field objects in the channel being searched.

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

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

Parameters:

fields - a consumer that will call methods on SearchField.Builder

Returns:

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

See Also:

• fields(java.util.Collection<SearchField>)

maxResults

SearchChannelsRequest.Builder maxResults(Integer maxResults)

The maximum number of channels that you want returned.

Parameters:

maxResults - The maximum number of channels that you want returned.

Returns:

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

nextToken

SearchChannelsRequest.Builder nextToken(String nextToken)

The token returned from previous API requests until the number of channels is reached.

Parameters:

nextToken - The token returned from previous API requests until the number of channels is reached.

Returns:

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

overrideConfiguration

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

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