Package io.camunda.search.clients.core

Record Class AggregationResult

java.lang.Object

java.lang.Record

io.camunda.search.clients.core.AggregationResult

public record AggregationResult(Long docCount, Map<String,AggregationResult> aggregations, List<SearchQueryHit> hits, String endCursor)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	AggregationResult.Builder

Constructor Summary

Constructors

Constructor	Description
AggregationResult(Long docCount, Map<String,AggregationResult> aggregations)
AggregationResult(Long docCount, Map<String,AggregationResult> aggregations, List<SearchQueryHit> hits, String endCursor)	Creates an instance of a AggregationResult record class.

Method Summary

Modifier and Type	Method	Description
Map<String,AggregationResult>	aggregations()	Returns the value of the aggregations record component.
Long	docCount()	Returns the value of the docCount record component.
String	endCursor()	Returns the value of the endCursor 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>	hits()	Returns the value of the hits 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

AggregationResult

public AggregationResult(Long docCount,
 Map<String,AggregationResult> aggregations)

AggregationResult

public AggregationResult(Long docCount,
 Map<String,AggregationResult> aggregations,
 List<SearchQueryHit> hits,
 String endCursor)

Creates an instance of a AggregationResult record class.

Parameters:

docCount - the value for the docCount record component

aggregations - the value for the aggregations record component

hits - the value for the hits record component

endCursor - the value for the endCursor record component

Method Details

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.

docCount

public Long docCount()

Returns the value of the docCount record component.

Returns:

the value of the docCount record component

aggregations

public Map<String,AggregationResult> aggregations()

Returns the value of the aggregations record component.

Returns:

the value of the aggregations record component

hits

public List<SearchQueryHit> hits()

Returns the value of the hits record component.

Returns:

the value of the hits record component

endCursor

public String endCursor()

Returns the value of the endCursor record component.

Returns:

the value of the endCursor record component