Package io.camunda.search.clients.aggregator

Record Class SearchTopHitsAggregator<T>

java.lang.Object

java.lang.Record

io.camunda.search.clients.aggregator.SearchTopHitsAggregator<T>

All Implemented Interfaces:

SearchAggregator

public record SearchTopHitsAggregator<T>(String name, String field, Integer size, List<SearchAggregator> aggregations, Class<T> documentClass)
extends Record
implements SearchAggregator

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from interface io.camunda.search.clients.aggregator.SearchAggregator

SearchAggregator.AbstractBuilder<T>

Constructor Summary

Constructors

Constructor	Description
SearchTopHitsAggregator(String name, String field, Integer size, List<SearchAggregator> aggregations, Class<T> documentClass)	Creates an instance of a SearchTopHitsAggregator record class.

Method Summary

Modifier and Type	Method	Description
List<SearchAggregator>	aggregations()	Returns the value of the aggregations record component.
Class<T>	documentClass()	Returns the value of the documentClass record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	field()	Returns the value of the field record component.
List<SearchAggregator>	getAggregations()
String	getName()
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
Integer	size()	Returns the value of the size 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

SearchTopHitsAggregator

public SearchTopHitsAggregator(String name,
 String field,
 Integer size,
 List<SearchAggregator> aggregations,
 Class<T> documentClass)

Creates an instance of a SearchTopHitsAggregator record class.

Parameters:

name - the value for the name record component

field - the value for the field record component

size - the value for the size record component

aggregations - the value for the aggregations record component

documentClass - the value for the documentClass record component

Method Details

getName

public String getName()

Specified by:

getName in interface SearchAggregator

getAggregations

public List<SearchAggregator> getAggregations()

Specified by:

getAggregations in interface SearchAggregator

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.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

field

public String field()

Returns the value of the field record component.

Returns:

the value of the field record component

size

public Integer size()

Returns the value of the size record component.

Returns:

the value of the size record component

aggregations

public List<SearchAggregator> aggregations()

Returns the value of the aggregations record component.

Returns:

the value of the aggregations record component

documentClass

public Class<T> documentClass()

Returns the value of the documentClass record component.

Returns:

the value of the documentClass record component