Package io.camunda.client.protocol.rest

Class SearchQueryPageRequest

java.lang.Object

io.camunda.client.protocol.rest.SearchQueryPageRequest

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.23.0")
public class SearchQueryPageRequest
extends Object

Pagination criteria. Can use offset-based pagination (from/limit) OR cursor-based pagination (after/before + limit), but not both.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_AFTER
static final String	JSON_PROPERTY_BEFORE
static final String	JSON_PROPERTY_FROM
static final String	JSON_PROPERTY_LIMIT

Constructor Summary

Constructors

Constructor	Description
SearchQueryPageRequest()

Method Summary

Modifier and Type	Method	Description
SearchQueryPageRequest	after(String after)
SearchQueryPageRequest	before(String before)
boolean	equals(Object o)
SearchQueryPageRequest	from(Integer from)
String	getAfter()	Use the `endCursor` value from the previous response to fetch the next page of results.
String	getBefore()	Use the `startCursor` value from the previous response to fetch the previous page of results.
Integer	getFrom()	The index of items to start searching from.
Integer	getLimit()	The maximum number of items to return in one request.
int	hashCode()
SearchQueryPageRequest	limit(Integer limit)
void	setAfter(String after)
void	setBefore(String before)
void	setFrom(Integer from)
void	setLimit(Integer limit)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_LIMIT

public static final String JSON_PROPERTY_LIMIT

See Also:

• Constant Field Values

JSON_PROPERTY_FROM

public static final String JSON_PROPERTY_FROM

See Also:

• Constant Field Values

JSON_PROPERTY_AFTER

public static final String JSON_PROPERTY_AFTER

See Also:

• Constant Field Values

JSON_PROPERTY_BEFORE

public static final String JSON_PROPERTY_BEFORE

See Also:

• Constant Field Values

Constructor Details

SearchQueryPageRequest

public SearchQueryPageRequest()

Method Details

limit

public SearchQueryPageRequest limit(@Nullable
 Integer limit)

getLimit

@Nullable
public Integer getLimit()

The maximum number of items to return in one request. minimum: 1 maximum: 10000

Returns:

limit

setLimit

public void setLimit(@Nullable
 Integer limit)

from

public SearchQueryPageRequest from(@Nullable
 Integer from)

getFrom

@Nullable
public Integer getFrom()

The index of items to start searching from. minimum: 0

Returns:

from

setFrom

public void setFrom(@Nullable
 Integer from)

after

public SearchQueryPageRequest after(@Nullable
 String after)

getAfter

@Nullable
public String getAfter()

Use the `endCursor` value from the previous response to fetch the next page of results.

Returns:

after

setAfter

public void setAfter(@Nullable
 String after)

before

public SearchQueryPageRequest before(@Nullable
 String before)

getBefore

@Nullable
public String getBefore()

Use the `startCursor` value from the previous response to fetch the previous page of results.

Returns:

before

setBefore

public void setBefore(@Nullable
 String before)

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