first pass for 6.0 compatibility

Author: honzakral

elasticsearch/client/__init__.py

@@ -375,7 +375,7 @@ def repositories(self, params=None):
 
  @query_params('format', 'h', 'help', 'ignore_unavailable', 'master_timeout',
  's', 'v')
- def snapshots(self, repository=None, params=None):
+ def snapshots(self, repository, params=None):
  """
 
  `<https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html>`_
@@ -393,6 +393,8 @@ def snapshots(self, repository=None, params=None):
  by
  :arg v: Verbose mode. Display column headers, default False
  """
+ if repository in SKIP_IN_PATH:
+ raise ValueError("Empty value passed for a required argument 'repository'.")
  return self.transport.perform_request('GET', _make_path('_cat',
  'snapshots', repository), params=params)
 

elasticsearch/client/cat.py

@@ -20,7 +20,7 @@ def health(self, index=None, params=None):
  :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',
+ given priority 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
@@ -75,7 +75,7 @@ def state(self, metric=None, index=None, params=None):
  return self.transport.perform_request('GET', _make_path('_cluster',
  'state', metric, index), params=params)
 
- @query_params('flat_settings', 'human', 'timeout')
+ @query_params('flat_settings', 'timeout')
  def stats(self, node_id=None, params=None):
  """
  The Cluster Stats API allows to retrieve statistics from a cluster wide
@@ -88,8 +88,6 @@ def stats(self, node_id=None, params=None):
  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'
@@ -169,4 +167,3 @@ def allocation_explain(self, body=None, params=None):
  return self.transport.perform_request('GET',
  '/_cluster/allocation/explain', params=params, body=body)
 
-

elasticsearch/client/cluster.py

@@ -1,38 +1,24 @@
 from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
 
 class IndicesClient(NamespacedClient):
- @query_params('analyzer', 'attributes', 'char_filter', 'explain', 'field',
- 'filter', 'format', 'prefer_local', 'text', 'tokenizer')
+ @query_params('format', 'prefer_local')
  def analyze(self, index=None, body=None, params=None):
  """
  Perform the analysis process on a text and return the tokens breakdown of the text.
  `<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html>`_
 
  :arg index: The name of the index to scope the operation
- :arg body: The text on which the analysis should be performed
- :arg analyzer: The name of the analyzer to use
- :arg attributes: A comma-separated list of token attributes to output,
- this parameter works only with `explain=true`
- :arg char_filter: A comma-separated list of character filters to use for
- the analysis
- :arg explain: With `true`, outputs more advanced details. (default:
- false)
- :arg field: Use the analyzer configured for this field (instead of
- passing the analyzer name)
- :arg filter: A comma-separated list of filters to use for the analysis
+ :arg body: Define analyzer/tokenizer parameters and the text on which
+ the analysis should be performed
  :arg format: Format of the output, default 'detailed', valid choices
  are: 'detailed', 'text'
  :arg prefer_local: With `true`, specify that a local shard should be
  used if available, with `false`, use a random shard (default: true)
- :arg text: The text on which the analysis should be performed (when
- request body is not used)
- :arg tokenizer: The name of the tokenizer to use for the analysis
  """
  return self.transport.perform_request('GET', _make_path(index,
  '_analyze'), params=params, body=body)
 
- @query_params('allow_no_indices', 'expand_wildcards', 'force',
- 'ignore_unavailable', 'operation_threading')
+ @query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable')
  def refresh(self, index=None, params=None):
  """
  Explicitly refresh one or more index, making all operations performed
@@ -47,10 +33,8 @@ def refresh(self, index=None, params=None):
  :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 force: Force a refresh even if not required, default False
  :arg ignore_unavailable: Whether specified concrete indices should be
  ignored when unavailable (missing or closed)
- :arg operation_threading: TODO: ?
  """
  return self.transport.perform_request('POST', _make_path(index,
  '_refresh'), params=params)
@@ -107,22 +91,19 @@ def create(self, index, body=None, params=None):
  params=params, body=body)
 
  @query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
- 'human', 'ignore_unavailable', 'include_defaults', 'local')
+ 'ignore_unavailable', 'include_defaults', 'local')
  def get(self, index, feature=None, params=None):
  """
  The get index API allows to retrieve information about one or more indexes.
  `<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html>`_
 
  :arg index: A comma-separated list of index names
- :arg feature: A comma-separated list of features
  :arg allow_no_indices: Ignore if a wildcard expression resolves to no
  concrete indices (default: false)
  :arg expand_wildcards: Whether wildcard expressions should get expanded
  to open or closed indices (default: open), default 'open', valid
  choices are: 'open', 'closed', 'none', 'all'
  :arg flat_settings: Return settings in flat format (default: false)
