Package io.camunda.client.protocol.rest

Class SearchQueryPageResponse

java.lang.Object

io.camunda.client.protocol.rest.SearchQueryPageResponse

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

Pagination information about the search results.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_END_CURSOR
static final String	JSON_PROPERTY_HAS_MORE_TOTAL_ITEMS
static final String	JSON_PROPERTY_START_CURSOR
static final String	JSON_PROPERTY_TOTAL_ITEMS

Constructor Summary

Constructors

Constructor	Description
SearchQueryPageResponse()

Method Summary

Modifier and Type	Method	Description
SearchQueryPageResponse	endCursor(String endCursor)
boolean	equals(Object o)
String	getEndCursor()	The cursor value for getting the next page of results.
Boolean	getHasMoreTotalItems()	Indicates whether the `totalItems` value has been capped due to system limits.
String	getStartCursor()	The cursor value for getting the previous page of results.
Long	getTotalItems()	Total items matching the criteria.
int	hashCode()
SearchQueryPageResponse	hasMoreTotalItems(Boolean hasMoreTotalItems)
void	setEndCursor(String endCursor)
void	setHasMoreTotalItems(Boolean hasMoreTotalItems)
void	setStartCursor(String startCursor)
void	setTotalItems(Long totalItems)
SearchQueryPageResponse	startCursor(String startCursor)
String	toString()
SearchQueryPageResponse	totalItems(Long totalItems)

Methods inherited from class java.lang.Object

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

Field Details

JSON_PROPERTY_TOTAL_ITEMS

public static final String JSON_PROPERTY_TOTAL_ITEMS

See Also:

• Constant Field Values

JSON_PROPERTY_HAS_MORE_TOTAL_ITEMS

public static final String JSON_PROPERTY_HAS_MORE_TOTAL_ITEMS

See Also:

• Constant Field Values

JSON_PROPERTY_START_CURSOR

public static final String JSON_PROPERTY_START_CURSOR

See Also:

• Constant Field Values

JSON_PROPERTY_END_CURSOR

public static final String JSON_PROPERTY_END_CURSOR

See Also:

• Constant Field Values

Constructor Details

SearchQueryPageResponse

public SearchQueryPageResponse()

Method Details

totalItems

public SearchQueryPageResponse totalItems(@Nonnull
 Long totalItems)

getTotalItems

@Nonnull
public Long getTotalItems()

Total items matching the criteria.

Returns:

totalItems

setTotalItems

public void setTotalItems(@Nonnull
 Long totalItems)

hasMoreTotalItems

public SearchQueryPageResponse hasMoreTotalItems(@Nonnull
 Boolean hasMoreTotalItems)

getHasMoreTotalItems

@Nonnull
public Boolean getHasMoreTotalItems()

Indicates whether the `totalItems` value has been capped due to system limits. When true, `totalItems` is a lower bound and the actual number of matching items is greater than the reported value.

Returns:

hasMoreTotalItems

setHasMoreTotalItems

public void setHasMoreTotalItems(@Nonnull
 Boolean hasMoreTotalItems)

startCursor

public SearchQueryPageResponse startCursor(@Nullable
 String startCursor)

getStartCursor

@Nullable
public String getStartCursor()

The cursor value for getting the previous page of results. Use this in the `before` field of an ensuing request.

Returns:

startCursor

setStartCursor

public void setStartCursor(@Nullable
 String startCursor)

endCursor

public SearchQueryPageResponse endCursor(@Nullable
 String endCursor)

getEndCursor

@Nullable
public String getEndCursor()

The cursor value for getting the next page of results. Use this in the `after` field of an ensuing request.

Returns:

endCursor

setEndCursor

public void setEndCursor(@Nullable
 String endCursor)

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