Interface SearchRulesRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchRulesRequest

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

Method Summary

Modifier and Type	Method	Description
SearchRulesRequest.Builder	instanceId(String instanceId)	The identifier of the Connect Customer instance.
SearchRulesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchRulesRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchRulesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchRulesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchRulesRequest.Builder	searchCriteria(Consumer<RulesSearchCriteria.Builder> searchCriteria)	The search criteria to be used to return rules.
SearchRulesRequest.Builder	searchCriteria(RulesSearchCriteria searchCriteria)	The search criteria to be used to return rules.
default SearchRulesRequest.Builder	searchFilter(Consumer<RulesSearchFilter.Builder> searchFilter)	Filters to be applied to search results, such as tag-based filters.
SearchRulesRequest.Builder	searchFilter(RulesSearchFilter searchFilter)	Filters to be applied to search results, 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

SearchRulesRequest.Builder instanceId(String instanceId)

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

Parameters:

instanceId - The identifier of the Connect Customer 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.

maxResults

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

nextToken

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

searchCriteria

SearchRulesRequest.Builder searchCriteria(RulesSearchCriteria searchCriteria)

The search criteria to be used to return rules.

Parameters:

searchCriteria - The search criteria to be used to return rules.

Returns:

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

searchCriteria

default SearchRulesRequest.Builder searchCriteria(Consumer<RulesSearchCriteria.Builder> searchCriteria)

The search criteria to be used to return rules.

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

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

Parameters:

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

Returns:

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

See Also:

• searchCriteria(RulesSearchCriteria)

searchFilter

SearchRulesRequest.Builder searchFilter(RulesSearchFilter searchFilter)

Filters to be applied to search results, such as tag-based filters.

Parameters:

searchFilter - Filters to be applied to search results, such as tag-based filters.

Returns:

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

searchFilter

default SearchRulesRequest.Builder searchFilter(Consumer<RulesSearchFilter.Builder> searchFilter)

Filters to be applied to search results, such as tag-based filters.

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

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

Parameters:

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

Returns:

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

See Also:

• searchFilter(RulesSearchFilter)

overrideConfiguration

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

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