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, org.elasticsearch.xcontent.ToXContent

public record InferenceContext(String productUseCase) extends Record implements Writeable, org.elasticsearch.xcontent.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.
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    Writeable.Reader<V>, Writeable.Writer<V>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final InferenceContext
     

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
    InferenceContext(String productUseCase)
    Creates an instance of a InferenceContext record class.
     
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Indicates whether some other object is "equal to" this one.
    int
    Returns a hash code value for this object.
    Returns the value of the productUseCase record component.
    final String
    Returns a string representation of this record class.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    void
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.xcontent.ToXContent

    isFragment
  • 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 org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.xcontent.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