Module org.elasticsearch.xcore
Package org.elasticsearch.xpack.core.inference

Record Class InferenceContext

java.lang.Object
java.lang.Record
org.elasticsearch.xpack.core.inference.InferenceContext
Record Components:
productUseCase - - for now mainly used by Elastic Inference Service
All Implemented Interfaces:
Writeable, ToXContent
public record InferenceContext(String productUseCase) extends Record implements Writeable, ToXContent
Record for storing context alongside an inference request, typically used for metadata. This is mainly used to pass along inference context on the transport layer without relying on ThreadContext, which depending on the internal Client throws away parts of the context, when passed along the transport layer.

  • Field Details

  • Constructor Details

    • InferenceContext

      public InferenceContext(String productUseCase)
      Creates an instance of a InferenceContext record class.
      Parameters:
      productUseCase - the value for the productUseCase record component

    • InferenceContext

      public InferenceContext(StreamInput in) throws IOException
      Throws:
      IOException

  • Method Details

    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • toXContent

      public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface ToXContent
      Throws:
      IOException

    • equals

      public 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.

    • hashCode

      public 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

    • 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

    • productUseCase

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