Module org.elasticsearch.server

Package org.elasticsearch.inference.metadata

Record Class EndpointMetadata.Display

java.lang.Object

java.lang.Record

org.elasticsearch.inference.metadata.EndpointMetadata.Display

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

Enclosing class:

EndpointMetadata

public static record EndpointMetadata.Display(String name, String modelCreator)
extends Record
implements ToXContentObject, Writeable

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.Display	EMPTY_INSTANCE
static final TransportVersion	MODEL_CREATOR_ADDED
static final String	MODEL_CREATOR_FIELD
static final String	NAME_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Display(String name, String modelCreator)	Creates an instance of a Display record class.
Display(StreamInput in)

Method Summary

Modifier and Type	Method	Description
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()
String	modelCreator()	Returns the value of the modelCreator record component.
String	name()	Returns the value of the name record component.
static EndpointMetadata.Display	parse(XContentParser parser)
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.Display EMPTY_INSTANCE

NAME_FIELD

public static final String NAME_FIELD

See Also:

• Constant Field Values

MODEL_CREATOR_FIELD

public static final String MODEL_CREATOR_FIELD

See Also:

• Constant Field Values

MODEL_CREATOR_ADDED

public static final TransportVersion MODEL_CREATOR_ADDED

Constructor Details

Display

public Display(StreamInput in)
        throws IOException

Throws:

IOException

Display

public Display(@Nullable
 String name,
 @Nullable
 String modelCreator)

Creates an instance of a Display record class.

Parameters:

name - the value for the name record component

modelCreator - the value for the modelCreator record component

Method Details

parse

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

name

@Nullable
public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

modelCreator

@Nullable
public String modelCreator()

Returns the value of the modelCreator record component.

Returns:

the value of the modelCreator record component