IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Elasticsearch\Namespaces\SslNamespace Elasticsearch\Namespaces\TextStructureNamespace »
Elastic Docs ›Elasticsearch PHP Client [7.16] ›Reference - Endpoints

Elasticsearch\Namespaces\TasksNamespace

edit

Elasticsearch\Namespaces\TasksNamespace

edit

Class TasksNamespace

Description

this file is autogenerated using util/GenerateEndpoints.php and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)

Methods

The class defines the following methods:

cancel(array $params = [])NOTE: This API is EXPERIMENTAL and may be changed or removed completely in a future release

/*
$params['task_id']             = (string) Cancel the task with specified task id (node_id:task_number)
$params['nodes']               = (list) 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
$params['actions']             = (list) A comma-separated list of actions that should be cancelled. Leave empty to cancel all.
*/

get(array $params = [])NOTE: This API is EXPERIMENTAL and may be changed or removed completely in a future release

/*
$params['task_id']             = (string) Return the task with specified id (node_id:task_number)
$params['wait_for_completion'] = (boolean) Wait for the matching tasks to complete (default: false)
$params['timeout']             = (time) Explicit operation timeout
*/

list(array $params = [])NOTE: This API is EXPERIMENTAL and may be changed or removed completely in a future release

/*
$params['nodes']               = (list) 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
$params['actions']             = (list) A comma-separated list of actions that should be returned. Leave empty to return all.
*/

tasksList(array $params = [])

/*
Proxy function to list() to prevent BC break since 7.4.0
*/
« Elasticsearch\Namespaces\SslNamespace Elasticsearch\Namespaces\TextStructureNamespace »