- :arg human: Whether to return version and creation date values in human-
- readable format., default False
  :arg ignore_unavailable: Ignore unavailable indexes (default: false)
  :arg include_defaults: Whether to return all default setting for each of
  the indices., default False
@@ -183,14 +164,21 @@ def close(self, index, params=None):
  return self.transport.perform_request('POST', _make_path(index,
  '_close'), params=params)
 
- @query_params('master_timeout', 'timeout')
+ @query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
+ 'master_timeout', 'timeout')
  def delete(self, index, params=None):
  """
  Delete an index in Elasticsearch
  `<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html>`_
 
  :arg index: A comma-separated list of indices to delete; use `_all` or
  `*` string to delete all indices
+ :arg allow_no_indices: Ignore if a wildcard expression resolves to no
+ concrete indices (default: false)
+ :arg expand_wildcards: Whether wildcard expressions should get expanded
+ to open or closed indices (default: open), default 'open', valid
+ choices are: 'open', 'closed', 'none', 'all'
+ :arg ignore_unavailable: Ignore unavailable indexes (default: false)
  :arg master_timeout: Specify timeout for connection to master
  :arg timeout: Explicit operation timeout
  """
@@ -199,22 +187,23 @@ def delete(self, index, params=None):
  return self.transport.perform_request('DELETE', _make_path(index),
  params=params)
 
- @query_params('allow_no_indices', 'expand_wildcards', 'ignore_unavailable',
- 'local')
+ @query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
+ 'ignore_unavailable', 'include_defaults', 'local')
  def exists(self, index, params=None):
  """
  Return a boolean indicating whether given index exists.
  `<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html>`_
 
- :arg index: A comma-separated list of indices to check
- :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
+ :arg index: A comma-separated list of index names
+ :arg allow_no_indices: Ignore if a wildcard expression resolves to no
+ concrete indices (default: false)
+ :arg expand_wildcards: Whether wildcard expressions should get expanded
+ to open or closed indices (default: open), default 'open', valid
  choices are: 'open', 'closed', 'none', 'all'
- :arg ignore_unavailable: Whether specified concrete indices should be
- ignored when unavailable (missing or closed)
+ :arg flat_settings: Return settings in flat format (default: false)
+ :arg ignore_unavailable: Ignore unavailable indexes (default: false)
+ :arg include_defaults: Whether to return all default setting for each of
+ the indices., default False
  :arg local: Return local information, do not retrieve the state from
  master node (default: false)
  """
@@ -365,8 +354,8 @@ def exists_alias(self, index=None, name=None, params=None):
  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', 'closed'],
- valid choices are: 'open', 'closed', 'none', 'all'
+ indices that are open, closed or both., default 'all', valid choices
+ are: 'open', 'closed', 'none', 'all'
  :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
@@ -388,8 +377,8 @@ def get_alias(self, index=None, name=None, params=None):
  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 'all', valid
- choices are: 'open', 'closed', 'none', 'all'
+ indices that are open, closed or both., default 'all', valid choices
+ are: 'open', 'closed', 'none', 'all'
  :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
@@ -457,13 +446,14 @@ def put_template(self, name, body, params=None):
  return self.transport.perform_request('PUT', _make_path('_template',
  name), params=params, body=body)
 
- @query_params('local', 'master_timeout')
+ @query_params('flat_settings', 'local', 'master_timeout')
  def exists_template(self, name, params=None):
  """
  Return a boolean indicating whether given template exists.
  `<http://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates.html>`_
 
- :arg name: The name of the template
+ :arg name: The comma separated names of the index templates
+ :arg flat_settings: Return settings in flat format (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
@@ -506,7 +496,7 @@ def delete_template(self, name, params=None):
  _make_path('_template', name), params=params)
 
  @query_params('allow_no_indices', 'expand_wildcards', 'flat_settings',
- 'human', 'ignore_unavailable', 'include_defaults', 'local')
+ 'ignore_unavailable', 'include_defaults', 'local')
  def get_settings(self, index=None, name=None, params=None):
  """
  Retrieve settings for one or more (or all) indices.
@@ -522,8 +512,6 @@ def get_settings(self, index=None, name=None, params=None):
  indices that are open, closed or both., default ['open', 'closed'],
  valid choices are: 'open', 'closed', 'none', 'all'
  :arg flat_settings: Return settings in flat format (default: false)
- :arg human: Whether to return version and creation date values in human-
- readable format., default False
  :arg ignore_unavailable: Whether specified concrete indices should be
  ignored when unavailable (missing or closed)
  :arg include_defaults: Whether to return all default setting for each of
