Skip to content

Commit e56acf9

Browse files
committed
[API] Updates tasks APIs
1 parent 44f5e15 commit e56acf9

File tree

4 files changed

+16
-4
lines changed

4 files changed

+16
-4
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ module Actions
2222
# Returns information about the tasks currently executing on one or more nodes in the cluster.
2323
#
2424
# @option arguments [String] :format a short version of the Accept header, e.g. json, yaml
25-
# @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
25+
# @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
2626
# @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.
2727
# @option arguments [Boolean] :detailed Return detailed task information (default: false)
28-
# @option arguments [Number] :parent_task Return tasks with specified parent task id. Set to -1 to return all.
28+
# @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
2929
# @option arguments [List] :h Comma-separated list of column names to display
3030
# @option arguments [Boolean] :help Return help information
3131
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
@@ -53,10 +53,10 @@ def tasks(arguments = {})
5353
# @since 6.2.0
5454
ParamsRegistry.register(:tasks, [
5555
:format,
56-
:node_id,
56+
:nodes,
5757
:actions,
5858
:detailed,
59-
:parent_task,
59+
:parent_task_id,
6060
:h,
6161
:help,
6262
:s,

elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ module API
2020
module Tasks
2121
module Actions
2222
# Cancels a task, if it can be cancelled through an API.
23+
# This functionality is Experimental and may be changed or removed
24+
# completely in a future release. Elastic will take a best effort approach
25+
# to fix any issues, but experimental features are not subject to the
26+
# support SLA of official GA features.
2327
#
2428
# @option arguments [String] :task_id Cancel the task with specified task id (node_id:task_number)
2529
# @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes

elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ module API
2020
module Tasks
2121
module Actions
2222
# Returns information about a task.
23+
# This functionality is Experimental and may be changed or removed
24+
# completely in a future release. Elastic will take a best effort approach
25+
# to fix any issues, but experimental features are not subject to the
26+
# support SLA of official GA features.
2327
#
2428
# @option arguments [String] :task_id Return the task with specified id (node_id:task_number)
2529
# @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false)

elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ module API
2020
module Tasks
2121
module Actions
2222
# Returns a list of tasks.
23+
# This functionality is Experimental and may be changed or removed
24+
# completely in a future release. Elastic will take a best effort approach
25+
# to fix any issues, but experimental features are not subject to the
26+
# support SLA of official GA features.
2327
#
2428
# @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
2529
# @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all.

0 commit comments

Comments
 (0)