Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.action

Class InferTrainedModelDeploymentAction.Request

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.AbstractTransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.UntypedActionRequest

org.elasticsearch.action.support.tasks.BaseTasksRequest<InferTrainedModelDeploymentAction.Request>

org.elasticsearch.xpack.core.ml.action.InferTrainedModelDeploymentAction.Request

All Implemented Interfaces:

Writeable, RefCounted, TaskAwareRequest, TransportRequest

Enclosing class:

InferTrainedModelDeploymentAction

public static class InferTrainedModelDeploymentAction.Request
extends BaseTasksRequest<InferTrainedModelDeploymentAction.Request>

Request for inference against the deployment. The task gets routed to a node that indicates its local model assignment is started For indicating timeout, the caller should call `setInferenceTimeout` and not the base class `setTimeout` method

Nested Class Summary

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 TimeValue	DEFAULT_TIMEOUT
static final ParseField	DOCS
static final ParseField	TIMEOUT

Fields inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest

ALL_ACTIONS, ALL_NODES

Fields inherited from interface org.elasticsearch.core.RefCounted

ALWAYS_REFERENCED

Constructor Summary

Constructors

Constructor	Description
Request(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Task	createTask(long id, String type, String action, TaskId parentTaskId, Map<String,String> headers)
boolean	equals(Object o)
static InferTrainedModelDeploymentAction.Request	forDocs(String id, InferenceConfigUpdate update, List<Map<String,Object>> docs, TimeValue inferenceTimeout)
static InferTrainedModelDeploymentAction.Request	forTextInput(String id, InferenceConfigUpdate update, List<String> textInput, TimeValue inferenceTimeout)
List<Map<String,Object>>	getDocs()
String	getId()
TimeValue	getInferenceTimeout()
TrainedModelPrefixStrings.PrefixType	getPrefixType()
List<String>	getTextInput()
TimeValue	getTimeout()	This is always null as we want the inference call to handle the timeout, not the tasks framework
InferenceConfigUpdate	getUpdate()
int	hashCode()
boolean	isChunkResults()
boolean	isHighPriority()
boolean	match(Task task)
void	setChunkResults(boolean chunkResults)
void	setHighPriority(boolean highPriority)
void	setId(String id)
void	setPrefixType(TrainedModelPrefixStrings.PrefixType prefixType)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)

Methods inherited from class org.elasticsearch.action.support.tasks.BaseTasksRequest

canMatchAction, copyFieldsFrom, getActions, getNodes, getParentTaskId, getTargetParentTaskId, getTargetTaskId, getTaskId, matchesActionAndParent, setActions, setNodes, setParentTaskId, setTargetParentTaskId, setTargetTaskId, setTaskId, setTimeout

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, getDescription, setParentTask

Field Details

DOCS

public static final ParseField DOCS

TIMEOUT

public static final ParseField TIMEOUT

DEFAULT_TIMEOUT

public static final TimeValue DEFAULT_TIMEOUT

Constructor Details

Request

public Request(StreamInput in)
        throws IOException

Throws:

IOException

Method Details

forDocs

public static InferTrainedModelDeploymentAction.Request forDocs(String id,
 InferenceConfigUpdate update,
 List<Map<String,Object>> docs,
 TimeValue inferenceTimeout)

forTextInput

public static InferTrainedModelDeploymentAction.Request forTextInput(String id,
 InferenceConfigUpdate update,
 List<String> textInput,
 TimeValue inferenceTimeout)

getId

public String getId()

getDocs

public List<Map<String,Object>> getDocs()

getTextInput

public List<String> getTextInput()

getUpdate

public InferenceConfigUpdate getUpdate()

getInferenceTimeout

public TimeValue getInferenceTimeout()

setId

public void setId(String id)

getTimeout

@Nullable
public TimeValue getTimeout()

This is always null as we want the inference call to handle the timeout, not the tasks framework

Overrides:

getTimeout in class BaseTasksRequest<InferTrainedModelDeploymentAction.Request>

Returns:

null

setHighPriority

public void setHighPriority(boolean highPriority)

isHighPriority

public boolean isHighPriority()

setPrefixType

public void setPrefixType(TrainedModelPrefixStrings.PrefixType prefixType)

getPrefixType

public TrainedModelPrefixStrings.PrefixType getPrefixType()

isChunkResults

public boolean isChunkResults()

setChunkResults

public void setChunkResults(boolean chunkResults)

validate

public ActionRequestValidationException validate()

Overrides:

validate in class BaseTasksRequest<InferTrainedModelDeploymentAction.Request>

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseTasksRequest<InferTrainedModelDeploymentAction.Request>

Throws:

IOException

match

public boolean match(Task task)

Overrides:

match in class BaseTasksRequest<InferTrainedModelDeploymentAction.Request>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

createTask

public Task createTask(long id,
 String type,
 String action,
 TaskId parentTaskId,
 Map<String,String> headers)