Interface ListChannelsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListChannelsRequest.Builder,ListChannelsRequest>, KinesisRequest.Builder, SdkBuilder<ListChannelsRequest.Builder,ListChannelsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListChannelsRequest

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

Method Summary

Modifier and Type	Method	Description
ListChannelsRequest.Builder	maxResults(Integer maxResults)	The maximum number of channels to return in a single call.
ListChannelsRequest.Builder	nextToken(String nextToken)	The pagination token returned by a previous call.
ListChannelsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListChannelsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListChannelsRequest.Builder	streamFilter(Collection<StreamFilter> streamFilter)	Filters the results to channels associated with the specified streams.
ListChannelsRequest.Builder	streamFilter(Consumer<StreamFilter.Builder>... streamFilter)	Filters the results to channels associated with the specified streams.
ListChannelsRequest.Builder	streamFilter(StreamFilter... streamFilter)	Filters the results to channels associated with the specified streams.

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.kinesis.model.KinesisRequest.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

streamFilter

ListChannelsRequest.Builder streamFilter(Collection<StreamFilter> streamFilter)

Filters the results to channels associated with the specified streams.

Parameters:

streamFilter - Filters the results to channels associated with the specified streams.

Returns:

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

streamFilter

ListChannelsRequest.Builder streamFilter(StreamFilter... streamFilter)

Filters the results to channels associated with the specified streams.

Parameters:

streamFilter - Filters the results to channels associated with the specified streams.

Returns:

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

streamFilter

ListChannelsRequest.Builder streamFilter(Consumer<StreamFilter.Builder>... streamFilter)

Filters the results to channels associated with the specified streams.

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

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

Parameters:

streamFilter - a consumer that will call methods on StreamFilter.Builder

Returns:

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

See Also:

• streamFilter(java.util.Collection<StreamFilter>)

maxResults

ListChannelsRequest.Builder maxResults(Integer maxResults)

The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

Parameters:

maxResults - The maximum number of channels to return in a single call. The default value is 100. If you specify a value greater than 100, at most 100 results are returned.

Returns:

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

nextToken

ListChannelsRequest.Builder nextToken(String nextToken)

The pagination token returned by a previous call. Specify this token to retrieve the next page of results. This value is null when there are no more results to return.

Parameters:

nextToken - The pagination token returned by a previous call. Specify this token to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

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

overrideConfiguration

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

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