Package org.opensearch.data.client.osc

Record Class Aggregation

java.lang.Object
java.lang.Record
org.opensearch.data.client.osc.Aggregation
public record Aggregation(String name, org.opensearch.client.opensearch._types.aggregations.Aggregate aggregate) extends Record
Class to combine an OpenSearch Aggregate with its name. Necessary as the OpenSearch Aggregate does not know its name.
Since:
4.4

  • Constructor Summary

    Constructors
    Constructor
    Description
    Aggregation(String name, org.opensearch.client.opensearch._types.aggregations.Aggregate aggregate)
    Creates an instance of a Aggregation record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opensearch.client.opensearch._types.aggregations.Aggregate
    aggregate()
    Returns the value of the aggregate record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    org.opensearch.client.opensearch._types.aggregations.Aggregate
    getAggregate()
    Deprecated.
    Use aggregate() instead
    String
    getName()
    Deprecated.
    Use name() instead
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    name()
    Returns the value of the name 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

    • Aggregation

      public Aggregation(String name, org.opensearch.client.opensearch._types.aggregations.Aggregate aggregate)
      Creates an instance of a Aggregation record class.
      Parameters:
      name - the value for the name record component
      aggregate - the value for the aggregate record component

  • Method Details

    • getName

      @Deprecated public String getName()
      Deprecated.
      Use name() instead

    • getAggregate

      @Deprecated public org.opensearch.client.opensearch._types.aggregations.Aggregate getAggregate()
      Deprecated.
      Use aggregate() instead

    • 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

    • aggregate

      public org.opensearch.client.opensearch._types.aggregations.Aggregate aggregate()
      Returns the value of the aggregate record component.
      Returns:
      the value of the aggregate record component