@@ -615,10 +603,9 @@ def segments(self, index=None, params=None):
  return self.transport.perform_request('GET', _make_path(index,
  '_segments'), params=params)
 
- @query_params('allow_no_indices', 'analyze_wildcard', 'analyzer',
- 'default_operator', 'df', 'expand_wildcards', 'explain',
- 'ignore_unavailable', 'lenient', 'lowercase_expanded_terms',
- 'operation_threading', 'q', 'rewrite')
+ @query_params('all_shards', 'allow_no_indices', 'analyze_wildcard',
+ 'analyzer', 'default_operator', 'df', 'expand_wildcards', 'explain',
+ 'ignore_unavailable', 'lenient', 'operation_threading', 'q', 'rewrite')
  def validate_query(self, index=None, doc_type=None, body=None, params=None):
  """
  Validate a potentially expensive query without executing it.
@@ -630,6 +617,8 @@ def validate_query(self, index=None, doc_type=None, body=None, params=None):
  :arg doc_type: A comma-separated list of document types to restrict the
  operation; leave empty to perform the operation on all types
  :arg body: The query definition specified with the Query DSL
+ :arg all_shards: Execute validation on all shards instead of one random
+ shard per index
  :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)
@@ -648,8 +637,6 @@ def validate_query(self, index=None, doc_type=None, body=None, params=None):
  ignored when unavailable (missing or closed)
  :arg lenient: Specify whether format-based query failures (such as
  providing text to a numeric field) should be ignored
- :arg lowercase_expanded_terms: Specify whether query terms should be
- lowercased
  :arg operation_threading: TODO: ?
  :arg q: Query in the Lucene query string syntax
  :arg rewrite: Provide a more detailed explanation showing the actual
@@ -682,6 +669,7 @@ def clear_cache(self, index=None, params=None):
  :arg query: Clear query caches
  :arg recycler: Clear the recycler cache
  :arg request: Clear request cache
+ :arg request_cache: Clear request cache
  """
  return self.transport.perform_request('POST', _make_path(index,
  '_cache', 'clear'), params=params)

elasticsearch/client/indices.py

@@ -84,3 +84,22 @@ def hot_threads(self, node_id=None, params=None):
  params['type'] = params.pop('type_')
  return self.transport.perform_request('GET', _make_path('_cluster',
  'nodes', node_id, 'hotthreads'), params=params)
+
+ @query_params('human', 'timeout')
+ def usage(self, node_id=None, metric=None, params=None):
+ """
+ The cluster nodes usage API allows to retrieve information on the usage
+ of features for each node.
+ `<http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-usage.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 metric: Limit the information returned to the specified metrics
+ :arg human: Whether to return time and byte values in human-readable
+ format., default False
+ :arg timeout: Explicit operation timeout
+ """
+ return self.transport.perform_request('GET', _make_path('_nodes',
+ node_id, 'usage', metric), params=params)

elasticsearch/client/nodes.py

@@ -38,7 +38,7 @@ def delete(self, repository, snapshot, params=None):
  return self.transport.perform_request('DELETE',
  _make_path('_snapshot', repository, snapshot), params=params)
 
- @query_params('ignore_unavailable', 'master_timeout')
+ @query_params('ignore_unavailable', 'master_timeout', 'verbose')
  def get(self, repository, snapshot, params=None):
  """
  Retrieve information about a snapshot.
@@ -50,6 +50,8 @@ def get(self, repository, snapshot, params=None):
  defaults to false which means a SnapshotMissingException is thrown
  :arg master_timeout: Explicit operation timeout for connection to master
  node
+ :arg verbose: Whether to show verbose snapshot info or only show the
+ basic info found in the repository index blob
  """
  for param in (repository, snapshot):
  if param in SKIP_IN_PATH:

elasticsearch/client/snapshot.py

@@ -3,11 +3,10 @@
 class TasksClient(NamespacedClient):
  @query_params('actions', 'detailed', 'group_by', 'node_id', 'parent_node',
  'parent_task', 'wait_for_completion')
- def list(self, task_id=None, params=None):
+ def list(self, params=None):
  """
  `<http://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html>`_
 
- :arg task_id: Return the task with specified id (node_id:task_number)
  :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)
@@ -23,8 +22,7 @@ def list(self, task_id=None, params=None):
  :arg wait_for_completion: Wait for the matching tasks to complete
  (default: false)
  """
- return self.transport.perform_request('GET', _make_path('_tasks',
- task_id), params=params)
+ return self.transport.perform_request('GET', '/_tasks', params=params)
 
  @query_params('actions', 'node_id', 'parent_node', 'parent_task')
  def cancel(self, task_id=None, params=None):