Package io.camunda.search.clients.core

Record Class SearchQueryResponse<T>

java.lang.Object

java.lang.Record

io.camunda.search.clients.core.SearchQueryResponse<T>

public record SearchQueryResponse<T>(long totalHits, String scrollId, List<SearchQueryHit<T>> hits, Map<String,AggregationResult> aggregations)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchQueryResponse.Builder<T>

Constructor Summary

Constructors

Constructor	Description
SearchQueryResponse(long totalHits, String scrollId, List<SearchQueryHit<T>> hits, Map<String,AggregationResult> aggregations)	Creates an instance of a SearchQueryResponse record class.

Method Summary

Modifier and Type	Method	Description
Map<String,AggregationResult>	aggregations()	Returns the value of the aggregations record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
List<SearchQueryHit<T>>	hits()	Returns the value of the hits record component.
static <T> SearchQueryResponse<T>	of(Function<SearchQueryResponse.Builder<T>,ObjectBuilder<SearchQueryResponse<T>>> fn)
String	scrollId()	Returns the value of the scrollId record component.
final String	toString()	Returns a string representation of this record class.
long	totalHits()	Returns the value of the totalHits record component.

Methods inherited from class java.lang.Object

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

Constructor Details

SearchQueryResponse

public SearchQueryResponse(long totalHits,
 String scrollId,
 List<SearchQueryHit<T>> hits,
 Map<String,AggregationResult> aggregations)

Creates an instance of a SearchQueryResponse record class.

Parameters:

totalHits - the value for the totalHits record component

scrollId - the value for the scrollId record component

hits - the value for the hits record component

aggregations - the value for the aggregations record component

Method Details

of

public static <T> SearchQueryResponse<T> of(Function<SearchQueryResponse.Builder<T>,ObjectBuilder<SearchQueryResponse<T>>> 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

totalHits

public long totalHits()

Returns the value of the totalHits record component.

Returns:

the value of the totalHits record component

scrollId

public String scrollId()

Returns the value of the scrollId record component.

Returns:

the value of the scrollId record component

hits

public List<SearchQueryHit<T>> hits()

Returns the value of the hits record component.

Returns:

the value of the hits record component

aggregations

public Map<String,AggregationResult> aggregations()

Returns the value of the aggregations record component.

Returns:

the value of the aggregations record component