Skip to content

Mark task management APIs as experimental #1471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 9, 2020
Merged

Mark task management APIs as experimental #1471

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions elasticsearch/_async/client/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ async def list(self, params=None, headers=None):

`<https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html>`_

.. warning::

This API is **experimental** so may include breaking changes
or be removed in a future version

:arg actions: A comma-separated list of actions that should be
returned. Leave empty to return all.
:arg detailed: Return detailed task information (default: false)
Expand All @@ -60,6 +65,11 @@ async def cancel(self, task_id=None, params=None, headers=None):

`<https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html>`_

.. warning::

This API is **experimental** so may include breaking changes
or be removed in a future version

:arg task_id: Cancel the task with specified task id
(node_id:task_number)
:arg actions: A comma-separated list of actions that should be
Expand Down Expand Up @@ -87,6 +97,11 @@ async def get(self, task_id=None, params=None, headers=None):

`<https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html>`_

.. warning::

This API is **experimental** so may include breaking changes
or be removed in a future version

:arg task_id: Return the task with specified id
(node_id:task_number)
:arg timeout: Explicit operation timeout
Expand Down
15 changes: 15 additions & 0 deletions elasticsearch/client/tasks.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ def list(self, params=None, headers=None):

`<https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html>`_

.. warning::

This API is **experimental** so may include breaking changes
or be removed in a future version

:arg actions: A comma-separated list of actions that should be
returned. Leave empty to return all.
:arg detailed: Return detailed task information (default: false)
Expand All @@ -60,6 +65,11 @@ def cancel(self, task_id=None, params=None, headers=None):

`<https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html>`_

.. warning::

This API is **experimental** so may include breaking changes
or be removed in a future version

:arg task_id: Cancel the task with specified task id
(node_id:task_number)
:arg actions: A comma-separated list of actions that should be
Expand Down Expand Up @@ -87,6 +97,11 @@ def get(self, task_id=None, params=None, headers=None):

`<https://www.elastic.co/guide/en/elasticsearch/reference/7.10/tasks.html>`_

.. warning::

This API is **experimental** so may include breaking changes
or be removed in a future version

:arg task_id: Return the task with specified id
(node_id:task_number)
:arg timeout: Explicit operation timeout
Expand Down