Package org.opensearch.data.client.orhlc

Record Class ScriptField

java.lang.Object
java.lang.Record
org.opensearch.data.client.orhlc.ScriptField
public record ScriptField(String fieldName, org.opensearch.script.Script script) extends Record
Scripted field
Since:
0.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScriptField(String fieldName, org.opensearch.script.Script script)
    Creates an instance of a ScriptField record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    String
    fieldName()
    Returns the value of the fieldName record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    org.opensearch.script.Script
    script()
    Returns the value of the script 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

    • ScriptField

      public ScriptField(String fieldName, org.opensearch.script.Script script)
      Creates an instance of a ScriptField record class.
      Parameters:
      fieldName - the value for the fieldName record component
      script - the value for the script 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.

    • fieldName

      public String fieldName()
      Returns the value of the fieldName record component.
      Returns:
      the value of the fieldName record component

    • script

      public org.opensearch.script.Script script()
      Returns the value of the script record component.
      Returns:
      the value of the script record component