Tasks

class elasticsearch_serverless.client.TasksClient(client: BaseClient)
get(*, task_id: str, error_trace: bool | None = None, filter_path: str | Sequence[str] | None = None, human: bool | None = None, pretty: bool | None = None, timeout: str | ~typing.Literal[-1] | ~typing.Literal[0] | None = None, wait_for_completion: bool | None = None) → ObjectApiResponse[Any]

Get task information. Get information about a task currently running in the cluster.

WARNING: The task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.

If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.

https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks

Parameters:

  • task_id – The task identifier.

  • timeout – The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

  • wait_for_completion – If true, the request blocks until the task has completed.