Module org.elasticsearch.server

Package org.elasticsearch.inference.metadata

Record Class EndpointMetadata.Internal

java.lang.Object

java.lang.Record

org.elasticsearch.inference.metadata.EndpointMetadata.Internal

Record Components:

fingerprint - an upstream fingerprint representing endpoint version. The upstream service controls this to indicate that known fields have changed (new properties for a model, status, etc).

version - a schema version number for the metadata. This version is incremented when the structure of the metadata changes (e.g., new fields are added). This allows Elasticsearch to determine when it needs to update the metadata even if the upstream fingerprint is not changed. This is useful when the fingerprint has already changed but older Elasticsearch versions don't have the logic to handle a new field returned by the upstream service. This value allows Elasticsearch to determine which endpoints need to have their schema updated in a new version.

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

EndpointMetadata

public static record EndpointMetadata.Internal(String fingerprint, Long version)
extends Record
implements ToXContentObject, Writeable

Internal metadata used by Elasticsearch. This information is not exposed to clients of the Inference API. It helps the Inference API know when it needs to update the preconfigured endpoints.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 EndpointMetadata.Internal	EMPTY_INSTANCE
static final String	FINGERPRINT_FIELD_NAME
static final String	VERSION_FIELD_NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Internal(String fingerprint, Long version)	Creates an instance of a Internal record class.
Internal(StreamInput in)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	fingerprint()	Returns the value of the fingerprint record component.
final int	hashCode()	Returns a hash code value for this object.
boolean	isEmpty()
static EndpointMetadata.Internal	parse(XContentParser parser)
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Long	version()	Returns the value of the version record component.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

EMPTY_INSTANCE

public static final EndpointMetadata.Internal EMPTY_INSTANCE

FINGERPRINT_FIELD_NAME

public static final String FINGERPRINT_FIELD_NAME

See Also:

• Constant Field Values

VERSION_FIELD_NAME

public static final String VERSION_FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

Internal

public Internal(StreamInput in)
         throws IOException

Throws:

IOException

Internal

public Internal(@Nullable
 String fingerprint,
 @Nullable
 Long version)

Creates an instance of a Internal record class.

Parameters:

fingerprint - the value for the fingerprint record component

version - the value for the version record component

Method Details

parse

public static EndpointMetadata.Internal parse(XContentParser parser)
                                       throws IOException

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

isEmpty

public boolean isEmpty()

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.

fingerprint

@Nullable
public String fingerprint()

Returns the value of the fingerprint record component.

Returns:

the value of the fingerprint record component

version

@Nullable
public Long version()

Returns the value of the version record component.

Returns:

the value of the version record component