Package software.amazon.awssdk.services.connect.model

Interface SearchUsersRequest.Builder

All Superinterfaces:

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

Enclosing class:

SearchUsersRequest

public static interface SearchUsersRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<SearchUsersRequest.Builder,SearchUsersRequest>

Method Summary

Modifier and Type	Method	Description
SearchUsersRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
SearchUsersRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return per page.
SearchUsersRequest.Builder	nextToken(String nextToken)	The token for the next set of results.
SearchUsersRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SearchUsersRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SearchUsersRequest.Builder	searchCriteria(Consumer<UserSearchCriteria.Builder> searchCriteria)	Sets the value of the SearchCriteria property for this object.
SearchUsersRequest.Builder	searchCriteria(UserSearchCriteria searchCriteria)	Sets the value of the SearchCriteria property for this object.
default SearchUsersRequest.Builder	searchFilter(Consumer<UserSearchFilter.Builder> searchFilter)	Filters to be applied to search results.
SearchUsersRequest.Builder	searchFilter(UserSearchFilter searchFilter)	Filters to be applied to search results.

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, sdkFields

Method Details

instanceId

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

InstanceID is a required field. The "Required: No" below is incorrect.

Parameters:

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

InstanceID is a required field. The "Required: No" below is incorrect.

Returns:

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

nextToken

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

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

SearchUsersRequest.Builder searchFilter(UserSearchFilter searchFilter)

Filters to be applied to search results.

Parameters:

searchFilter - Filters to be applied to search results.

Returns:

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

searchFilter

default SearchUsersRequest.Builder searchFilter(Consumer<UserSearchFilter.Builder> searchFilter)

Filters to be applied to search results.

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

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

Parameters:

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

Returns:

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

See Also:

• searchFilter(UserSearchFilter)

searchCriteria

SearchUsersRequest.Builder searchCriteria(UserSearchCriteria searchCriteria)

Sets the value of the SearchCriteria property for this object.

Parameters:

searchCriteria - The new value for the SearchCriteria property for this object.

Returns:

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

searchCriteria

default SearchUsersRequest.Builder searchCriteria(Consumer<UserSearchCriteria.Builder> searchCriteria)

Sets the value of the SearchCriteria property for this object. This is a convenience method that creates an instance of the UserSearchCriteria.Builder avoiding the need to create one manually via UserSearchCriteria.builder().

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

Parameters:

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

Returns:

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

See Also:

• searchCriteria(UserSearchCriteria)

overrideConfiguration

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

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