diff options
Diffstat (limited to 'scripts/external_libs/elasticsearch/elasticsearch/client/cat.py')
| -rw-r--r-- | scripts/external_libs/elasticsearch/elasticsearch/client/cat.py | 359 |
1 files changed, 359 insertions, 0 deletions
diff --git a/scripts/external_libs/elasticsearch/elasticsearch/client/cat.py b/scripts/external_libs/elasticsearch/elasticsearch/client/cat.py new file mode 100644 index 00000000..02704415 --- /dev/null +++ b/scripts/external_libs/elasticsearch/elasticsearch/client/cat.py @@ -0,0 +1,359 @@ +from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH + +class CatClient(NamespacedClient): + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def aliases(self, name=None, params=None): + """ + + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html>`_ + + :arg name: A comma-separated list of alias names to return + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'aliases', name), params=params) + + @query_params('bytes', 'h', 'help', 'local', 'master_timeout', 'v') + def allocation(self, node_id=None, params=None): + """ + Allocation provides a snapshot of how shards have located around the + cluster and the state of disk usage. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html>`_ + + :arg node_id: A comma-separated list of node IDs or names to limit the + returned information + :arg bytes: The unit in which to display byte values, valid choices are: + 'b', 'k', 'kb', 'm', 'mb', 'g', 'gb', 't', 'tb', 'p', 'pb' + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'allocation', node_id), params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def count(self, index=None, params=None): + """ + Count provides quick access to the document count of the entire cluster, + or individual indices. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html>`_ + + :arg index: A comma-separated list of index names to limit the returned + information + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'count', index), params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'ts', 'v') + def health(self, params=None): + """ + health is a terse, one-line representation of the same information from + :meth:`~elasticsearch.client.cluster.ClusterClient.health` API + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 ts: Set to false to disable timestamping, default True + :arg v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/health', + params=params) + + @query_params('help') + def help(self, params=None): + """ + A simple help for the cat api. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html>`_ + + :arg help: Return help information, default False + """ + return self.transport.perform_request('GET', '/_cat', params=params) + + @query_params('bytes', 'format', 'h', 'health', 'help', 'local', + 'master_timeout', 'pri', 'v') + def indices(self, index=None, params=None): + """ + The indices command provides a cross-section of each index. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html>`_ + + :arg index: A comma-separated list of index names to limit the returned + information + :arg bytes: The unit in which to display byte values, valid choices are: + 'b', 'k', 'm', 'g' + :arg h: Comma-separated list of column names to display + :arg health: A health status ("green", "yellow", or "red" to filter only + indices matching the specified health status, default None, valid + choices are: 'green', 'yellow', 'red' + :arg help: Return help information, default False + :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 pri: Set to true to return stats only for primary shards, default + False + :arg v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'indices', index), params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def master(self, params=None): + """ + Displays the master's node ID, bound IP address, and node name. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/master', + params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def nodes(self, params=None): + """ + The nodes command shows the cluster topology. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/nodes', + params=params) + + @query_params('bytes', 'h', 'help', 'master_timeout', 'v') + def recovery(self, index=None, params=None): + """ + recovery is a view of shard replication. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html>`_ + + :arg index: A comma-separated list of index names to limit the returned + information + :arg bytes: The unit in which to display byte values, valid choices are: + 'b', 'k', 'kb', 'm', 'mb', 'g', 'gb', 't', 'tb', 'p', 'pb' + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :arg master_timeout: Explicit operation timeout for connection to master + node + :arg v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'recovery', index), params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def shards(self, index=None, params=None): + """ + The shards command is the detailed view of what nodes contain which shards. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html>`_ + + :arg index: A comma-separated list of index names to limit the returned + information + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'shards', index), params=params) + + @query_params('h', 'help', 'v') + def segments(self, index=None, params=None): + """ + The segments command is the detailed view of Lucene segments per index. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html>`_ + + :arg index: A comma-separated list of index names to limit the returned + information + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :arg v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'segments', index), params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def pending_tasks(self, params=None): + """ + pending_tasks provides the same information as the + :meth:`~elasticsearch.client.cluster.ClusterClient.pending_tasks` API + in a convenient tabular format. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/pending_tasks', + params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'size', + 'thread_pool_patterns', 'v') + def thread_pool(self, thread_pools=None, params=None): + """ + Get information about thread pools. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 size: The multiplier in which to display values, valid choices are: + '', 'k', 'm', 'g', 't', 'p' + :arg thread_pool_patterns: A comma-separated list of regular-expressions + to filter the thread pools in the output + :arg v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'thread_pool', thread_pools), params=params) + + @query_params('bytes', 'h', 'help', 'local', 'master_timeout', 'v') + def fielddata(self, fields=None, params=None): + """ + Shows information about currently loaded fielddata on a per-node basis. + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html>`_ + + :arg fields: A comma-separated list of fields to return the fielddata + size + :arg bytes: The unit in which to display byte values, valid choices are: + 'b', 'k', 'kb', 'm', 'mb', 'g', 'gb', 't', 'tb', 'p', 'pb' + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'fielddata', fields), params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def plugins(self, params=None): + """ + + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/plugins', + params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def nodeattrs(self, params=None): + """ + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/nodeattrs', + params=params) + + @query_params('h', 'help', 'local', 'master_timeout', 'v') + def repositories(self, params=None): + """ + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html>`_ + + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/repositories', + params=params) + + @query_params('h', 'help', 'ignore_unavailable', 'master_timeout', 'v') + def snapshots(self, repository=None, params=None): + """ + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html>`_ + + :arg repository: Name of repository from which to fetch the snapshot + information + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :arg ignore_unavailable: Set to true to ignore unavailable snapshots, + default False + :arg master_timeout: Explicit operation timeout for connection to master + node + :arg v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', _make_path('_cat', + 'snapshots', repository), params=params) + + @query_params('actions', 'detailed', 'format', 'h', 'help', 'node_id', + 'parent_node', 'parent_task', 'v') + def tasks(self, params=None): + """ + `<http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>`_ + + :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) + :arg format: a short version of the Accept header, e.g. json, yaml + :arg h: Comma-separated list of column names to display + :arg help: Return help information, default False + :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 parent_node: Return tasks with specified parent node. + :arg parent_task: Return tasks with specified parent task id. Set to -1 + to return all. + :arg v: Verbose mode. Display column headers, default False + """ + return self.transport.perform_request('GET', '/_cat/tasks', + params=params) + |