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

Class UsersByGroupSearchRequestImpl

java.lang.Object

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

io.camunda.client.impl.search.request.UsersByGroupSearchRequestImpl

All Implemented Interfaces:

FinalCommandStep<SearchResponse<User>>, UsersByGroupSearchRequest, FinalSearchRequestStep<User>, TypedSearchRequest<UserFilter,UserSort,UsersByGroupSearchRequest>

public class UsersByGroupSearchRequestImpl
extends TypedSearchRequestPropertyProvider<UserSearchQueryRequest>
implements UsersByGroupSearchRequest

Nested Class Summary

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

TypedSearchRequest.SearchRequestFilter, TypedSearchRequest.SearchRequestSort<S extends TypedSearchRequest.SearchRequestSort<S>>

Constructor Summary

Constructors

Constructor	Description
UsersByGroupSearchRequestImpl(HttpClient httpClient, JsonMapper jsonMapper, String groupId)

Method Summary

Modifier and Type	Method	Description
UsersByGroupSearchRequest	filter(UserFilter value)	Sets the filter to be included in the search request.
UsersByGroupSearchRequest	filter(Consumer<UserFilter> fn)	Provides a fluent builder to create a filter to be included in the search request.
protected UserSearchQueryRequest	getSearchRequestProperty()
UsersByGroupSearchRequest	page(SearchRequestPage value)	Support for pagination.
UsersByGroupSearchRequest	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.
UsersByGroupSearchRequest	sort(UserSort value)	Sets the sorting the returned entities should be sorted by.
UsersByGroupSearchRequest	sort(Consumer<UserSort> fn)	Provides a fluent builder to provide sorting options the returned entites 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

Constructor Details

UsersByGroupSearchRequestImpl

public UsersByGroupSearchRequestImpl(HttpClient httpClient,
 JsonMapper jsonMapper,
 String groupId)

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 UsersByGroupSearchRequest filter(UserFilter value)

Description copied from interface: TypedSearchRequest

Sets the filter to be included in the search request.

Specified by:

filter in interface TypedSearchRequest<UserFilter,UserSort,UsersByGroupSearchRequest>

Parameters:

value - the filter

Returns:

the builder for the search request

filter

public UsersByGroupSearchRequest filter(Consumer<UserFilter> fn)

Description copied from interface: TypedSearchRequest

Provides a fluent builder to create a filter to be included in the search request.

Specified by:

filter in interface TypedSearchRequest<UserFilter,UserSort,UsersByGroupSearchRequest>

Parameters:

fn - consumer to create the filter

Returns:

the builder for the search request

sort

public UsersByGroupSearchRequest sort(UserSort value)

Description copied from interface: TypedSearchRequest

Sets the sorting the returned entities should be sorted by.

Specified by:

sort in interface TypedSearchRequest<UserFilter,UserSort,UsersByGroupSearchRequest>

Parameters:

value - the sort options

Returns:

the builder for the search request

sort

public UsersByGroupSearchRequest sort(Consumer<UserSort> fn)

Description copied from interface: TypedSearchRequest

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

Specified by:

sort in interface TypedSearchRequest<UserFilter,UserSort,UsersByGroupSearchRequest>

Parameters:

fn - consumer to create the sort options

Returns:

the builder for the search request

page

public UsersByGroupSearchRequest page(SearchRequestPage value)

Description copied from interface: TypedSearchRequest

Support for pagination.

Specified by:

page in interface TypedSearchRequest<UserFilter,UserSort,UsersByGroupSearchRequest>

Parameters:

value - the next page

Returns:

the builder for the search request

page

public UsersByGroupSearchRequest page(Consumer<SearchRequestPage> fn)

Description copied from interface: TypedSearchRequest

Provides a fluent builder to support pagination.

Specified by:

page in interface TypedSearchRequest<UserFilter,UserSort,UsersByGroupSearchRequest>

Parameters:

fn - consumer to support pagination

Returns:

the builder for the search request

getSearchRequestProperty

protected UserSearchQueryRequest getSearchRequestProperty()

Specified by:

getSearchRequestProperty in class TypedSearchRequestPropertyProvider<UserSearchQueryRequest>