Module org.elasticsearch.server

Package org.elasticsearch.inference

Record Class UnifiedCompletionRequest.ToolChoiceString

java.lang.Object

java.lang.Record

org.elasticsearch.inference.UnifiedCompletionRequest.ToolChoiceString

All Implemented Interfaces:

NamedWriteable, Writeable, UnifiedCompletionRequest.ToolChoice, ToXContent

Enclosing class:

UnifiedCompletionRequest

public static record UnifiedCompletionRequest.ToolChoiceString(String value)
extends Record
implements UnifiedCompletionRequest.ToolChoice, NamedWriteable

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 String	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ToolChoiceString(String value)	Creates an instance of a ToolChoiceString record class.
ToolChoiceString(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	getWriteableName()	Returns the name of the writeable object
final int	hashCode()	Returns a hash code value for this object.
static UnifiedCompletionRequest.ToolChoiceString	of(XContentParser parser)
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
String	value()	Returns the value of the value 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.ToXContent

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

ToolChoiceString

public ToolChoiceString(StreamInput in)
                 throws IOException

Throws:

IOException

ToolChoiceString

public ToolChoiceString(String value)

Creates an instance of a ToolChoiceString record class.

Parameters:

value - the value for the value record component

Method Details

of

public static UnifiedCompletionRequest.ToolChoiceString of(XContentParser parser)
                                                    throws IOException

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

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

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.

value

public String value()

Returns the value of the value record component.

Returns:

the value of the value record component