diff options
Diffstat (limited to 'scripts/external_libs/elasticsearch/elasticsearch/client/cluster.py')
| -rw-r--r-- | scripts/external_libs/elasticsearch/elasticsearch/client/cluster.py | 172 |
1 files changed, 172 insertions, 0 deletions
diff --git a/scripts/external_libs/elasticsearch/elasticsearch/client/cluster.py b/scripts/external_libs/elasticsearch/elasticsearch/client/cluster.py new file mode 100644 index 00000000..a1f10bdc --- /dev/null +++ b/scripts/external_libs/elasticsearch/elasticsearch/client/cluster.py @@ -0,0 +1,172 @@ +from .utils import NamespacedClient, query_params, _make_path + +class ClusterClient(NamespacedClient): + @query_params('level', 'local', 'master_timeout', 'timeout', + 'wait_for_active_shards', 'wait_for_events', + 'wait_for_no_relocating_shards', 'wait_for_nodes', 'wait_for_status') + def health(self, index=None, params=None): + """ + Get a very simple status on the health of the cluster. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html>`_ + + :arg index: Limit the information returned to a specific index + :arg level: Specify the level of detail for returned information, + default 'cluster', valid choices are: 'cluster', 'indices', 'shards' + :arg local: Return local information, do not retrieve the state from + master node (default: false) + :arg master_timeout: Explicit operation timeout for connection to master + node + :arg timeout: Explicit operation timeout + :arg wait_for_active_shards: Wait until the specified number of shards + is active + :arg wait_for_events: Wait until all currently queued events with the + given priorty are processed, valid choices are: 'immediate', + 'urgent', 'high', 'normal', 'low', 'languid' + :arg wait_for_no_relocating_shards: Whether to wait until there are no + relocating shards in the cluster + :arg wait_for_nodes: Wait until the specified number of nodes is + available + :arg wait_for_status: Wait until cluster is in a specific state, default + None, valid choices are: 'green', 'yellow', 'red' + """ + return self.transport.perform_request('GET', _make_path('_cluster', + 'health', index), params=params) + + @query_params('local', 'master_timeout') + def pending_tasks(self, params=None): + """ + The pending cluster tasks API returns a list of any cluster-level + changes (e.g. create index, update mapping, allocate or fail shard) + which have not yet been executed. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html>`_ + + :arg local: Return local information, do not retrieve the state from + master node (default: false) + :arg master_timeout: Specify timeout for connection to master + """ + return self.transport.perform_request('GET', + '/_cluster/pending_tasks', params=params) + + @query_params('allow_no_indices', 'expand_wildcards', 'flat_settings', + 'ignore_unavailable', 'local', 'master_timeout') + def state(self, metric=None, index=None, params=None): + """ + Get a comprehensive state information of the whole cluster. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html>`_ + + :arg metric: Limit the information returned to the specified metrics + :arg index: A comma-separated list of index names; use `_all` or empty + string to perform the operation on all indices + :arg allow_no_indices: Whether to ignore if a wildcard indices + expression resolves into no concrete indices. (This includes `_all` + string or when no indices have been specified) + :arg expand_wildcards: Whether to expand wildcard expression to concrete + indices that are open, closed or both., default 'open', valid + choices are: 'open', 'closed', 'none', 'all' + :arg flat_settings: Return settings in flat format (default: false) + :arg ignore_unavailable: Whether specified concrete indices should be + ignored when unavailable (missing or closed) + :arg local: Return local information, do not retrieve the state from + master node (default: false) + :arg master_timeout: Specify timeout for connection to master + """ + if index and not metric: + metric = '_all' + return self.transport.perform_request('GET', _make_path('_cluster', + 'state', metric, index), params=params) + + @query_params('flat_settings', 'human', 'timeout') + def stats(self, node_id=None, params=None): + """ + The Cluster Stats API allows to retrieve statistics from a cluster wide + perspective. The API returns basic index metrics and information about + the current nodes that form the cluster. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html>`_ + + :arg 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 + :arg flat_settings: Return settings in flat format (default: false) + :arg human: Whether to return time and byte values in human-readable + format., default False + :arg timeout: Explicit operation timeout + """ + url = '/_cluster/stats' + if node_id: + url = _make_path('_cluster/stats/nodes', node_id) + return self.transport.perform_request('GET', url, params=params) + + @query_params('dry_run', 'explain', 'master_timeout', 'metric', + 'retry_failed', 'timeout') + def reroute(self, body=None, params=None): + """ + Explicitly execute a cluster reroute allocation command including specific commands. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html>`_ + + :arg body: The definition of `commands` to perform (`move`, `cancel`, + `allocate`) + :arg dry_run: Simulate the operation only and return the resulting state + :arg explain: Return an explanation of why the commands can or cannot be + executed + :arg master_timeout: Explicit operation timeout for connection to master + node + :arg metric: Limit the information returned to the specified metrics. + Defaults to all but metadata, valid choices are: '_all', 'blocks', + 'metadata', 'nodes', 'routing_table', 'master_node', 'version' + :arg retry_failed: Retries allocation of shards that are blocked due to + too many subsequent allocation failures + :arg timeout: Explicit operation timeout + """ + return self.transport.perform_request('POST', '/_cluster/reroute', + params=params, body=body) + + @query_params('flat_settings', 'include_defaults', 'master_timeout', + 'timeout') + def get_settings(self, params=None): + """ + Get cluster settings. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html>`_ + + :arg flat_settings: Return settings in flat format (default: false) + :arg include_defaults: Whether to return all default clusters setting., + default False + :arg master_timeout: Explicit operation timeout for connection to master + node + :arg timeout: Explicit operation timeout + """ + return self.transport.perform_request('GET', '/_cluster/settings', + params=params) + + @query_params('flat_settings', 'master_timeout', 'timeout') + def put_settings(self, body=None, params=None): + """ + Update cluster wide specific settings. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html>`_ + + :arg body: The settings to be updated. Can be either `transient` or + `persistent` (survives cluster restart). + :arg flat_settings: Return settings in flat format (default: false) + :arg master_timeout: Explicit operation timeout for connection to master + node + :arg timeout: Explicit operation timeout + """ + return self.transport.perform_request('PUT', '/_cluster/settings', + params=params, body=body) + + @query_params('include_disk_info', 'include_yes_decisions') + def allocation_explain(self, body=None, params=None): + """ + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html>`_ + + :arg body: The index, shard, and primary flag to explain. Empty means + 'explain the first unassigned shard' + :arg include_disk_info: Return information about disk usage and shard + sizes (default: false) + :arg include_yes_decisions: Return 'YES' decisions in explanation + (default: false) + """ + return self.transport.perform_request('GET', + '/_cluster/allocation/explain', params=params, body=body) + + |