Interface SearchViewsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<SearchViewsRequest.Builder,SearchViewsRequest>, SdkBuilder<SearchViewsRequest.Builder,SearchViewsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SearchViewsRequest

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

Method Summary

Modifier and Type	Method	Description
SearchViewsRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
SearchViewsRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchViewsRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchViewsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchViewsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchViewsRequest.Builder	searchCriteria(Consumer<ViewSearchCriteria.Builder> searchCriteria)	The search criteria, including field names and comparison types.
SearchViewsRequest.Builder	searchCriteria(ViewSearchCriteria searchCriteria)	The search criteria, including field names and comparison types.
default SearchViewsRequest.Builder	searchFilter(Consumer<ViewSearchFilter.Builder> searchFilter)	Filters to apply to the search, such as tag-based filters.
SearchViewsRequest.Builder	searchFilter(ViewSearchFilter searchFilter)	Filters to apply to the search, such as tag-based filters.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.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

instanceId

SearchViewsRequest.Builder instanceId(String instanceId)

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Parameters:

instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Returns:

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

nextToken

SearchViewsRequest.Builder nextToken(String nextToken)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Parameters:

nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Returns:

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

maxResults

SearchViewsRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

Returns:

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

searchFilter

SearchViewsRequest.Builder searchFilter(ViewSearchFilter searchFilter)

Filters to apply to the search, such as tag-based filters.

Parameters:

searchFilter - Filters to apply to the search, such as tag-based filters.

Returns:

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

searchFilter

default SearchViewsRequest.Builder searchFilter(Consumer<ViewSearchFilter.Builder> searchFilter)

Filters to apply to the search, such as tag-based filters.

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

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

Parameters:

searchFilter - a consumer that will call methods on ViewSearchFilter.Builder

Returns:

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

See Also:

• searchFilter(ViewSearchFilter)

searchCriteria

SearchViewsRequest.Builder searchCriteria(ViewSearchCriteria searchCriteria)

The search criteria, including field names and comparison types.

Parameters:

searchCriteria - The search criteria, including field names and comparison types.

Returns:

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

searchCriteria

default SearchViewsRequest.Builder searchCriteria(Consumer<ViewSearchCriteria.Builder> searchCriteria)

The search criteria, including field names and comparison types.

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

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

Parameters:

searchCriteria - a consumer that will call methods on ViewSearchCriteria.Builder

Returns:

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

See Also:

• searchCriteria(ViewSearchCriteria)

overrideConfiguration

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

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