Package io.camunda.service.search.query

Record Class ProcessInstanceQuery

java.lang.Object

java.lang.Record

io.camunda.service.search.query.ProcessInstanceQuery

All Implemented Interfaces:

SearchQueryBase, TypedSearchQuery<ProcessInstanceFilter,ProcessInstanceSort>

public record ProcessInstanceQuery(ProcessInstanceFilter filter, ProcessInstanceSort sort, SearchQueryPage page, QueryResultConfig resultConfig)
extends Record
implements TypedSearchQuery<ProcessInstanceFilter,ProcessInstanceSort>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ProcessInstanceQuery.Builder

Nested classes/interfaces inherited from interface io.camunda.service.search.query.SearchQueryBase

SearchQueryBase.AbstractQueryBuilder<T extends SearchQueryBase.AbstractQueryBuilder<T>>

Constructor Summary

Constructors

Constructor	Description
ProcessInstanceQuery(ProcessInstanceFilter filter, ProcessInstanceSort sort, SearchQueryPage page, QueryResultConfig resultConfig)	Creates an instance of a ProcessInstanceQuery record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ProcessInstanceFilter	filter()	Returns the value of the filter record component.
final int	hashCode()	Returns a hash code value for this object.
static ProcessInstanceQuery	of(Function<ProcessInstanceQuery.Builder,ObjectBuilder<ProcessInstanceQuery>> fn)
SearchQueryPage	page()	Returns the value of the page record component.
QueryResultConfig	resultConfig()	Returns the value of the resultConfig record component.
ProcessInstanceSort	sort()	Returns the value of the sort record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

ProcessInstanceQuery

public ProcessInstanceQuery(ProcessInstanceFilter filter,
 ProcessInstanceSort sort,
 SearchQueryPage page,
 QueryResultConfig resultConfig)

Creates an instance of a ProcessInstanceQuery record class.

Parameters:

filter - the value for the filter record component

sort - the value for the sort record component

page - the value for the page record component

resultConfig - the value for the resultConfig record component

Method Details

of

public static ProcessInstanceQuery of(Function<ProcessInstanceQuery.Builder,ObjectBuilder<ProcessInstanceQuery>> fn)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

filter

public ProcessInstanceFilter filter()

Returns the value of the filter record component.

Specified by:

filter in interface TypedSearchQuery<ProcessInstanceFilter,ProcessInstanceSort>

Returns:

the value of the filter record component

sort

public ProcessInstanceSort sort()

Returns the value of the sort record component.

Specified by:

sort in interface TypedSearchQuery<ProcessInstanceFilter,ProcessInstanceSort>

Returns:

the value of the sort record component

page

public SearchQueryPage page()

Returns the value of the page record component.

Specified by:

page in interface SearchQueryBase

Returns:

the value of the page record component

resultConfig

public QueryResultConfig resultConfig()

Returns the value of the resultConfig record component.

Specified by:

resultConfig in interface TypedSearchQuery<ProcessInstanceFilter,ProcessInstanceSort>

Returns:

the value of the resultConfig record component