Package io.camunda.client.protocol.rest

Class SearchQueryPageRequest

java.lang.Object

io.camunda.client.protocol.rest.SearchQueryPageRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2025-02-25T13:39:08.081076719Z[GMT]",
           comments="Generator version: 7.10.0")
public class SearchQueryPageRequest
extends Object

SearchQueryPageRequest

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_FROM
static final String	JSON_PROPERTY_LIMIT
static final String	JSON_PROPERTY_SEARCH_AFTER
static final String	JSON_PROPERTY_SEARCH_BEFORE

Constructor Summary

Constructors

Constructor	Description
SearchQueryPageRequest()

Method Summary

Modifier and Type	Method	Description
SearchQueryPageRequest	addSearchAfterItem(Object searchAfterItem)
SearchQueryPageRequest	addSearchBeforeItem(Object searchBeforeItem)
boolean	equals(Object o)
SearchQueryPageRequest	from(Integer from)
Integer	getFrom()	The index of items to start searching from.
Integer	getLimit()	The maximum number of items to return in one request.
List<Object>	getSearchAfter()	Items to search after.
List<Object>	getSearchBefore()	Items to search before.
int	hashCode()
SearchQueryPageRequest	limit(Integer limit)
SearchQueryPageRequest	searchAfter(List<Object> searchAfter)
SearchQueryPageRequest	searchBefore(List<Object> searchBefore)
void	setFrom(Integer from)
void	setLimit(Integer limit)
void	setSearchAfter(List<Object> searchAfter)
void	setSearchBefore(List<Object> searchBefore)
String	toString()
String	toUrlQueryString()	Convert the instance into URL query string.
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_FROM

public static final String JSON_PROPERTY_FROM

See Also:

• Constant Field Values

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_SEARCH_AFTER

public static final String JSON_PROPERTY_SEARCH_AFTER

See Also:

• Constant Field Values

JSON_PROPERTY_SEARCH_BEFORE

public static final String JSON_PROPERTY_SEARCH_BEFORE

See Also:

• Constant Field Values

Constructor Details

SearchQueryPageRequest

public SearchQueryPageRequest()

Method Details

from

public SearchQueryPageRequest from(@Nullable
 Integer from)

getFrom

@Nullable
public Integer getFrom()

The index of items to start searching from.

Returns:

from

setFrom

public void setFrom(@Nullable
 Integer from)

limit

public SearchQueryPageRequest limit(@Nullable
 Integer limit)

getLimit

@Nullable
public Integer getLimit()

The maximum number of items to return in one request.

Returns:

limit

setLimit

public void setLimit(@Nullable
 Integer limit)

searchAfter

public SearchQueryPageRequest searchAfter(@Nullable
 List<Object> searchAfter)

addSearchAfterItem

public SearchQueryPageRequest addSearchAfterItem(Object searchAfterItem)

getSearchAfter

@Nullable
public List<Object> getSearchAfter()

Items to search after. Correlates to the `lastSortValues` property of a previous search response.

Returns:

searchAfter

setSearchAfter

public void setSearchAfter(@Nullable
 List<Object> searchAfter)

searchBefore

public SearchQueryPageRequest searchBefore(@Nullable
 List<Object> searchBefore)

addSearchBeforeItem

public SearchQueryPageRequest addSearchBeforeItem(Object searchBeforeItem)

getSearchBefore

@Nullable
public List<Object> getSearchBefore()

Items to search before. Correlates to the `firstSortValues` property of a previous search response.

Returns:

searchBefore

setSearchBefore

public void setSearchBefore(@Nullable
 List<Object> searchBefore)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toUrlQueryString

public String toUrlQueryString()

Convert the instance into URL query string.

Returns:

URL query string

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string