java.lang.Object
org.elasticsearch.xpack.core.ml.MlTasks
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final PersistentTasksCustomMetadata.Assignmentstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringA set of all ML persistent tasks that have an associated native process.static final Stringstatic final Stringstatic final org.elasticsearch.core.TimeValuestatic final PersistentTasksCustomMetadata.Assignmentstatic final Stringstatic final String -
Method Summary
Modifier and TypeMethodDescriptionstatic StringdatafeedTaskId(String datafeedId) Namespaces the task ids for datafeeds.datafeedTasksOnNode(PersistentTasksCustomMetadata tasks, String nodeId) static StringdataFrameAnalyticsId(String taskId) static StringNamespaces the task ids for data frame analytics.static StringdownloadModelTaskDescription(String modelId) Builds the task description from the model id that initiated the task.static Set<PersistentTasksCustomMetadata.PersistentTask<?>> static DatafeedStategetDatafeedState(String datafeedId, PersistentTasksCustomMetadata tasks) static DatafeedStategetDatafeedTask(String datafeedId, PersistentTasksCustomMetadata tasks) static DataFrameAnalyticsStategetDataFrameAnalyticsState(String analyticsId, PersistentTasksCustomMetadata tasks) static DataFrameAnalyticsStategetDataFrameAnalyticsTask(String analyticsId, PersistentTasksCustomMetadata tasks) static JobStategetJobState(String jobId, PersistentTasksCustomMetadata tasks) Note that the return value of this method does NOT take node relocations into account.static JobStatestatic JobStategetJobTask(String jobId, PersistentTasksCustomMetadata tasks) static InstantgetLastDataFrameAnalyticsTaskStateChangeTime(String analyticsId, PersistentTasksCustomMetadata tasks) static InstantgetLastJobTaskStateChangeTime(String jobId, PersistentTasksCustomMetadata tasks) static MemoryTrackedTaskStategetSnapshotUpgraderTask(String jobId, String snapshotId, PersistentTasksCustomMetadata tasks) static SnapshotUpgradeStategetSnapshotUpgradeState(String jobId, String snapshotId, PersistentTasksCustomMetadata tasks) static SnapshotUpgradeStatestatic Stringstatic StringNamespaces the task ids for jobs.jobTasksOnNode(PersistentTasksCustomMetadata tasks, String nodeId) nonFailedJobTasksOnNode(PersistentTasksCustomMetadata tasks, String nodeId) The job Ids of anomaly detector job tasks.static StringprettyPrintTaskName(String taskName) static StringsnapshotUpgradeTaskId(String jobId, String snapshotId) snapshotUpgradeTasksOnNode(PersistentTasksCustomMetadata tasks, String nodeId) The datafeed Ids of started datafeed tasksstatic StringtrainedModelAssignmentTaskDescription(String deploymentId) unassignedDatafeedIds(PersistentTasksCustomMetadata tasks, DiscoveryNodes nodes) Get the datafeed Ids of started datafeed tasks that do not have an assignment.The datafeed tasks that do not have an assignment as determined byPersistentTasksClusterService.needsReassignment(PersistentTasksCustomMetadata.Assignment, DiscoveryNodes)unassignedJobIds(PersistentTasksCustomMetadata tasks, DiscoveryNodes nodes) Get the job Ids of anomaly detector job tasks that do not have an assignment.unassignedJobTasks(PersistentTasksCustomMetadata tasks, DiscoveryNodes nodes) The job tasks that do not have an assignment as determined byPersistentTasksClusterService.needsReassignment(PersistentTasksCustomMetadata.Assignment, DiscoveryNodes)
-
Field Details
-
MODEL_IMPORT_TASK_TYPE
- See Also:
-
MODEL_IMPORT_TASK_ACTION
- See Also:
-
TRAINED_MODEL_ASSIGNMENT_TASK_TYPE
- See Also:
-
TRAINED_MODEL_ASSIGNMENT_TASK_ACTION
- See Also:
-
JOB_TASK_NAME
- See Also:
-
DATAFEED_TASK_NAME
- See Also:
-
DATA_FRAME_ANALYTICS_TASK_NAME
- See Also:
-
JOB_SNAPSHOT_UPGRADE_TASK_NAME
- See Also:
-
ML_PROCESS_TASKS
A set of all ML persistent tasks that have an associated native process. -
JOB_TASK_ID_PREFIX
- See Also:
-
DATAFEED_TASK_ID_PREFIX
- See Also:
-
DATA_FRAME_ANALYTICS_TASK_ID_PREFIX
- See Also:
-
JOB_SNAPSHOT_UPGRADE_TASK_ID_PREFIX
- See Also:
-
AWAITING_UPGRADE
-
RESET_IN_PROGRESS
-
PERSISTENT_TASK_MASTER_NODE_TIMEOUT
public static final org.elasticsearch.core.TimeValue PERSISTENT_TASK_MASTER_NODE_TIMEOUT
-
-
Method Details
-
jobTaskId
Namespaces the task ids for jobs. A datafeed id can be used as a job id, because they are stored separately in cluster state. -
jobId
-
datafeedTaskId
Namespaces the task ids for datafeeds. A job id can be used as a datafeed id, because they are stored separately in cluster state. -
snapshotUpgradeTaskId
-
dataFrameAnalyticsTaskId
Namespaces the task ids for data frame analytics. -
dataFrameAnalyticsId
-
trainedModelAssignmentTaskDescription
-
getJobTask
@Nullable public static PersistentTasksCustomMetadata.PersistentTask<?> getJobTask(String jobId, @Nullable PersistentTasksCustomMetadata tasks) -
getDatafeedTask
@Nullable public static PersistentTasksCustomMetadata.PersistentTask<?> getDatafeedTask(String datafeedId, @Nullable PersistentTasksCustomMetadata tasks) -
getDataFrameAnalyticsTask
@Nullable public static PersistentTasksCustomMetadata.PersistentTask<?> getDataFrameAnalyticsTask(String analyticsId, @Nullable PersistentTasksCustomMetadata tasks) -
getSnapshotUpgraderTask
@Nullable public static PersistentTasksCustomMetadata.PersistentTask<?> getSnapshotUpgraderTask(String jobId, String snapshotId, @Nullable PersistentTasksCustomMetadata tasks) -
getJobState
Note that the return value of this method does NOT take node relocations into account. UsegetJobStateModifiedForReassignments(java.lang.String, org.elasticsearch.persistent.PersistentTasksCustomMetadata)to return a value adjusted to the most appropriate value following relocations. -
getJobStateModifiedForReassignments
public static JobState getJobStateModifiedForReassignments(String jobId, @Nullable PersistentTasksCustomMetadata tasks) -
getJobStateModifiedForReassignments
public static JobState getJobStateModifiedForReassignments(@Nullable PersistentTasksCustomMetadata.PersistentTask<?> task) -
getLastJobTaskStateChangeTime
public static Instant getLastJobTaskStateChangeTime(String jobId, @Nullable PersistentTasksCustomMetadata tasks) -
getSnapshotUpgradeState
public static SnapshotUpgradeState getSnapshotUpgradeState(String jobId, String snapshotId, @Nullable PersistentTasksCustomMetadata tasks) -
getSnapshotUpgradeState
public static SnapshotUpgradeState getSnapshotUpgradeState(@Nullable PersistentTasksCustomMetadata.PersistentTask<?> task) -
getDatafeedState
public static DatafeedState getDatafeedState(String datafeedId, @Nullable PersistentTasksCustomMetadata tasks) -
getDatafeedState
-
getDataFrameAnalyticsState
public static DataFrameAnalyticsState getDataFrameAnalyticsState(String analyticsId, @Nullable PersistentTasksCustomMetadata tasks) -
getDataFrameAnalyticsState
public static DataFrameAnalyticsState getDataFrameAnalyticsState(@Nullable PersistentTasksCustomMetadata.PersistentTask<?> task) -
getLastDataFrameAnalyticsTaskStateChangeTime
public static Instant getLastDataFrameAnalyticsTaskStateChangeTime(String analyticsId, @Nullable PersistentTasksCustomMetadata tasks) -
openJobIds
The job Ids of anomaly detector job tasks. All anomaly detector jobs are returned regardless of the status of the task (OPEN, CLOSED, FAILED etc).- Parameters:
tasks- Persistent tasks. If null an empty set is returned.- Returns:
- The job Ids of anomaly detector job tasks
-
openJobTasks
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> openJobTasks(@Nullable PersistentTasksCustomMetadata tasks) -
datafeedTasksOnNode
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> datafeedTasksOnNode(@Nullable PersistentTasksCustomMetadata tasks, String nodeId) -
jobTasksOnNode
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> jobTasksOnNode(@Nullable PersistentTasksCustomMetadata tasks, String nodeId) -
nonFailedJobTasksOnNode
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> nonFailedJobTasksOnNode(@Nullable PersistentTasksCustomMetadata tasks, String nodeId) -
snapshotUpgradeTasks
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> snapshotUpgradeTasks(@Nullable PersistentTasksCustomMetadata tasks) -
snapshotUpgradeTasksOnNode
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> snapshotUpgradeTasksOnNode(@Nullable PersistentTasksCustomMetadata tasks, String nodeId) -
nonFailedSnapshotUpgradeTasksOnNode
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> nonFailedSnapshotUpgradeTasksOnNode(@Nullable PersistentTasksCustomMetadata tasks, String nodeId) -
unassignedJobIds
public static Set<String> unassignedJobIds(@Nullable PersistentTasksCustomMetadata tasks, DiscoveryNodes nodes) Get the job Ids of anomaly detector job tasks that do not have an assignment.- Parameters:
tasks- Persistent tasks. If null an empty set is returned.nodes- The cluster nodes- Returns:
- The job Ids of tasks to do not have an assignment.
-
unassignedJobTasks
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> unassignedJobTasks(@Nullable PersistentTasksCustomMetadata tasks, DiscoveryNodes nodes) The job tasks that do not have an assignment as determined byPersistentTasksClusterService.needsReassignment(PersistentTasksCustomMetadata.Assignment, DiscoveryNodes)- Parameters:
tasks- Persistent tasks. If null an empty set is returned.nodes- The cluster nodes- Returns:
- Unassigned job tasks
-
startedDatafeedIds
The datafeed Ids of started datafeed tasks- Parameters:
tasks- Persistent tasks. If null an empty set is returned.- Returns:
- The Ids of running datafeed tasks
-
unassignedDatafeedIds
public static Set<String> unassignedDatafeedIds(@Nullable PersistentTasksCustomMetadata tasks, DiscoveryNodes nodes) Get the datafeed Ids of started datafeed tasks that do not have an assignment.- Parameters:
tasks- Persistent tasks. If null an empty set is returned.nodes- The cluster nodes- Returns:
- The job Ids of tasks to do not have an assignment.
-
unassignedDatafeedTasks
public static Collection<PersistentTasksCustomMetadata.PersistentTask<?>> unassignedDatafeedTasks(@Nullable PersistentTasksCustomMetadata tasks, DiscoveryNodes nodes) The datafeed tasks that do not have an assignment as determined byPersistentTasksClusterService.needsReassignment(PersistentTasksCustomMetadata.Assignment, DiscoveryNodes)- Parameters:
tasks- Persistent tasks. If null an empty set is returned.nodes- The cluster nodes- Returns:
- Unassigned datafeed tasks
-
getMemoryTrackedTaskState
public static MemoryTrackedTaskState getMemoryTrackedTaskState(PersistentTasksCustomMetadata.PersistentTask<?> task) -
findMlProcessTasks
public static Set<PersistentTasksCustomMetadata.PersistentTask<?>> findMlProcessTasks(@Nullable PersistentTasksCustomMetadata tasks) -
prettyPrintTaskName
-
downloadModelTaskDescription
Builds the task description from the model id that initiated the task.- Parameters:
modelId- a string that identifies the model- Returns:
- a string representing the task description
-