Module org.elasticsearch.server

Package org.elasticsearch.inference

Class SettingsConfiguration

java.lang.Object

org.elasticsearch.inference.SettingsConfiguration

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class SettingsConfiguration
extends Object
implements Writeable, ToXContentObject

Represents the configuration field settings for an inference provider.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SettingsConfiguration.Builder

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 inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SettingsConfiguration(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static SettingsConfiguration	fromXContent(XContentParser parser)
static SettingsConfiguration	fromXContentBytes(BytesReference source, XContentType xContentType)
Object	getDefaultValue()
String	getDescription()
String	getLabel()
Set<TaskType>	getSupportedTaskTypes()
SettingsConfigurationFieldType	getType()
int	hashCode()
boolean	isRequired()
boolean	isSensitive()
boolean	isUpdatable()
Map<String,Object>	toMap()
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, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

SettingsConfiguration

public SettingsConfiguration(StreamInput in)
                      throws IOException

Throws:

IOException

Method Details

getDefaultValue

public Object getDefaultValue()

getDescription

public String getDescription()

getLabel

public String getLabel()

isRequired

public boolean isRequired()

isSensitive

public boolean isSensitive()

isUpdatable

public boolean isUpdatable()

getType

public SettingsConfigurationFieldType getType()

getSupportedTaskTypes

public Set<TaskType> getSupportedTaskTypes()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static SettingsConfiguration fromXContent(XContentParser parser)
                                          throws IOException

Throws:

IOException

fromXContentBytes

public static SettingsConfiguration fromXContentBytes(BytesReference source,
 XContentType xContentType)

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

toMap

public Map<String,Object> toMap()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object