Module org.elasticsearch.server

Package org.elasticsearch.inference.metadata

Record Class EndpointMetadata.Heuristics

java.lang.Object

java.lang.Record

org.elasticsearch.inference.metadata.EndpointMetadata.Heuristics

Record Components:

properties - a list of string tags describing the model's properties (e.g., "multilingual", "english", "multimodal", etc)

status - the stability of the model used in the endpoint

releaseDate - the release date of the model used in the endpoint

endOfLifeDate - the end-of-life date of the model used in the endpoint

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

EndpointMetadata

public static record EndpointMetadata.Heuristics(List<String> properties, StatusHeuristic status, LocalDate releaseDate, LocalDate endOfLifeDate)
extends Record
implements ToXContentObject, Writeable

Heuristics about the model used in the endpoint to help clients of the Inference API determine which models to use.

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.Heuristics	EMPTY_INSTANCE
static final String	END_OF_LIFE_DATE_FIELD_NAME
static final String	PROPERTIES_FIELD_NAME
static final String	RELEASE_DATE_FIELD_NAME
static final String	STATUS_FIELD_NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Heuristics(List<String> properties, StatusHeuristic status, String releaseDate, String endOfLifeDate)
Heuristics(List<String> properties, StatusHeuristic status, LocalDate releaseDate, LocalDate endOfLifeDate)	Creates an instance of a Heuristics record class.
Heuristics(StreamInput in)

Method Summary

Modifier and Type	Method	Description
LocalDate	endOfLifeDate()	Returns the value of the endOfLifeDate record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isEmpty()
static EndpointMetadata.Heuristics	parse(XContentParser parser)
List<String>	properties()	Returns the value of the properties record component.
LocalDate	releaseDate()	Returns the value of the releaseDate record component.
StatusHeuristic	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
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.Heuristics EMPTY_INSTANCE

PROPERTIES_FIELD_NAME

public static final String PROPERTIES_FIELD_NAME

See Also:

• Constant Field Values

STATUS_FIELD_NAME

public static final String STATUS_FIELD_NAME

See Also:

• Constant Field Values

RELEASE_DATE_FIELD_NAME

public static final String RELEASE_DATE_FIELD_NAME

See Also:

• Constant Field Values

END_OF_LIFE_DATE_FIELD_NAME

public static final String END_OF_LIFE_DATE_FIELD_NAME

See Also:

• Constant Field Values

Constructor Details

Heuristics

public Heuristics(StreamInput in)
           throws IOException

Throws:

IOException

Heuristics

public Heuristics(List<String> properties,
 @Nullable
 StatusHeuristic status,
 @Nullable
 String releaseDate,
 @Nullable
 String endOfLifeDate)

Heuristics

public Heuristics(List<String> properties,
 @Nullable
 StatusHeuristic status,
 @Nullable
 LocalDate releaseDate,
 @Nullable
 LocalDate endOfLifeDate)

Creates an instance of a Heuristics record class.

Parameters:

properties - the value for the properties record component

status - the value for the status record component

releaseDate - the value for the releaseDate record component

endOfLifeDate - the value for the endOfLifeDate record component

Method Details

parse

public static EndpointMetadata.Heuristics 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.

properties

public List<String> properties()

Returns the value of the properties record component.

Returns:

the value of the properties record component

status

@Nullable
public StatusHeuristic status()

Returns the value of the status record component.

Returns:

the value of the status record component

releaseDate

@Nullable
public LocalDate releaseDate()

Returns the value of the releaseDate record component.

Returns:

the value of the releaseDate record component

endOfLifeDate

@Nullable
public LocalDate endOfLifeDate()

Returns the value of the endOfLifeDate record component.

Returns:

the value of the endOfLifeDate record component