Module org.elasticsearch.server

Package org.elasticsearch.inference

Record Class UnifiedCompletionRequest.Tool

java.lang.Object

java.lang.Record

org.elasticsearch.inference.UnifiedCompletionRequest.Tool

All Implemented Interfaces:

Writeable

Enclosing class:

UnifiedCompletionRequest

public static record UnifiedCompletionRequest.Tool(String type, UnifiedCompletionRequest.Tool.FunctionField function)
extends Record
implements Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	UnifiedCompletionRequest.Tool.FunctionField

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
Tool(String type, UnifiedCompletionRequest.Tool.FunctionField function)	Creates an instance of a Tool record class.
Tool(StreamInput in)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
UnifiedCompletionRequest.Tool.FunctionField	function()	Returns the value of the function record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type 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

Constructor Details

Tool

public Tool(StreamInput in)
     throws IOException

Throws:

IOException

Tool

public Tool(String type,
 UnifiedCompletionRequest.Tool.FunctionField function)

Creates an instance of a Tool record class.

Parameters:

type - the value for the type record component

function - the value for the function record component

Method Details

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

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.

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

function

public UnifiedCompletionRequest.Tool.FunctionField function()

Returns the value of the function record component.

Returns:

the value of the function record component