Package io.camunda.client.impl.search.request

Class UsersSearchRequestImpl

java.lang.Object

io.camunda.client.impl.search.request.TypedSearchRequestPropertyProvider<UserSearchQueryRequest>

io.camunda.client.impl.search.request.UsersSearchRequestImpl

All Implemented Interfaces:

FinalCommandStep<SearchResponse<User>>, FinalSearchRequestStep<User>, TypedFilterableRequest<UserFilter,UsersSearchRequest>, TypedPageableRequest<UsersSearchRequest>, TypedSearchRequest<UserFilter,UserSort,UsersSearchRequest>, TypedSortableRequest<UserSort,UsersSearchRequest>, UsersSearchRequest

public class UsersSearchRequestImpl
extends TypedSearchRequestPropertyProvider<UserSearchQueryRequest>
implements UsersSearchRequest

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.api.search.request.TypedFilterableRequest

TypedFilterableRequest.SearchRequestFilter

Nested classes/interfaces inherited from interface io.camunda.client.api.search.request.TypedSortableRequest

TypedSortableRequest.SearchRequestSort<S extends TypedSortableRequest.SearchRequestSort<S>>

Constructor Summary

Constructors

Constructor	Description
UsersSearchRequestImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
UsersSearchRequest	filter(UserFilter value)	Sets the filter to be included in the search request.
UsersSearchRequest	filter(Consumer<UserFilter> fn)	Provides a fluent builder to create a filter to be included in the search request.
protected UserSearchQueryRequest	getSearchRequestProperty()
UsersSearchRequest	page(SearchRequestPage value)	Support for pagination.
UsersSearchRequest	page(Consumer<SearchRequestPage> fn)	Provides a fluent builder to support pagination.
FinalSearchRequestStep<User>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<SearchResponse<User>>	send()	Sends the command to the Camunda gateway.
UsersSearchRequest	sort(UserSort value)	Sets the sorting the returned entities should be sorted by.
UsersSearchRequest	sort(Consumer<UserSort> fn)	Provides a fluent builder to provide sorting options the returned entities should sorted by

Methods inherited from class io.camunda.client.impl.search.request.TypedSearchRequestPropertyProvider

provideSearchRequestProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.camunda.client.api.command.FinalCommandStep

execute

Constructor Details

UsersSearchRequestImpl

public UsersSearchRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

requestTimeout

public FinalSearchRequestStep<User> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using CamundaClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<SearchResponse<User>>

Specified by:

requestTimeout in interface FinalSearchRequestStep<User>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<SearchResponse<User>> send()

Description copied from interface: FinalCommandStep

Sends the command to the Camunda gateway. This operation is asynchronous. In case of success, the future returns the event that was generated by the Camunda gateway in response to the command.

Call CamundaFuture.join() to wait until the response is available.

 Future<JobEventinvalid input: '&#62' future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<SearchResponse<User>>

Returns:

a future tracking state of success/failure of the command.

filter

public UsersSearchRequest filter(UserFilter value)

Description copied from interface: TypedFilterableRequest

Sets the filter to be included in the search request. Invoking the method overrides previously set filters.

Specified by:

filter in interface TypedFilterableRequest<UserFilter,UsersSearchRequest>

Parameters:

value - the filter

Returns:

the builder for the search request

filter

public UsersSearchRequest filter(Consumer<UserFilter> fn)

Description copied from interface: TypedFilterableRequest

Provides a fluent builder to create a filter to be included in the search request. Invoking the method overrides previously set filters. You can chain multiple filter criteria inside the consumer you provide for such cases.

Specified by:

filter in interface TypedFilterableRequest<UserFilter,UsersSearchRequest>

Parameters:

fn - consumer to create the filter

Returns:

the builder for the search request

sort

public UsersSearchRequest sort(UserSort value)

Description copied from interface: TypedSortableRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSortableRequest<UserSort,UsersSearchRequest>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public UsersSearchRequest sort(Consumer<UserSort> fn)

Description copied from interface: TypedSortableRequest

Provides a fluent builder to provide sorting options the returned entities should sorted by

Specified by:

sort in interface TypedSortableRequest<UserSort,UsersSearchRequest>

Parameters:

fn - consumer to create the sort options

Returns:

the builder for the search request

page

public UsersSearchRequest page(SearchRequestPage value)

Description copied from interface: TypedPageableRequest

Support for pagination.

Specified by:

page in interface TypedPageableRequest<UsersSearchRequest>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public UsersSearchRequest page(Consumer<SearchRequestPage> fn)

Description copied from interface: TypedPageableRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedPageableRequest<UsersSearchRequest>

Parameters:

fn - consumer to support pagination

Returns:

the builder for the search request

getSearchRequestProperty

protected UserSearchQueryRequest getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<UserSearchQueryRequest>