Module org.elasticsearch.xcore
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.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionInferenceContext(String productUseCase) Creates an instance of aInferenceContextrecord class. -
Method Summary
Modifier and TypeMethodDescriptionbooleanIndicates whether some other object is "equal to" this one.inthashCode()Returns a hash code value for this object.Returns the value of theproductUseCaserecord component.final StringtoString()Returns a string representation of this record class.org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContent
isFragment
-
Field Details
-
EMPTY_INSTANCE
-
-
Constructor Details
-
InferenceContext
Creates an instance of aInferenceContextrecord class.- Parameters:
productUseCase- the value for theproductUseCaserecord component
-
InferenceContext
- Throws:
IOException
-
-
Method Details
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
equals
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 withObjects::equals(Object,Object). -
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. -
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. -
productUseCase
Returns the value of theproductUseCaserecord component.- Returns:
- the value of the
productUseCaserecord component
-