Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.action

Class UpdateInferenceModelAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<UpdateInferenceModelAction.Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<UpdateInferenceModelAction.Request>

org.elasticsearch.xpack.core.inference.action.UpdateInferenceModelAction.Request

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

Enclosing class:

UpdateInferenceModelAction

public static class UpdateInferenceModelAction.Request
extends AcknowledgedRequest<UpdateInferenceModelAction.Request>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

AcknowledgedRequest.Plain

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

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

Field Summary

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUT

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(String inferenceEntityId, BytesReference content, XContentType contentType, TaskType taskType, TimeValue timeout, TimeValue masterNodeTimeout, TimeValue ackTimeout)
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
TaskType	getBodyTaskType()	Returns the task_type declared in the request body, or null if it was not present.
Map<String,Object>	getChunkingSettings()	Returns the chunking_settings block from the request body as a fresh, modifiable deep copy of the parsed content (or null if the body did not include any).
BytesReference	getContent()	The body of the request.
XContentType	getContentType()
String	getInferenceEntityId()
Map<String,Object>	getServiceSettings()	Returns the service_settings block from the request body as a fresh, modifiable deep copy of the parsed content (or null if the body did not include any).
Map<String,Object>	getTaskSettings()	Returns the task_settings block from the request body as a fresh, modifiable deep copy of the parsed content (or null if the body did not include any).
TaskType	getTaskType()
TimeValue	getTimeout()
int	hashCode()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

ackTimeout, ackTimeout, validate

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

masterNodeTimeout, masterNodeTimeout, masterTerm

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.AbstractTransportRequest

copyFieldsFrom, getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toString

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.core.RefCounted

decRef, hasReferences, incRef, mustIncRef, tryIncRef

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, createTask, getDescription, setParentTask

Constructor Details

Request

public Request(String inferenceEntityId,
 BytesReference content,
 XContentType contentType,
 TaskType taskType,
 @Nullable
 TimeValue timeout,
 TimeValue masterNodeTimeout,
 TimeValue ackTimeout)

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

getInferenceEntityId

public String getInferenceEntityId()

getTaskType

public TaskType getTaskType()

getTimeout

public TimeValue getTimeout()

getContent

public BytesReference getContent()

The body of the request. For in-cluster models, this is expected to contain some of the following: "number_of_allocations": `an integer` For third-party services, this is expected to contain: "service_settings": { "api_key": `a string` // service settings can only contain an api key } "task_settings": { a map of settings }

getServiceSettings

@Nullable
public Map<String,Object> getServiceSettings()

Returns the service_settings block from the request body as a fresh, modifiable deep copy of the parsed content (or null if the body did not include any).

Each invocation returns a new map instance so callers (notably the *Settings.update* parsers in the inference services) may freely call remove(...) at any depth without risking corruption of the cached state or interference between consumers reading the same body.

getTaskSettings

@Nullable
public Map<String,Object> getTaskSettings()

Returns the task_settings block from the request body as a fresh, modifiable deep copy of the parsed content (or null if the body did not include any).

getChunkingSettings

@Nullable
public Map<String,Object> getChunkingSettings()

Returns the chunking_settings block from the request body as a fresh, modifiable deep copy of the parsed content (or null if the body did not include any).

getBodyTaskType

@Nullable
public TaskType getBodyTaskType()

Returns the task_type declared in the request body, or null if it was not present. Distinct from getTaskType(), which returns the task type taken from the request URL.

getContentType

public XContentType getContentType()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<UpdateInferenceModelAction.Request>

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object