Interface ListSearchesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListSearchesRequest.Builder,ListSearchesRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<ListSearchesRequest.Builder,ListSearchesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListSearchesRequest

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

Method Summary

Modifier and Type	Method	Description
default ListSearchesRequest.Builder	listSearchesFilters(Consumer<ListSearchesFilters.Builder> listSearchesFilters)	Optional filters that restrict which searches are returned.
ListSearchesRequest.Builder	listSearchesFilters(ListSearchesFilters listSearchesFilters)	Optional filters that restrict which searches are returned.
ListSearchesRequest.Builder	maxResults(Integer maxResults)	The maximum number of searches to return in a single page.
ListSearchesRequest.Builder	nextToken(String nextToken)	The pagination token returned by a previous ListSearches call.
ListSearchesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListSearchesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListSearchesRequest.Builder	workspaceName(String workspaceName)	The name of the workspace whose searches are listed.

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.iotsitewise.model.IoTSiteWiseRequest.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

workspaceName

ListSearchesRequest.Builder workspaceName(String workspaceName)

The name of the workspace whose searches are listed.

Parameters:

workspaceName - The name of the workspace whose searches are listed.

Returns:

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

maxResults

ListSearchesRequest.Builder maxResults(Integer maxResults)

The maximum number of searches to return in a single page. Valid range is 1 to 1,000; if omitted, a service-defined default is used.

Parameters:

maxResults - The maximum number of searches to return in a single page. Valid range is 1 to 1,000; if omitted, a service-defined default is used.

Returns:

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

nextToken

ListSearchesRequest.Builder nextToken(String nextToken)

The pagination token returned by a previous ListSearches call. Provide it to retrieve the next page; omit it to retrieve the first page.

Parameters:

nextToken - The pagination token returned by a previous ListSearches call. Provide it to retrieve the next page; omit it to retrieve the first page.

Returns:

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

listSearchesFilters

ListSearchesRequest.Builder listSearchesFilters(ListSearchesFilters listSearchesFilters)

Optional filters that restrict which searches are returned.

Parameters:

listSearchesFilters - Optional filters that restrict which searches are returned.

Returns:

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

listSearchesFilters

default ListSearchesRequest.Builder listSearchesFilters(Consumer<ListSearchesFilters.Builder> listSearchesFilters)

Optional filters that restrict which searches are returned.

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

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

Parameters:

listSearchesFilters - a consumer that will call methods on ListSearchesFilters.Builder

Returns:

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

See Also:

• listSearchesFilters(ListSearchesFilters)

overrideConfiguration

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

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