Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference.assignment

Class TrainedModelAssignment

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.assignment.TrainedModelAssignment

All Implemented Interfaces:

Diffable<TrainedModelAssignment>, SimpleDiffable<TrainedModelAssignment>, Writeable, ToXContent, ToXContentObject

public final class TrainedModelAssignment
extends Object
implements SimpleDiffable<TrainedModelAssignment>, ToXContentObject

Trained model assignment object that contains assignment options and the assignment routing table

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TrainedModelAssignment.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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 ParseField	ADAPTIVE_ALLOCATIONS

Fields inherited from interface org.elasticsearch.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
TrainedModelAssignment(StreamInput in)

Method Summary

Modifier and Type	Method	Description
Optional<AllocationStatus>	calculateAllocationStatus()
boolean	equals(Object o)
static TrainedModelAssignment	fromXContent(XContentParser parser)
AdaptiveAllocationsSettings	getAdaptiveAllocationsSettings()
AssignmentState	getAssignmentState()
String	getDeploymentId()
int	getMaxAssignedAllocations()
String	getModelId()
Map<String,RoutingInfo>	getNodeRoutingTable()
Optional<String>	getReason()
String[]	getStartedNodes()
Instant	getStartTime()
StartTrainedModelDeploymentAction.TaskParams	getTaskParams()
int	hashCode()
boolean	hasOutdatedRoutingEntries()
boolean	hasStartedRoutes()
boolean	isRoutedToNode(String nodeId)
boolean	isSatisfied(Set<String> assignableNodeIds)
List<Tuple<String,Integer>>	selectRandomNodesWeighedOnAllocations(int numberOfRequests, RoutingState... acceptableStates)
int	totalCurrentAllocations()
int	totalFailedAllocations()
int	totalTargetAllocations()
int	totalTargetProcessors()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

ADAPTIVE_ALLOCATIONS

public static final ParseField ADAPTIVE_ALLOCATIONS

Constructor Details

TrainedModelAssignment

public TrainedModelAssignment(StreamInput in)
                       throws IOException

Throws:

IOException

Method Details

fromXContent

public static TrainedModelAssignment fromXContent(XContentParser parser)
                                           throws IOException

Throws:

IOException

isRoutedToNode

public boolean isRoutedToNode(String nodeId)

getNodeRoutingTable

public Map<String,RoutingInfo> getNodeRoutingTable()

Returns:

shows where allocations for this assignment/deployment are located (on which nodes)

getModelId

public String getModelId()

getDeploymentId

public String getDeploymentId()

getTaskParams

public StartTrainedModelDeploymentAction.TaskParams getTaskParams()

getAssignmentState

public AssignmentState getAssignmentState()

getStartedNodes

public String[] getStartedNodes()

hasStartedRoutes

public boolean hasStartedRoutes()

selectRandomNodesWeighedOnAllocations

public List<Tuple<String,Integer>> selectRandomNodesWeighedOnAllocations(int numberOfRequests,
 RoutingState... acceptableStates)

getReason

public Optional<String> getReason()

getStartTime

public Instant getStartTime()

getMaxAssignedAllocations

public int getMaxAssignedAllocations()

getAdaptiveAllocationsSettings

public AdaptiveAllocationsSettings getAdaptiveAllocationsSettings()

isSatisfied

public boolean isSatisfied(Set<String> assignableNodeIds)

hasOutdatedRoutingEntries

public boolean hasOutdatedRoutingEntries()

totalCurrentAllocations

public int totalCurrentAllocations()

totalTargetAllocations

public int totalTargetAllocations()

totalTargetProcessors

public int totalTargetProcessors()

totalFailedAllocations

public int totalFailedAllocations()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

calculateAllocationStatus

public Optional<AllocationStatus> calculateAllocationStatus()