Module org.elasticsearch.server

Package org.elasticsearch.inference

Record Class EmptyTaskSettings

java.lang.Object

java.lang.Record

org.elasticsearch.inference.EmptyTaskSettings

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, TaskSettings, ToXContent, ToXContentObject

public record EmptyTaskSettings()
extends Record
implements TaskSettings

This class defines an empty task settings object. This is useful for services that do not have any task settings.

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 EmptyTaskSettings	INSTANCE
static final String	NAME

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
EmptyTaskSettings()	Creates an instance of a EmptyTaskSettings record class.
EmptyTaskSettings(StreamInput in)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
final int	hashCode()	Returns a hash code value for this object.
boolean	isEmpty()
final String	toString()	Returns a string representation of this record class.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
TaskSettings	updatedTaskSettings(Map<String,Object> newSettings)
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

NAME

public static final String NAME

See Also:

• Constant Field Values

INSTANCE

public static final EmptyTaskSettings INSTANCE

Constructor Details

EmptyTaskSettings

public EmptyTaskSettings(StreamInput in)

EmptyTaskSettings

public EmptyTaskSettings()

Creates an instance of a EmptyTaskSettings record class.

Method Details

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface TaskSettings

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

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

updatedTaskSettings

public TaskSettings updatedTaskSettings(Map<String,Object> newSettings)

Specified by:

updatedTaskSettings in interface TaskSettings

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.

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.