actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add timeout param to Tasks API (closes #852) (#853)

Browse Source
This commit is contained in:
Maciej "RooTer" Urbański
2018-10-12 09:39:22 -06:00
committed by Nick Lang
parent de8413fdbd
commit b049b684bb
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
elasticsearch/client/tasks.py
+4 -2
View File
@@ -2,7 +2,7 @@ from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
class TasksClient(NamespacedClient): class TasksClient(NamespacedClient):
@query_params('actions', 'detailed', 'group_by', 'nodes', @query_params('actions', 'detailed', 'group_by', 'nodes',
'parent_task_id', 'wait_for_completion') 'parent_task_id', 'wait_for_completion', 'timeout')
def list(self, params=None): def list(self, params=None):
""" """
`<http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>`_ `<http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>`_
@@ -20,6 +20,7 @@ class TasksClient(NamespacedClient):
(node_id:task_number). Set to -1 to return all. (node_id:task_number). Set to -1 to return all.
:arg wait_for_completion: Wait for the matching tasks to complete :arg wait_for_completion: Wait for the matching tasks to complete
(default: false) (default: false)
:arg timeout: Maximum waiting time for `wait_for_completion`
""" """
return self.transport.perform_request('GET', '/_tasks', params=params) return self.transport.perform_request('GET', '/_tasks', params=params)
@@ -43,7 +44,7 @@ class TasksClient(NamespacedClient):
return self.transport.perform_request('POST', _make_path('_tasks', return self.transport.perform_request('POST', _make_path('_tasks',
task_id, '_cancel'), params=params) task_id, '_cancel'), params=params)
@query_params('wait_for_completion') @query_params('wait_for_completion', 'timeout')
def get(self, task_id=None, params=None): def get(self, task_id=None, params=None):
""" """
Retrieve information for a particular task. Retrieve information for a particular task.
@@ -52,6 +53,7 @@ class TasksClient(NamespacedClient):
:arg task_id: Return the task with specified id (node_id:task_number) :arg task_id: Return the task with specified id (node_id:task_number)
:arg wait_for_completion: Wait for the matching tasks to complete :arg wait_for_completion: Wait for the matching tasks to complete
(default: false) (default: false)
:arg timeout: Maximum waiting time for `wait_for_completion`
""" """
return self.transport.perform_request('GET', _make_path('_tasks', return self.transport.perform_request('GET', _make_path('_tasks',
task_id), params=params) task_id), params=params)