From efcee3603d66382586ffe1defc89a7f780a101a2 Mon Sep 17 00:00:00 2001 From: Seth Michael Larson Date: Mon, 20 Jul 2020 10:06:47 -0500 Subject: [PATCH] Update APIs and docs links to Elasticsearch 7.9 --- elasticsearch/_async/client/__init__.py | 72 +++++------ elasticsearch/_async/client/async_search.py | 6 +- elasticsearch/_async/client/autoscaling.py | 8 +- elasticsearch/_async/client/cat.py | 50 ++++---- elasticsearch/_async/client/ccr.py | 26 ++-- elasticsearch/_async/client/cluster.py | 30 ++--- .../_async/client/dangling_indices.py | 6 +- elasticsearch/_async/client/data_frame.py | 1 + elasticsearch/_async/client/deprecation.py | 2 +- elasticsearch/_async/client/enrich.py | 10 +- elasticsearch/_async/client/eql.py | 6 +- elasticsearch/_async/client/graph.py | 2 +- elasticsearch/_async/client/ilm.py | 20 +-- elasticsearch/_async/client/indices.py | 102 +++++++-------- elasticsearch/_async/client/ingest.py | 10 +- elasticsearch/_async/client/license.py | 14 +-- elasticsearch/_async/client/migration.py | 2 +- elasticsearch/_async/client/ml.py | 116 +++++++++--------- elasticsearch/_async/client/monitoring.py | 2 +- elasticsearch/_async/client/nodes.py | 10 +- elasticsearch/_async/client/remote.py | 2 +- elasticsearch/_async/client/rollup.py | 16 +-- .../_async/client/searchable_snapshots.py | 8 +- elasticsearch/_async/client/security.py | 54 ++++---- elasticsearch/_async/client/slm.py | 18 +-- elasticsearch/_async/client/snapshot.py | 20 +-- elasticsearch/_async/client/sql.py | 6 +- elasticsearch/_async/client/ssl.py | 2 +- elasticsearch/_async/client/tasks.py | 6 +- elasticsearch/_async/client/transform.py | 16 +-- elasticsearch/_async/client/watcher.py | 20 +-- elasticsearch/_async/client/xpack.py | 4 +- elasticsearch/client/__init__.py | 72 +++++------ elasticsearch/client/async_search.py | 6 +- elasticsearch/client/autoscaling.py | 8 +- elasticsearch/client/cat.py | 50 ++++---- elasticsearch/client/ccr.py | 26 ++-- elasticsearch/client/cluster.py | 30 ++--- elasticsearch/client/dangling_indices.py | 6 +- elasticsearch/client/data_frame.py | 1 + elasticsearch/client/deprecation.py | 2 +- elasticsearch/client/enrich.py | 10 +- elasticsearch/client/eql.py | 6 +- elasticsearch/client/graph.py | 2 +- elasticsearch/client/ilm.py | 20 +-- elasticsearch/client/indices.py | 102 +++++++-------- elasticsearch/client/ingest.py | 10 +- elasticsearch/client/license.py | 14 +-- elasticsearch/client/migration.py | 2 +- elasticsearch/client/ml.py | 116 +++++++++--------- elasticsearch/client/monitoring.py | 2 +- elasticsearch/client/nodes.py | 10 +- elasticsearch/client/remote.py | 2 +- elasticsearch/client/rollup.py | 16 +-- elasticsearch/client/searchable_snapshots.py | 8 +- elasticsearch/client/security.py | 54 ++++---- elasticsearch/client/slm.py | 18 +-- elasticsearch/client/snapshot.py | 20 +-- elasticsearch/client/sql.py | 6 +- elasticsearch/client/ssl.py | 2 +- elasticsearch/client/tasks.py | 6 +- elasticsearch/client/transform.py | 16 +-- elasticsearch/client/watcher.py | 20 +-- elasticsearch/client/xpack.py | 4 +- utils/generate_api.py | 2 +- 65 files changed, 669 insertions(+), 667 deletions(-) diff --git a/elasticsearch/_async/client/__init__.py b/elasticsearch/_async/client/__init__.py index a320d825e..10ddaa31b 100644 --- a/elasticsearch/_async/client/__init__.py +++ b/elasticsearch/_async/client/__init__.py @@ -266,7 +266,7 @@ async def close(self): async def ping(self, params=None, headers=None): """ Returns whether the cluster is running. - ``_ + ``_ """ try: return await self.transport.perform_request( @@ -279,7 +279,7 @@ async def ping(self, params=None, headers=None): async def info(self, params=None, headers=None): """ Returns basic information about the cluster. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/", params=params, headers=headers @@ -298,7 +298,7 @@ async def create(self, index, id, body, doc_type=None, params=None, headers=None """ Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. - ``_ + ``_ :arg index: The name of the index :arg id: Document ID @@ -351,7 +351,7 @@ async def index( ): """ Creates or updates a document in an index. - ``_ + ``_ :arg index: The name of the index :arg body: The document @@ -411,7 +411,7 @@ async def index( async def bulk(self, body, index=None, doc_type=None, params=None, headers=None): """ Allows to perform multiple index/update/delete operations in a single request. - ``_ + ``_ :arg body: The operation definition and data (action-data pairs), separated by newlines @@ -455,7 +455,7 @@ async def bulk(self, body, index=None, doc_type=None, params=None, headers=None) async def clear_scroll(self, body=None, scroll_id=None, params=None, headers=None): """ Explicitly clears the search context for a scroll. - ``_ + ``_ :arg body: A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter @@ -493,7 +493,7 @@ async def count( ): """ Returns number of documents matching a query. - ``_ + ``_ :arg body: A query to restrict the results specified with the Query DSL (optional) @@ -550,7 +550,7 @@ async def count( async def delete(self, index, id, doc_type=None, params=None, headers=None): """ Removes a document from the index. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -627,7 +627,7 @@ async def delete_by_query( ): """ Deletes documents matching the provided query. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -723,7 +723,7 @@ async def delete_by_query_rethrottle(self, task_id, params=None, headers=None): """ Changes the number of requests per second for a particular Delete By Query operation. - ``_ + ``_ :arg task_id: The task id to rethrottle :arg requests_per_second: The throttle to set on this request in @@ -743,7 +743,7 @@ async def delete_by_query_rethrottle(self, task_id, params=None, headers=None): async def delete_script(self, id, params=None, headers=None): """ Deletes a script. - ``_ + ``_ :arg id: Script ID :arg master_timeout: Specify timeout for connection to master @@ -771,7 +771,7 @@ async def delete_script(self, id, params=None, headers=None): async def exists(self, index, id, doc_type=None, params=None, headers=None): """ Returns information about whether a document exists in an index. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -821,7 +821,7 @@ async def exists(self, index, id, doc_type=None, params=None, headers=None): async def exists_source(self, index, id, doc_type=None, params=None, headers=None): """ Returns information about whether a document source exists in an index. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -876,7 +876,7 @@ async def explain( ): """ Returns information about why a specific matches (or doesn't match) a query. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -928,7 +928,7 @@ async def field_caps(self, body=None, index=None, params=None, headers=None): """ Returns the information about the capabilities of fields among multiple indices. - ``_ + ``_ :arg body: An index filter specified with the Query DSL :arg index: A comma-separated list of index names; use `_all` or @@ -968,7 +968,7 @@ async def field_caps(self, body=None, index=None, params=None, headers=None): async def get(self, index, id, doc_type=None, params=None, headers=None): """ Returns a document. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -1008,7 +1008,7 @@ async def get(self, index, id, doc_type=None, params=None, headers=None): async def get_script(self, id, params=None, headers=None): """ Returns a script. - ``_ + ``_ :arg id: Script ID :arg master_timeout: Specify timeout for connection to master @@ -1034,7 +1034,7 @@ async def get_script(self, id, params=None, headers=None): async def get_source(self, index, id, doc_type=None, params=None, headers=None): """ Returns the source of a document. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -1083,7 +1083,7 @@ async def get_source(self, index, id, doc_type=None, params=None, headers=None): async def mget(self, body, index=None, doc_type=None, params=None, headers=None): """ Allows to get multiple documents in one request. - ``_ + ``_ :arg body: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is @@ -1129,7 +1129,7 @@ async def mget(self, body, index=None, doc_type=None, params=None, headers=None) async def msearch(self, body, index=None, doc_type=None, params=None, headers=None): """ Allows to execute several search operations in one request. - ``_ + ``_ :arg body: The request definitions (metadata-search request definition pairs), separated by newlines @@ -1185,7 +1185,7 @@ async def msearch_template( ): """ Allows to execute several search template operations in one request. - ``_ + ``_ :arg body: The request definitions (metadata-search request definition pairs), separated by newlines @@ -1237,7 +1237,7 @@ async def mtermvectors( ): """ Returns multiple termvectors in one request. - ``_ + ``_ :arg body: Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of @@ -1289,7 +1289,7 @@ async def mtermvectors( async def put_script(self, id, body, context=None, params=None, headers=None): """ Creates or updates a script. - ``_ + ``_ :arg id: Script ID :arg body: The document @@ -1316,7 +1316,7 @@ async def rank_eval(self, body, index=None, params=None, headers=None): """ Allows to evaluate the quality of ranked search results over a set of typical search queries - ``_ + ``_ :arg body: The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. @@ -1359,7 +1359,7 @@ async def reindex(self, body, params=None, headers=None): Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. - ``_ + ``_ :arg body: The search definition using the Query DSL and the prototype for the index request. @@ -1394,7 +1394,7 @@ async def reindex(self, body, params=None, headers=None): async def reindex_rethrottle(self, task_id, params=None, headers=None): """ Changes the number of requests per second for a particular Reindex operation. - ``_ + ``_ :arg task_id: The task id to rethrottle :arg requests_per_second: The throttle to set on this request in @@ -1416,7 +1416,7 @@ async def render_search_template( ): """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :arg body: The search definition template and its params :arg id: The id of the stored search template @@ -1449,7 +1449,7 @@ async def scripts_painless_execute(self, body=None, params=None, headers=None): async def scroll(self, body=None, scroll_id=None, params=None, headers=None): """ Allows to retrieve a large numbers of results from a single search request. - ``_ + ``_ :arg body: The scroll ID if not passed by URL or query parameter. @@ -1519,7 +1519,7 @@ async def search( ): """ Returns results matching a query. - ``_ + ``_ :arg body: The search definition using the Query DSL :arg index: A comma-separated list of index names to search; use @@ -1641,7 +1641,7 @@ async def search_shards(self, index=None, params=None, headers=None): """ Returns information about the indices and shards that a search request would be executed against. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -1683,7 +1683,7 @@ async def search_template( ): """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :arg body: The search definition template and its params :arg index: A comma-separated list of index names to search; use @@ -1749,7 +1749,7 @@ async def termvectors( """ Returns information and statistics about terms in the fields of a particular document. - ``_ + ``_ :arg index: The index in which the document resides. :arg body: Define parameters and or supply a document to get @@ -1806,7 +1806,7 @@ async def termvectors( async def update(self, index, id, body, doc_type=None, params=None, headers=None): """ Updates a document with a script or partial document. - ``_ + ``_ :arg index: The name of the index :arg id: Document ID @@ -1896,7 +1896,7 @@ async def update_by_query( """ Performs an update on every document in the index without changing the source, for example to pick up a mapping change. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -1995,7 +1995,7 @@ async def update_by_query_rethrottle(self, task_id, params=None, headers=None): """ Changes the number of requests per second for a particular Update By Query operation. - ``_ + ``_ :arg task_id: The task id to rethrottle :arg requests_per_second: The throttle to set on this request in @@ -2025,7 +2025,7 @@ async def get_script_context(self, params=None, headers=None): async def get_script_languages(self, params=None, headers=None): """ Returns available script types, languages and contexts - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_script_language", params=params, headers=headers diff --git a/elasticsearch/_async/client/async_search.py b/elasticsearch/_async/client/async_search.py index bce2d77dd..34a214d47 100644 --- a/elasticsearch/_async/client/async_search.py +++ b/elasticsearch/_async/client/async_search.py @@ -24,7 +24,7 @@ async def delete(self, id, params=None, headers=None): """ Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :arg id: The async search ID """ @@ -40,7 +40,7 @@ async def get(self, id, params=None, headers=None): """ Retrieves the results of a previously submitted async search request given its ID. - ``_ + ``_ :arg id: The async search ID :arg keep_alive: Specify the time interval in which the results @@ -103,7 +103,7 @@ async def get(self, id, params=None, headers=None): async def submit(self, body=None, index=None, params=None, headers=None): """ Executes a search request asynchronously. - ``_ + ``_ :arg body: The search definition using the Query DSL :arg index: A comma-separated list of index names to search; use diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py index b94523791..52ce3bacf 100644 --- a/elasticsearch/_async/client/autoscaling.py +++ b/elasticsearch/_async/client/autoscaling.py @@ -24,7 +24,7 @@ async def get_autoscaling_decision(self, params=None, headers=None): """ Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_autoscaling/decision", params=params, headers=headers @@ -34,7 +34,7 @@ async def get_autoscaling_decision(self, params=None, headers=None): async def delete_autoscaling_policy(self, name, params=None, headers=None): """ Deletes an autoscaling policy. - ``_ + ``_ :arg name: the name of the autoscaling policy """ @@ -52,7 +52,7 @@ async def delete_autoscaling_policy(self, name, params=None, headers=None): async def get_autoscaling_policy(self, name, params=None, headers=None): """ Retrieves an autoscaling policy. - ``_ + ``_ :arg name: the name of the autoscaling policy """ @@ -70,7 +70,7 @@ async def get_autoscaling_policy(self, name, params=None, headers=None): async def put_autoscaling_policy(self, name, body, params=None, headers=None): """ Creates a new autoscaling policy. - ``_ + ``_ :arg name: the name of the autoscaling policy :arg body: the specification of the autoscaling policy diff --git a/elasticsearch/_async/client/cat.py b/elasticsearch/_async/client/cat.py index 817194f2a..b2535984f 100644 --- a/elasticsearch/_async/client/cat.py +++ b/elasticsearch/_async/client/cat.py @@ -24,7 +24,7 @@ async def aliases(self, name=None, params=None, headers=None): """ Shows information about currently configured aliases to indices including filter and routing infos. - ``_ + ``_ :arg name: A comma-separated list of alias names to return :arg expand_wildcards: Whether to expand wildcard expression to @@ -49,7 +49,7 @@ async def allocation(self, node_id=None, params=None, headers=None): """ Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information @@ -79,7 +79,7 @@ async def count(self, index=None, params=None, headers=None): """ Provides quick access to the document count of the entire cluster, or individual indices. - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -99,7 +99,7 @@ async def count(self, index=None, params=None, headers=None): async def health(self, params=None, headers=None): """ Returns a concise representation of the cluster health. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -120,7 +120,7 @@ async def health(self, params=None, headers=None): async def help(self, params=None, headers=None): """ Returns help for the Cat APIs. - ``_ + ``_ :arg help: Return help information :arg s: Comma-separated list of column names or column aliases @@ -149,7 +149,7 @@ async def indices(self, index=None, params=None, headers=None): """ Returns information about indices: number of primaries and replicas, document counts, disk size, ... - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -187,7 +187,7 @@ async def indices(self, index=None, params=None, headers=None): async def master(self, params=None, headers=None): """ Returns information about the master node. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -220,7 +220,7 @@ async def master(self, params=None, headers=None): async def nodes(self, params=None, headers=None): """ Returns basic statistics about performance of cluster nodes. - ``_ + ``_ :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb @@ -250,7 +250,7 @@ async def nodes(self, params=None, headers=None): async def recovery(self, index=None, params=None, headers=None): """ Returns information about index shard recoveries, both on-going completed. - ``_ + ``_ :arg index: Comma-separated list or wildcard expression of index names to limit the returned information @@ -280,7 +280,7 @@ async def recovery(self, index=None, params=None, headers=None): async def shards(self, index=None, params=None, headers=None): """ Provides a detailed view of shard allocation on nodes. - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -308,7 +308,7 @@ async def shards(self, index=None, params=None, headers=None): async def segments(self, index=None, params=None, headers=None): """ Provides low-level information about the segments in the shards of an index. - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -330,7 +330,7 @@ async def segments(self, index=None, params=None, headers=None): async def pending_tasks(self, params=None, headers=None): """ Returns a concise representation of the cluster pending tasks. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -355,7 +355,7 @@ async def thread_pool(self, thread_pool_patterns=None, params=None, headers=None """ Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. - ``_ + ``_ :arg thread_pool_patterns: A comma-separated list of regular- expressions to filter the thread pools in the output @@ -385,7 +385,7 @@ async def fielddata(self, fields=None, params=None, headers=None): """ Shows how much heap memory is currently being used by fielddata on every data node in the cluster. - ``_ + ``_ :arg fields: A comma-separated list of fields to return in the output @@ -410,7 +410,7 @@ async def fielddata(self, fields=None, params=None, headers=None): async def plugins(self, params=None, headers=None): """ Returns information about installed plugins across nodes node. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -432,7 +432,7 @@ async def plugins(self, params=None, headers=None): async def nodeattrs(self, params=None, headers=None): """ Returns information about custom node attributes. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -454,7 +454,7 @@ async def nodeattrs(self, params=None, headers=None): async def repositories(self, params=None, headers=None): """ Returns information about snapshot repositories registered in the cluster. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -478,7 +478,7 @@ async def repositories(self, params=None, headers=None): async def snapshots(self, repository=None, params=None, headers=None): """ Returns all snapshots in a specific repository. - ``_ + ``_ :arg repository: Name of repository from which to fetch the snapshot information @@ -519,7 +519,7 @@ async def tasks(self, params=None, headers=None): """ Returns information about the tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :arg actions: A comma-separated list of actions that should be returned. Leave empty to return all. @@ -548,7 +548,7 @@ async def tasks(self, params=None, headers=None): async def templates(self, name=None, params=None, headers=None): """ Returns information about existing templates. - ``_ + ``_ :arg name: A pattern that returned template names must match :arg format: a short version of the Accept header, e.g. json, @@ -571,7 +571,7 @@ async def templates(self, name=None, params=None, headers=None): async def ml_data_frame_analytics(self, id=None, params=None, headers=None): """ Gets configuration and usage information about data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -600,7 +600,7 @@ async def ml_data_frame_analytics(self, id=None, params=None, headers=None): async def ml_datafeeds(self, datafeed_id=None, params=None, headers=None): """ Gets configuration and usage information about datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeeds stats to fetch :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -627,7 +627,7 @@ async def ml_datafeeds(self, datafeed_id=None, params=None, headers=None): async def ml_jobs(self, job_id=None, params=None, headers=None): """ Gets configuration and usage information about anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the jobs stats to fetch :arg allow_no_jobs: Whether to ignore if a wildcard expression @@ -667,7 +667,7 @@ async def ml_jobs(self, job_id=None, params=None, headers=None): async def ml_trained_models(self, model_id=None, params=None, headers=None): """ Gets configuration and usage information about inference trained models. - ``_ + ``_ :arg model_id: The ID of the trained models stats to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -705,7 +705,7 @@ async def ml_trained_models(self, model_id=None, params=None, headers=None): async def transforms(self, transform_id=None, params=None, headers=None): """ Gets configuration and usage information about transforms. - ``_ + ``_ :arg transform_id: The id of the transform for which to get stats. '_all' or '*' implies all transforms diff --git a/elasticsearch/_async/client/ccr.py b/elasticsearch/_async/client/ccr.py index a4e8d02a8..4a2cfe3e2 100644 --- a/elasticsearch/_async/client/ccr.py +++ b/elasticsearch/_async/client/ccr.py @@ -23,7 +23,7 @@ class CcrClient(NamespacedClient): async def delete_auto_follow_pattern(self, name, params=None, headers=None): """ Deletes auto-follow patterns. - ``_ + ``_ :arg name: The name of the auto follow pattern. """ @@ -41,7 +41,7 @@ async def delete_auto_follow_pattern(self, name, params=None, headers=None): async def follow(self, index, body, params=None, headers=None): """ Creates a new follower index configured to follow the referenced leader index. - ``_ + ``_ :arg index: The name of the follower index :arg body: The name of the leader index and other optional ccr @@ -69,7 +69,7 @@ async def follow_info(self, index, params=None, headers=None): """ Retrieves information about all follower indices, including parameters and status for each follower index - ``_ + ``_ :arg index: A comma-separated list of index patterns; use `_all` to perform the operation on all indices @@ -86,7 +86,7 @@ async def follow_stats(self, index, params=None, headers=None): """ Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. - ``_ + ``_ :arg index: A comma-separated list of index patterns; use `_all` to perform the operation on all indices @@ -102,7 +102,7 @@ async def follow_stats(self, index, params=None, headers=None): async def forget_follower(self, index, body, params=None, headers=None): """ Removes the follower retention leases from the leader. - ``_ + ``_ :arg index: the name of the leader index for which specified follower retention leases should be removed @@ -128,7 +128,7 @@ async def get_auto_follow_pattern(self, name=None, params=None, headers=None): """ Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. - ``_ + ``_ :arg name: The name of the auto follow pattern. """ @@ -144,7 +144,7 @@ async def pause_follow(self, index, params=None, headers=None): """ Pauses a follower index. The follower index will not fetch any additional operations from the leader index. - ``_ + ``_ :arg index: The name of the follower index that should pause following its leader index. @@ -165,7 +165,7 @@ async def put_auto_follow_pattern(self, name, body, params=None, headers=None): Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. - ``_ + ``_ :arg name: The name of the auto follow pattern. :arg body: The specification of the auto follow pattern @@ -186,7 +186,7 @@ async def put_auto_follow_pattern(self, name, body, params=None, headers=None): async def resume_follow(self, index, body=None, params=None, headers=None): """ Resumes a follower index that has been paused - ``_ + ``_ :arg index: The name of the follow index to resume following. :arg body: The name of the leader index and other optional ccr @@ -207,7 +207,7 @@ async def resume_follow(self, index, body=None, params=None, headers=None): async def stats(self, params=None, headers=None): """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_ccr/stats", params=params, headers=headers @@ -218,7 +218,7 @@ async def unfollow(self, index, params=None, headers=None): """ Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. - ``_ + ``_ :arg index: The name of the follower index that should be turned into a regular index. @@ -237,7 +237,7 @@ async def unfollow(self, index, params=None, headers=None): async def pause_auto_follow_pattern(self, name, params=None, headers=None): """ Pauses an auto-follow pattern - ``_ + ``_ :arg name: The name of the auto follow pattern that should pause discovering new indices to follow. @@ -256,7 +256,7 @@ async def pause_auto_follow_pattern(self, name, params=None, headers=None): async def resume_auto_follow_pattern(self, name, params=None, headers=None): """ Resumes an auto-follow pattern that has been paused - ``_ + ``_ :arg name: The name of the auto follow pattern to resume discovering new indices to follow. diff --git a/elasticsearch/_async/client/cluster.py b/elasticsearch/_async/client/cluster.py index 951c86016..1d2e05cb2 100644 --- a/elasticsearch/_async/client/cluster.py +++ b/elasticsearch/_async/client/cluster.py @@ -35,7 +35,7 @@ class ClusterClient(NamespacedClient): async def health(self, index=None, params=None, headers=None): """ Returns basic information about the health of the cluster. - ``_ + ``_ :arg index: Limit the information returned to a specific index :arg expand_wildcards: Whether to expand wildcard expression to @@ -74,7 +74,7 @@ async def pending_tasks(self, params=None, headers=None): """ Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. - ``_ + ``_ :arg local: Return local information, do not retrieve the state from master node (default: false) @@ -97,7 +97,7 @@ async def pending_tasks(self, params=None, headers=None): async def state(self, metric=None, index=None, params=None, headers=None): """ Returns a comprehensive information about the state of the cluster. - ``_ + ``_ :arg metric: Limit the information returned to the specified metrics Valid choices: _all, blocks, metadata, nodes, routing_table, @@ -136,7 +136,7 @@ async def state(self, metric=None, index=None, params=None, headers=None): async def stats(self, node_id=None, params=None, headers=None): """ Returns high-level overview of cluster statistics. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -161,7 +161,7 @@ async def stats(self, node_id=None, params=None, headers=None): async def reroute(self, body=None, params=None, headers=None): """ Allows to manually change the allocation of individual shards in the cluster. - ``_ + ``_ :arg body: The definition of `commands` to perform (`move`, `cancel`, `allocate`) @@ -186,7 +186,7 @@ async def reroute(self, body=None, params=None, headers=None): async def get_settings(self, params=None, headers=None): """ Returns cluster settings. - ``_ + ``_ :arg flat_settings: Return settings in flat format (default: false) @@ -204,7 +204,7 @@ async def get_settings(self, params=None, headers=None): async def put_settings(self, body, params=None, headers=None): """ Updates the cluster settings. - ``_ + ``_ :arg body: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). @@ -225,7 +225,7 @@ async def put_settings(self, body, params=None, headers=None): async def remote_info(self, params=None, headers=None): """ Returns the information about configured remote clusters. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_remote/info", params=params, headers=headers @@ -235,7 +235,7 @@ async def remote_info(self, params=None, headers=None): async def allocation_explain(self, body=None, params=None, headers=None): """ Provides explanations for shard allocations in the cluster. - ``_ + ``_ :arg body: The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' @@ -256,7 +256,7 @@ async def allocation_explain(self, body=None, params=None, headers=None): async def delete_component_template(self, name, params=None, headers=None): """ Deletes a component template - ``_ + ``_ :arg name: The name of the template :arg master_timeout: Specify timeout for connection to master @@ -276,7 +276,7 @@ async def delete_component_template(self, name, params=None, headers=None): async def get_component_template(self, name=None, params=None, headers=None): """ Returns one or more component templates - ``_ + ``_ :arg name: The comma separated names of the component templates :arg local: Return local information, do not retrieve the state @@ -295,7 +295,7 @@ async def get_component_template(self, name=None, params=None, headers=None): async def put_component_template(self, name, body, params=None, headers=None): """ Creates or updates a component template - ``_ + ``_ :arg name: The name of the template :arg body: The template definition @@ -320,7 +320,7 @@ async def put_component_template(self, name, body, params=None, headers=None): async def exists_component_template(self, name, params=None, headers=None): """ Returns information about whether a particular component template exist - ``_ + ``_ :arg name: The name of the template :arg local: Return local information, do not retrieve the state @@ -342,7 +342,7 @@ async def exists_component_template(self, name, params=None, headers=None): async def delete_voting_config_exclusions(self, params=None, headers=None): """ Clears cluster voting config exclusions. - ``_ + ``_ :arg wait_for_removal: Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting @@ -359,7 +359,7 @@ async def delete_voting_config_exclusions(self, params=None, headers=None): async def post_voting_config_exclusions(self, params=None, headers=None): """ Updates the cluster voting config exclusions by node ids or node names. - ``_ + ``_ :arg node_ids: A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you diff --git a/elasticsearch/_async/client/dangling_indices.py b/elasticsearch/_async/client/dangling_indices.py index 1535dc5ea..60af17d76 100644 --- a/elasticsearch/_async/client/dangling_indices.py +++ b/elasticsearch/_async/client/dangling_indices.py @@ -23,7 +23,7 @@ class DanglingIndicesClient(NamespacedClient): async def delete_dangling_index(self, index_uuid, params=None, headers=None): """ Deletes the specified dangling index - ``_ + ``_ :arg index_uuid: The UUID of the dangling index :arg accept_data_loss: Must be set to true in order to delete @@ -45,7 +45,7 @@ async def delete_dangling_index(self, index_uuid, params=None, headers=None): async def import_dangling_index(self, index_uuid, params=None, headers=None): """ Imports the specified dangling index - ``_ + ``_ :arg index_uuid: The UUID of the dangling index :arg accept_data_loss: Must be set to true in order to import @@ -64,7 +64,7 @@ async def import_dangling_index(self, index_uuid, params=None, headers=None): async def list_dangling_indices(self, params=None, headers=None): """ Returns all dangling indices. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_dangling", params=params, headers=headers diff --git a/elasticsearch/_async/client/data_frame.py b/elasticsearch/_async/client/data_frame.py index 12bf19fa2..f52391af3 100644 --- a/elasticsearch/_async/client/data_frame.py +++ b/elasticsearch/_async/client/data_frame.py @@ -72,6 +72,7 @@ async def get_data_frame_transform_stats( "GET", _make_path("_data_frame", "transforms", transform_id, "_stats"), params=params, + headers=headers, ) @query_params() diff --git a/elasticsearch/_async/client/deprecation.py b/elasticsearch/_async/client/deprecation.py index 05a9886c2..72026232d 100644 --- a/elasticsearch/_async/client/deprecation.py +++ b/elasticsearch/_async/client/deprecation.py @@ -22,7 +22,7 @@ class DeprecationClient(NamespacedClient): @query_params() async def info(self, index=None, params=None, headers=None): """ - ``_ + ``_ :arg index: Index pattern """ diff --git a/elasticsearch/_async/client/enrich.py b/elasticsearch/_async/client/enrich.py index d034d3ecd..9779b32f0 100644 --- a/elasticsearch/_async/client/enrich.py +++ b/elasticsearch/_async/client/enrich.py @@ -23,7 +23,7 @@ class EnrichClient(NamespacedClient): async def delete_policy(self, name, params=None, headers=None): """ Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :arg name: The name of the enrich policy """ @@ -41,7 +41,7 @@ async def delete_policy(self, name, params=None, headers=None): async def execute_policy(self, name, params=None, headers=None): """ Creates the enrich index for an existing enrich policy. - ``_ + ``_ :arg name: The name of the enrich policy :arg wait_for_completion: Should the request should block until @@ -61,7 +61,7 @@ async def execute_policy(self, name, params=None, headers=None): async def get_policy(self, name=None, params=None, headers=None): """ Gets information about an enrich policy. - ``_ + ``_ :arg name: A comma-separated list of enrich policy names """ @@ -73,7 +73,7 @@ async def get_policy(self, name=None, params=None, headers=None): async def put_policy(self, name, body, params=None, headers=None): """ Creates a new enrich policy. - ``_ + ``_ :arg name: The name of the enrich policy :arg body: The enrich policy to register @@ -95,7 +95,7 @@ async def stats(self, params=None, headers=None): """ Gets enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_enrich/_stats", params=params, headers=headers diff --git a/elasticsearch/_async/client/eql.py b/elasticsearch/_async/client/eql.py index 3f2ff9fe6..e86198e11 100644 --- a/elasticsearch/_async/client/eql.py +++ b/elasticsearch/_async/client/eql.py @@ -23,7 +23,7 @@ class EqlClient(NamespacedClient): async def search(self, index, body, params=None, headers=None): """ Returns results matching a query expressed in Event Query Language (EQL) - ``_ + ``_ :arg index: The name of the index to scope the operation :arg body: Eql request body. Use the `query` to limit the query @@ -53,7 +53,7 @@ async def delete(self, id, params=None, headers=None): """ Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :arg id: The async search ID """ @@ -69,7 +69,7 @@ async def get(self, id, params=None, headers=None): """ Returns async results from previously executed Event Query Language (EQL) search - ``_ + ``_ :arg id: The async search ID :arg keep_alive: Update the time interval in which the results diff --git a/elasticsearch/_async/client/graph.py b/elasticsearch/_async/client/graph.py index a0e168250..0c892832e 100644 --- a/elasticsearch/_async/client/graph.py +++ b/elasticsearch/_async/client/graph.py @@ -24,7 +24,7 @@ async def explore(self, index, body=None, doc_type=None, params=None, headers=No """ Explore extracted and summarized information about the documents and terms in an index. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_async/client/ilm.py b/elasticsearch/_async/client/ilm.py index 5ff05bd80..203bd3e1f 100644 --- a/elasticsearch/_async/client/ilm.py +++ b/elasticsearch/_async/client/ilm.py @@ -24,7 +24,7 @@ async def delete_lifecycle(self, policy, params=None, headers=None): """ Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. - ``_ + ``_ :arg policy: The name of the index lifecycle policy """ @@ -43,7 +43,7 @@ async def explain_lifecycle(self, index, params=None, headers=None): """ Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. - ``_ + ``_ :arg index: The name of the index to explain :arg only_errors: filters the indices included in the response @@ -63,7 +63,7 @@ async def get_lifecycle(self, policy=None, params=None, headers=None): """ Returns the specified policy definition. Includes the policy version and last modified date. - ``_ + ``_ :arg policy: The name of the index lifecycle policy """ @@ -75,7 +75,7 @@ async def get_lifecycle(self, policy=None, params=None, headers=None): async def get_status(self, params=None, headers=None): """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_ilm/status", params=params, headers=headers @@ -85,7 +85,7 @@ async def get_status(self, params=None, headers=None): async def move_to_step(self, index, body=None, params=None, headers=None): """ Manually moves an index into the specified step and executes that step. - ``_ + ``_ :arg index: The name of the index whose lifecycle step is to change @@ -106,7 +106,7 @@ async def move_to_step(self, index, body=None, params=None, headers=None): async def put_lifecycle(self, policy, body=None, params=None, headers=None): """ Creates a lifecycle policy - ``_ + ``_ :arg policy: The name of the index lifecycle policy :arg body: The lifecycle policy definition to register @@ -126,7 +126,7 @@ async def put_lifecycle(self, policy, body=None, params=None, headers=None): async def remove_policy(self, index, params=None, headers=None): """ Removes the assigned lifecycle policy and stops managing the specified index - ``_ + ``_ :arg index: The name of the index to remove policy on """ @@ -141,7 +141,7 @@ async def remove_policy(self, index, params=None, headers=None): async def retry(self, index, params=None, headers=None): """ Retries executing the policy for an index that is in the ERROR step. - ``_ + ``_ :arg index: The name of the indices (comma-separated) whose failed lifecycle step is to be retry @@ -157,7 +157,7 @@ async def retry(self, index, params=None, headers=None): async def start(self, params=None, headers=None): """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ """ return await self.transport.perform_request( "POST", "/_ilm/start", params=params, headers=headers @@ -168,7 +168,7 @@ async def stop(self, params=None, headers=None): """ Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin - ``_ + ``_ """ return await self.transport.perform_request( "POST", "/_ilm/stop", params=params, headers=headers diff --git a/elasticsearch/_async/client/indices.py b/elasticsearch/_async/client/indices.py index c3a27f558..580a4248b 100644 --- a/elasticsearch/_async/client/indices.py +++ b/elasticsearch/_async/client/indices.py @@ -24,7 +24,7 @@ async def analyze(self, body=None, index=None, params=None, headers=None): """ Performs the analysis process on a text and return the tokens breakdown of the text. - ``_ + ``_ :arg body: Define analyzer/tokenizer parameters and the text on which the analysis should be performed @@ -42,7 +42,7 @@ async def analyze(self, body=None, index=None, params=None, headers=None): async def refresh(self, index=None, params=None, headers=None): """ Performs the refresh operation in one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -69,7 +69,7 @@ async def refresh(self, index=None, params=None, headers=None): async def flush(self, index=None, params=None, headers=None): """ Performs the flush operation on one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string for all indices @@ -101,7 +101,7 @@ async def flush(self, index=None, params=None, headers=None): async def create(self, index, body=None, params=None, headers=None): """ Creates an index with optional settings and mappings. - ``_ + ``_ :arg index: The name of the index :arg body: The configuration for the index (`settings` and @@ -124,7 +124,7 @@ async def create(self, index, body=None, params=None, headers=None): async def clone(self, index, target, body=None, params=None, headers=None): """ Clones an index - ``_ + ``_ :arg index: The name of the source index to clone :arg target: The name of the target index to clone into @@ -160,7 +160,7 @@ async def clone(self, index, target, body=None, params=None, headers=None): async def get(self, index, params=None, headers=None): """ Returns information about one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names :arg allow_no_indices: Ignore if a wildcard expression resolves @@ -198,7 +198,7 @@ async def get(self, index, params=None, headers=None): async def open(self, index, params=None, headers=None): """ Opens an index. - ``_ + ``_ :arg index: A comma separated list of indices to open :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -232,7 +232,7 @@ async def open(self, index, params=None, headers=None): async def close(self, index, params=None, headers=None): """ Closes an index. - ``_ + ``_ :arg index: A comma separated list of indices to close :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -265,7 +265,7 @@ async def close(self, index, params=None, headers=None): async def delete(self, index, params=None, headers=None): """ Deletes an index. - ``_ + ``_ :arg index: A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices @@ -297,7 +297,7 @@ async def delete(self, index, params=None, headers=None): async def exists(self, index, params=None, headers=None): """ Returns information about whether a particular index exists. - ``_ + ``_ :arg index: A comma-separated list of index names :arg allow_no_indices: Ignore if a wildcard expression resolves @@ -326,7 +326,7 @@ async def exists_type(self, index, doc_type, params=None, headers=None): """ Returns information about whether a particular document type exists. (DEPRECATED) - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` to check the types across all indices @@ -367,7 +367,7 @@ async def put_mapping( ): """ Updates the index mappings. - ``_ + ``_ :arg body: The mapping definition :arg index: A comma-separated list of index names the mapping @@ -414,7 +414,7 @@ async def put_mapping( async def get_mapping(self, index=None, doc_type=None, params=None, headers=None): """ Returns mappings for one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names :arg doc_type: A comma-separated list of document types @@ -452,7 +452,7 @@ async def get_field_mapping( ): """ Returns mapping for one or more fields. - ``_ + ``_ :arg fields: A comma-separated list of fields :arg index: A comma-separated list of index names @@ -486,7 +486,7 @@ async def get_field_mapping( async def put_alias(self, index, name, body=None, params=None, headers=None): """ Creates or updates an alias. - ``_ + ``_ :arg index: A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the @@ -513,7 +513,7 @@ async def put_alias(self, index, name, body=None, params=None, headers=None): async def exists_alias(self, name, index=None, params=None, headers=None): """ Returns information about whether a particular alias exists. - ``_ + ``_ :arg name: A comma-separated list of alias names to return :arg index: A comma-separated list of index names to filter @@ -540,7 +540,7 @@ async def exists_alias(self, name, index=None, params=None, headers=None): async def get_alias(self, index=None, name=None, params=None, headers=None): """ Returns an alias. - ``_ + ``_ :arg index: A comma-separated list of index names to filter aliases @@ -564,7 +564,7 @@ async def get_alias(self, index=None, name=None, params=None, headers=None): async def update_aliases(self, body, params=None, headers=None): """ Updates index aliases. - ``_ + ``_ :arg body: The definition of `actions` to perform :arg master_timeout: Specify timeout for connection to master @@ -581,7 +581,7 @@ async def update_aliases(self, body, params=None, headers=None): async def delete_alias(self, index, name, params=None, headers=None): """ Deletes an alias. - ``_ + ``_ :arg index: A comma-separated list of index names (supports wildcards); use `_all` for all indices @@ -602,7 +602,7 @@ async def delete_alias(self, index, name, params=None, headers=None): async def put_template(self, name, body, params=None, headers=None): """ Creates or updates an index template. - ``_ + ``_ :arg name: The name of the template :arg body: The template definition @@ -631,7 +631,7 @@ async def put_template(self, name, body, params=None, headers=None): async def exists_template(self, name, params=None, headers=None): """ Returns information about whether a particular index template exists. - ``_ + ``_ :arg name: The comma separated names of the index templates :arg flat_settings: Return settings in flat format (default: @@ -652,7 +652,7 @@ async def exists_template(self, name, params=None, headers=None): async def get_template(self, name=None, params=None, headers=None): """ Returns an index template. - ``_ + ``_ :arg name: The comma separated names of the index templates :arg flat_settings: Return settings in flat format (default: @@ -672,7 +672,7 @@ async def get_template(self, name=None, params=None, headers=None): async def delete_template(self, name, params=None, headers=None): """ Deletes an index template. - ``_ + ``_ :arg name: The name of the template :arg master_timeout: Specify timeout for connection to master @@ -697,7 +697,7 @@ async def delete_template(self, name, params=None, headers=None): async def get_settings(self, index=None, name=None, params=None, headers=None): """ Returns settings for one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -734,7 +734,7 @@ async def get_settings(self, index=None, name=None, params=None, headers=None): async def put_settings(self, body, index=None, params=None, headers=None): """ Updates the index settings. - ``_ + ``_ :arg body: The index settings to be updated :arg index: A comma-separated list of index names; use `_all` or @@ -781,7 +781,7 @@ async def put_settings(self, body, index=None, params=None, headers=None): async def stats(self, index=None, metric=None, params=None, headers=None): """ Provides statistics on operations happening in an index. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -824,7 +824,7 @@ async def stats(self, index=None, metric=None, params=None, headers=None): async def segments(self, index=None, params=None, headers=None): """ Provides low-level information about segments in a Lucene index. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -861,7 +861,7 @@ async def validate_query( ): """ Allows a user to validate a potentially expensive query without executing it. - ``_ + ``_ :arg body: The query definition specified with the Query DSL :arg index: A comma-separated list of index names to restrict @@ -914,7 +914,7 @@ async def validate_query( async def clear_cache(self, index=None, params=None, headers=None): """ Clears all or specific caches for one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index name to limit the operation @@ -940,7 +940,7 @@ async def clear_cache(self, index=None, params=None, headers=None): async def recovery(self, index=None, params=None, headers=None): """ Returns information about ongoing index shard recoveries. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -963,7 +963,7 @@ async def recovery(self, index=None, params=None, headers=None): async def upgrade(self, index=None, params=None, headers=None): """ The _upgrade API is no longer useful and will be removed. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -988,7 +988,7 @@ async def upgrade(self, index=None, params=None, headers=None): async def get_upgrade(self, index=None, params=None, headers=None): """ The _upgrade API is no longer useful and will be removed. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1010,7 +1010,7 @@ async def flush_synced(self, index=None, params=None, headers=None): """ Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string for all indices @@ -1036,7 +1036,7 @@ async def flush_synced(self, index=None, params=None, headers=None): async def shard_stores(self, index=None, params=None, headers=None): """ Provides store information for shard copies of indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1067,7 +1067,7 @@ async def shard_stores(self, index=None, params=None, headers=None): async def forcemerge(self, index=None, params=None, headers=None): """ Performs the force merge operation on one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1096,7 +1096,7 @@ async def forcemerge(self, index=None, params=None, headers=None): async def shrink(self, index, target, body=None, params=None, headers=None): """ Allow to shrink an existing index into a new index with fewer primary shards. - ``_ + ``_ :arg index: The name of the source index to shrink :arg target: The name of the target index to shrink into @@ -1128,7 +1128,7 @@ async def split(self, index, target, body=None, params=None, headers=None): """ Allows you to split an existing index into a new index with more primary shards. - ``_ + ``_ :arg index: The name of the source index to split :arg target: The name of the target index to split into @@ -1166,7 +1166,7 @@ async def rollover( """ Updates an alias to point to a new index when the existing index is considered to be too large or too old. - ``_ + ``_ :arg alias: The name of the alias to rollover :arg body: The conditions that needs to be met for executing @@ -1206,7 +1206,7 @@ async def freeze(self, index, params=None, headers=None): """ Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only. - ``_ + ``_ :arg index: The name of the index to freeze :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -1241,7 +1241,7 @@ async def unfreeze(self, index, params=None, headers=None): """ Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. - ``_ + ``_ :arg index: The name of the index to unfreeze :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -1268,7 +1268,7 @@ async def unfreeze(self, index, params=None, headers=None): async def reload_search_analyzers(self, index, params=None, headers=None): """ Reloads an index's search analyzers and their resources. - ``_ + ``_ :arg index: A comma-separated list of index names to reload analyzers for @@ -1295,7 +1295,7 @@ async def reload_search_analyzers(self, index, params=None, headers=None): async def create_data_stream(self, name, body=None, params=None, headers=None): """ Creates or updates a data stream - ``_ + ``_ :arg name: The name of the data stream :arg body: The data stream definition @@ -1315,7 +1315,7 @@ async def create_data_stream(self, name, body=None, params=None, headers=None): async def delete_data_stream(self, name, params=None, headers=None): """ Deletes a data stream. - ``_ + ``_ :arg name: A comma-separated list of data streams to delete; use `*` to delete all data streams @@ -1331,7 +1331,7 @@ async def delete_data_stream(self, name, params=None, headers=None): async def delete_index_template(self, name, params=None, headers=None): """ Deletes an index template. - ``_ + ``_ :arg name: The name of the template :arg master_timeout: Specify timeout for connection to master @@ -1351,7 +1351,7 @@ async def delete_index_template(self, name, params=None, headers=None): async def exists_index_template(self, name, params=None, headers=None): """ Returns information about whether a particular index template exists. - ``_ + ``_ :arg name: The name of the template :arg flat_settings: Return settings in flat format (default: @@ -1372,7 +1372,7 @@ async def exists_index_template(self, name, params=None, headers=None): async def get_index_template(self, name=None, params=None, headers=None): """ Returns an index template. - ``_ + ``_ :arg name: The comma separated names of the index templates :arg flat_settings: Return settings in flat format (default: @@ -1390,7 +1390,7 @@ async def get_index_template(self, name=None, params=None, headers=None): async def put_index_template(self, name, body, params=None, headers=None): """ Creates or updates an index template. - ``_ + ``_ :arg name: The name of the template :arg body: The template definition @@ -1417,7 +1417,7 @@ async def simulate_index_template(self, name, body=None, params=None, headers=No """ Simulate matching the given index name against the index templates in the system - ``_ + ``_ :arg name: The name of the index (it must be a concrete index name) @@ -1445,7 +1445,7 @@ async def simulate_index_template(self, name, body=None, params=None, headers=No async def get_data_stream(self, name=None, params=None, headers=None): """ Returns data streams. - ``_ + ``_ :arg name: A comma-separated list of data streams to get; use `*` to get all data streams @@ -1458,7 +1458,7 @@ async def get_data_stream(self, name=None, params=None, headers=None): async def simulate_template(self, body=None, name=None, params=None, headers=None): """ Simulate resolving the given template name or body - ``_ + ``_ :arg body: New index template definition to be simulated, if no index template name is specified @@ -1535,7 +1535,7 @@ async def add_block(self, index, block, params=None, headers=None): async def data_streams_stats(self, name=None, params=None, headers=None): """ Provides statistics on operations happening in a data stream. - ``_ + ``_ :arg name: A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams diff --git a/elasticsearch/_async/client/ingest.py b/elasticsearch/_async/client/ingest.py index 058855bc1..58766f5e6 100644 --- a/elasticsearch/_async/client/ingest.py +++ b/elasticsearch/_async/client/ingest.py @@ -23,7 +23,7 @@ class IngestClient(NamespacedClient): async def get_pipeline(self, id=None, params=None, headers=None): """ Returns a pipeline. - ``_ + ``_ :arg id: Comma separated list of pipeline ids. Wildcards supported @@ -38,7 +38,7 @@ async def get_pipeline(self, id=None, params=None, headers=None): async def put_pipeline(self, id, body, params=None, headers=None): """ Creates or updates a pipeline. - ``_ + ``_ :arg id: Pipeline ID :arg body: The ingest definition @@ -62,7 +62,7 @@ async def put_pipeline(self, id, body, params=None, headers=None): async def delete_pipeline(self, id, params=None, headers=None): """ Deletes a pipeline. - ``_ + ``_ :arg id: Pipeline ID :arg master_timeout: Explicit operation timeout for connection @@ -83,7 +83,7 @@ async def delete_pipeline(self, id, params=None, headers=None): async def simulate(self, body, id=None, params=None, headers=None): """ Allows to simulate a pipeline with example documents. - ``_ + ``_ :arg body: The simulate definition :arg id: Pipeline ID @@ -105,7 +105,7 @@ async def simulate(self, body, id=None, params=None, headers=None): async def processor_grok(self, params=None, headers=None): """ Returns a list of the built-in patterns. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_ingest/processor/grok", params=params, headers=headers diff --git a/elasticsearch/_async/client/license.py b/elasticsearch/_async/client/license.py index 6754004f2..e6b48f66b 100644 --- a/elasticsearch/_async/client/license.py +++ b/elasticsearch/_async/client/license.py @@ -23,7 +23,7 @@ class LicenseClient(NamespacedClient): async def delete(self, params=None, headers=None): """ Deletes licensing information for the cluster - ``_ + ``_ """ return await self.transport.perform_request( "DELETE", "/_license", params=params, headers=headers @@ -33,7 +33,7 @@ async def delete(self, params=None, headers=None): async def get(self, params=None, headers=None): """ Retrieves licensing information for the cluster - ``_ + ``_ :arg accept_enterprise: If the active license is an enterprise license, return type as 'enterprise' (default: false) @@ -48,7 +48,7 @@ async def get(self, params=None, headers=None): async def get_basic_status(self, params=None, headers=None): """ Retrieves information about the status of the basic license. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_license/basic_status", params=params, headers=headers @@ -58,7 +58,7 @@ async def get_basic_status(self, params=None, headers=None): async def get_trial_status(self, params=None, headers=None): """ Retrieves information about the status of the trial license. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_license/trial_status", params=params, headers=headers @@ -68,7 +68,7 @@ async def get_trial_status(self, params=None, headers=None): async def post(self, body=None, params=None, headers=None): """ Updates the license for the cluster. - ``_ + ``_ :arg body: licenses to be installed :arg acknowledge: whether the user has acknowledged acknowledge @@ -82,7 +82,7 @@ async def post(self, body=None, params=None, headers=None): async def post_start_basic(self, params=None, headers=None): """ Starts an indefinite basic license. - ``_ + ``_ :arg acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -95,7 +95,7 @@ async def post_start_basic(self, params=None, headers=None): async def post_start_trial(self, params=None, headers=None): """ starts a limited time trial license. - ``_ + ``_ :arg acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/_async/client/migration.py b/elasticsearch/_async/client/migration.py index f4cc5effb..c55158d40 100644 --- a/elasticsearch/_async/client/migration.py +++ b/elasticsearch/_async/client/migration.py @@ -25,7 +25,7 @@ async def deprecations(self, index=None, params=None, headers=None): Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. - ``_ + ``_ :arg index: Index pattern """ diff --git a/elasticsearch/_async/client/ml.py b/elasticsearch/_async/client/ml.py index ba79bc0b1..406c91964 100644 --- a/elasticsearch/_async/client/ml.py +++ b/elasticsearch/_async/client/ml.py @@ -24,7 +24,7 @@ async def close_job(self, job_id, body=None, params=None, headers=None): """ Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. - ``_ + ``_ :arg job_id: The name of the job to close :arg body: The URL params optionally sent in the body @@ -50,7 +50,7 @@ async def close_job(self, job_id, body=None, params=None, headers=None): async def delete_calendar(self, calendar_id, params=None, headers=None): """ Deletes a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to delete """ @@ -72,7 +72,7 @@ async def delete_calendar_event( ): """ Deletes scheduled events from a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg event_id: The ID of the event to remove from the calendar @@ -92,7 +92,7 @@ async def delete_calendar_event( async def delete_calendar_job(self, calendar_id, job_id, params=None, headers=None): """ Deletes anomaly detection jobs from a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg job_id: The ID of the job to remove from the calendar @@ -112,7 +112,7 @@ async def delete_calendar_job(self, calendar_id, job_id, params=None, headers=No async def delete_datafeed(self, datafeed_id, params=None, headers=None): """ Deletes an existing datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to delete :arg force: True if the datafeed should be forcefully deleted @@ -135,7 +135,7 @@ async def delete_expired_data( ): """ Deletes expired and unused machine learning data. - ``_ + ``_ :arg body: deleting expired data parameters :arg job_id: The ID of the job(s) to perform expired data @@ -157,7 +157,7 @@ async def delete_expired_data( async def delete_filter(self, filter_id, params=None, headers=None): """ Deletes a filter. - ``_ + ``_ :arg filter_id: The ID of the filter to delete """ @@ -177,7 +177,7 @@ async def delete_forecast( ): """ Deletes forecasts from a machine learning job. - ``_ + ``_ :arg job_id: The ID of the job from which to delete forecasts :arg forecast_id: The ID of the forecast to delete, can be comma @@ -201,7 +201,7 @@ async def delete_forecast( async def delete_job(self, job_id, params=None, headers=None): """ Deletes an existing anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job to delete :arg force: True if the job should be forcefully deleted @@ -224,7 +224,7 @@ async def delete_model_snapshot( ): """ Deletes an existing model snapshot. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg snapshot_id: The ID of the snapshot to delete @@ -262,7 +262,7 @@ async def find_file_structure(self, body, params=None, headers=None): """ Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. - ``_ + ``_ :arg body: The contents of the file to be analyzed :arg charset: Optional parameter to specify the character set of @@ -313,7 +313,7 @@ async def find_file_structure(self, body, params=None, headers=None): async def flush_job(self, job_id, body=None, params=None, headers=None): """ Forces any buffered data to be processed by the job. - ``_ + ``_ :arg job_id: The name of the job to flush :arg body: Flush parameters @@ -343,7 +343,7 @@ async def flush_job(self, job_id, body=None, params=None, headers=None): async def forecast(self, job_id, params=None, headers=None): """ Predicts the future behavior of a time series by using its historical behavior. - ``_ + ``_ :arg job_id: The ID of the job to forecast for :arg duration: The duration of the forecast @@ -378,7 +378,7 @@ async def get_buckets( ): """ Retrieves anomaly detection job results for one or more buckets. - ``_ + ``_ :arg job_id: ID of the job to get bucket results from :arg body: Bucket selection details if not provided in URI @@ -415,7 +415,7 @@ async def get_buckets( async def get_calendar_events(self, calendar_id, params=None, headers=None): """ Retrieves information about the scheduled events in calendars. - ``_ + ``_ :arg calendar_id: The ID of the calendar containing the events :arg end: Get events before this time @@ -447,7 +447,7 @@ async def get_calendars( ): """ Retrieves configuration information for calendars. - ``_ + ``_ :arg body: The from and size parameters optionally sent in the body @@ -473,7 +473,7 @@ async def get_categories( ): """ Retrieves anomaly detection job results for one or more categories. - ``_ + ``_ :arg job_id: The name of the job :arg body: Category selection details if not provided in URI @@ -506,7 +506,7 @@ async def get_categories( async def get_datafeed_stats(self, datafeed_id=None, params=None, headers=None): """ Retrieves usage information for datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeeds stats to fetch :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -524,7 +524,7 @@ async def get_datafeed_stats(self, datafeed_id=None, params=None, headers=None): async def get_datafeeds(self, datafeed_id=None, params=None, headers=None): """ Retrieves configuration information for datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeeds to fetch :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -542,7 +542,7 @@ async def get_datafeeds(self, datafeed_id=None, params=None, headers=None): async def get_filters(self, filter_id=None, params=None, headers=None): """ Retrieves filters. - ``_ + ``_ :arg filter_id: The ID of the filter to fetch :arg from_: skips a number of filters @@ -572,7 +572,7 @@ async def get_filters(self, filter_id=None, params=None, headers=None): async def get_influencers(self, job_id, body=None, params=None, headers=None): """ Retrieves anomaly detection job results for one or more influencers. - ``_ + ``_ :arg job_id: Identifier for the anomaly detection job :arg body: Influencer selection criteria @@ -606,7 +606,7 @@ async def get_influencers(self, job_id, body=None, params=None, headers=None): async def get_job_stats(self, job_id=None, params=None, headers=None): """ Retrieves usage information for anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the jobs stats to fetch :arg allow_no_jobs: Whether to ignore if a wildcard expression @@ -624,7 +624,7 @@ async def get_job_stats(self, job_id=None, params=None, headers=None): async def get_jobs(self, job_id=None, params=None, headers=None): """ Retrieves configuration information for anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the jobs to fetch :arg allow_no_jobs: Whether to ignore if a wildcard expression @@ -644,7 +644,7 @@ async def get_model_snapshots( ): """ Retrieves information about model snapshots. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg body: Model snapshot selection criteria @@ -688,7 +688,7 @@ async def get_overall_buckets(self, job_id, body=None, params=None, headers=None """ Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. - ``_ + ``_ :arg job_id: The job IDs for which to calculate overall bucket results @@ -736,7 +736,7 @@ async def get_overall_buckets(self, job_id, body=None, params=None, headers=None async def get_records(self, job_id, body=None, params=None, headers=None): """ Retrieves anomaly records for an anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job :arg body: Record selection criteria @@ -769,7 +769,7 @@ async def get_records(self, job_id, body=None, params=None, headers=None): async def info(self, params=None, headers=None): """ Returns defaults and limits used by machine learning. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_ml/info", params=params, headers=headers @@ -779,7 +779,7 @@ async def info(self, params=None, headers=None): async def open_job(self, job_id, params=None, headers=None): """ Opens one or more anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the job to open """ @@ -797,7 +797,7 @@ async def open_job(self, job_id, params=None, headers=None): async def post_calendar_events(self, calendar_id, body, params=None, headers=None): """ Posts scheduled events in a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg body: A list of events @@ -818,7 +818,7 @@ async def post_calendar_events(self, calendar_id, body, params=None, headers=Non async def post_data(self, job_id, body, params=None, headers=None): """ Sends data to an anomaly detection job for analysis. - ``_ + ``_ :arg job_id: The name of the job receiving the data :arg body: The data to process @@ -844,7 +844,7 @@ async def post_data(self, job_id, body, params=None, headers=None): async def preview_datafeed(self, datafeed_id, params=None, headers=None): """ Previews a datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to preview """ @@ -864,7 +864,7 @@ async def preview_datafeed(self, datafeed_id, params=None, headers=None): async def put_calendar(self, calendar_id, body=None, params=None, headers=None): """ Instantiates a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to create :arg body: The calendar details @@ -886,7 +886,7 @@ async def put_calendar(self, calendar_id, body=None, params=None, headers=None): async def put_calendar_job(self, calendar_id, job_id, params=None, headers=None): """ Adds an anomaly detection job to a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg job_id: The ID of the job to add to the calendar @@ -908,7 +908,7 @@ async def put_calendar_job(self, calendar_id, job_id, params=None, headers=None) async def put_datafeed(self, datafeed_id, body, params=None, headers=None): """ Instantiates a datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to create :arg body: The datafeed config @@ -938,7 +938,7 @@ async def put_datafeed(self, datafeed_id, body, params=None, headers=None): async def put_filter(self, filter_id, body, params=None, headers=None): """ Instantiates a filter. - ``_ + ``_ :arg filter_id: The ID of the filter to create :arg body: The filter details @@ -959,7 +959,7 @@ async def put_filter(self, filter_id, body, params=None, headers=None): async def put_job(self, job_id, body, params=None, headers=None): """ Instantiates an anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job to create :arg body: The job @@ -982,7 +982,7 @@ async def revert_model_snapshot( ): """ Reverts to a specific snapshot. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg snapshot_id: The ID of the snapshot to revert to @@ -1014,7 +1014,7 @@ async def set_upgrade_mode(self, params=None, headers=None): """ Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. - ``_ + ``_ :arg enabled: Whether to enable upgrade_mode ML setting or not. Defaults to false. @@ -1029,7 +1029,7 @@ async def set_upgrade_mode(self, params=None, headers=None): async def start_datafeed(self, datafeed_id, body=None, params=None, headers=None): """ Starts one or more datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to start :arg body: The start datafeed parameters @@ -1056,7 +1056,7 @@ async def start_datafeed(self, datafeed_id, body=None, params=None, headers=None async def stop_datafeed(self, datafeed_id, params=None, headers=None): """ Stops one or more datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to stop :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -1084,7 +1084,7 @@ async def stop_datafeed(self, datafeed_id, params=None, headers=None): async def update_datafeed(self, datafeed_id, body, params=None, headers=None): """ Updates certain properties of a datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to update :arg body: The datafeed update settings @@ -1114,7 +1114,7 @@ async def update_datafeed(self, datafeed_id, body, params=None, headers=None): async def update_filter(self, filter_id, body, params=None, headers=None): """ Updates the description of a filter, adds items, or removes items. - ``_ + ``_ :arg filter_id: The ID of the filter to update :arg body: The filter update @@ -1135,7 +1135,7 @@ async def update_filter(self, filter_id, body, params=None, headers=None): async def update_job(self, job_id, body, params=None, headers=None): """ Updates certain properties of an anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job to create :arg body: The job update settings @@ -1158,7 +1158,7 @@ async def update_model_snapshot( ): """ Updates certain properties of a snapshot. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg snapshot_id: The ID of the snapshot to update @@ -1225,7 +1225,7 @@ async def validate_detector(self, body, params=None, headers=None): async def delete_data_frame_analytics(self, id, params=None, headers=None): """ Deletes an existing data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to delete :arg force: True if the job should be forcefully deleted @@ -1246,7 +1246,7 @@ async def delete_data_frame_analytics(self, id, params=None, headers=None): async def evaluate_data_frame(self, body, params=None, headers=None): """ Evaluates the data frame analytics for an annotated index. - ``_ + ``_ :arg body: The evaluation definition """ @@ -1265,7 +1265,7 @@ async def evaluate_data_frame(self, body, params=None, headers=None): async def get_data_frame_analytics(self, id=None, params=None, headers=None): """ Retrieves configuration information for data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1290,7 +1290,7 @@ async def get_data_frame_analytics(self, id=None, params=None, headers=None): async def get_data_frame_analytics_stats(self, id=None, params=None, headers=None): """ Retrieves usage information for data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics stats to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1315,7 +1315,7 @@ async def get_data_frame_analytics_stats(self, id=None, params=None, headers=Non async def put_data_frame_analytics(self, id, body, params=None, headers=None): """ Instantiates a data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to create :arg body: The data frame analytics configuration @@ -1338,7 +1338,7 @@ async def start_data_frame_analytics( ): """ Starts a data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to start :arg body: The start data frame analytics parameters @@ -1360,7 +1360,7 @@ async def start_data_frame_analytics( async def stop_data_frame_analytics(self, id, body=None, params=None, headers=None): """ Stops one or more data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics to stop :arg body: The stop data frame analytics parameters @@ -1388,7 +1388,7 @@ async def delete_trained_model(self, model_id, params=None, headers=None): """ Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. - ``_ + ``_ :arg model_id: The ID of the trained model to delete """ @@ -1408,7 +1408,7 @@ async def explain_data_frame_analytics( ): """ Explains a data frame analytics config. - ``_ + ``_ :arg body: The data frame analytics config to explain :arg id: The ID of the data frame analytics to explain @@ -1433,7 +1433,7 @@ async def explain_data_frame_analytics( async def get_trained_models(self, model_id=None, params=None, headers=None): """ Retrieves configuration information for a trained inference model. - ``_ + ``_ :arg model_id: The ID of the trained models to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1468,7 +1468,7 @@ async def get_trained_models(self, model_id=None, params=None, headers=None): async def get_trained_models_stats(self, model_id=None, params=None, headers=None): """ Retrieves usage information for trained inference models. - ``_ + ``_ :arg model_id: The ID of the trained models stats to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1493,7 +1493,7 @@ async def get_trained_models_stats(self, model_id=None, params=None, headers=Non async def put_trained_model(self, model_id, body, params=None, headers=None): """ Creates an inference trained model. - ``_ + ``_ :arg model_id: The ID of the trained models to store :arg body: The trained model configuration @@ -1514,7 +1514,7 @@ async def put_trained_model(self, model_id, body, params=None, headers=None): async def estimate_model_memory(self, body, params=None, headers=None): """ Estimates the model memory - ``_ + ``_ :arg body: The analysis config, plus cardinality estimates for fields it references @@ -1534,7 +1534,7 @@ async def estimate_model_memory(self, body, params=None, headers=None): async def update_data_frame_analytics(self, id, body, params=None, headers=None): """ Updates certain properties of a data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to update :arg body: The data frame analytics settings to update diff --git a/elasticsearch/_async/client/monitoring.py b/elasticsearch/_async/client/monitoring.py index 93c46f2c9..8a45117da 100644 --- a/elasticsearch/_async/client/monitoring.py +++ b/elasticsearch/_async/client/monitoring.py @@ -23,7 +23,7 @@ class MonitoringClient(NamespacedClient): async def bulk(self, body, doc_type=None, params=None, headers=None): """ Used by the monitoring features to send monitoring data. - ``_ + ``_ :arg body: The operation definition and data (action-data pairs), separated by newlines diff --git a/elasticsearch/_async/client/nodes.py b/elasticsearch/_async/client/nodes.py index d84217a8d..2a4a75410 100644 --- a/elasticsearch/_async/client/nodes.py +++ b/elasticsearch/_async/client/nodes.py @@ -25,7 +25,7 @@ async def reload_secure_settings( ): """ Reloads secure settings. - ``_ + ``_ :arg body: An object containing the password for the elasticsearch keystore @@ -46,7 +46,7 @@ async def reload_secure_settings( async def info(self, node_id=None, metric=None, params=None, headers=None): """ Returns information about nodes in the cluster. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -78,7 +78,7 @@ async def stats( ): """ Returns statistical information about nodes in the cluster. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -122,7 +122,7 @@ async def stats( async def hot_threads(self, node_id=None, params=None, headers=None): """ Returns information about hot threads on each node in the cluster. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -155,7 +155,7 @@ async def hot_threads(self, node_id=None, params=None, headers=None): async def usage(self, node_id=None, metric=None, params=None, headers=None): """ Returns low-level information about REST actions usage on nodes. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from diff --git a/elasticsearch/_async/client/remote.py b/elasticsearch/_async/client/remote.py index ae34add51..2ea5e8487 100644 --- a/elasticsearch/_async/client/remote.py +++ b/elasticsearch/_async/client/remote.py @@ -22,7 +22,7 @@ class RemoteClient(NamespacedClient): @query_params() async def info(self, params=None, headers=None): """ - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_remote/info", params=params, headers=headers diff --git a/elasticsearch/_async/client/rollup.py b/elasticsearch/_async/client/rollup.py index d5fb8fa03..3588f281b 100644 --- a/elasticsearch/_async/client/rollup.py +++ b/elasticsearch/_async/client/rollup.py @@ -23,7 +23,7 @@ class RollupClient(NamespacedClient): async def delete_job(self, id, params=None, headers=None): """ Deletes an existing rollup job. - ``_ + ``_ :arg id: The ID of the job to delete """ @@ -38,7 +38,7 @@ async def delete_job(self, id, params=None, headers=None): async def get_jobs(self, id=None, params=None, headers=None): """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :arg id: The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs @@ -52,7 +52,7 @@ async def get_rollup_caps(self, id=None, params=None, headers=None): """ Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - ``_ + ``_ :arg id: The ID of the index to check rollup capabilities on, or left blank for all jobs @@ -66,7 +66,7 @@ async def get_rollup_index_caps(self, index, params=None, headers=None): """ Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). - ``_ + ``_ :arg index: The rollup index or index pattern to obtain rollup capabilities from. @@ -82,7 +82,7 @@ async def get_rollup_index_caps(self, index, params=None, headers=None): async def put_job(self, id, body, params=None, headers=None): """ Creates a rollup job. - ``_ + ``_ :arg id: The ID of the job to create :arg body: The job configuration @@ -105,7 +105,7 @@ async def rollup_search( ): """ Enables searching rolled-up data using the standard query DSL. - ``_ + ``_ :arg index: The indices or index-pattern(s) (containing rollup or regular data) that should be searched @@ -132,7 +132,7 @@ async def rollup_search( async def start_job(self, id, params=None, headers=None): """ Starts an existing, stopped rollup job. - ``_ + ``_ :arg id: The ID of the job to start """ @@ -150,7 +150,7 @@ async def start_job(self, id, params=None, headers=None): async def stop_job(self, id, params=None, headers=None): """ Stops an existing, started rollup job. - ``_ + ``_ :arg id: The ID of the job to stop :arg timeout: Block for (at maximum) the specified duration diff --git a/elasticsearch/_async/client/searchable_snapshots.py b/elasticsearch/_async/client/searchable_snapshots.py index 5807b1cb8..fabcc3fd4 100644 --- a/elasticsearch/_async/client/searchable_snapshots.py +++ b/elasticsearch/_async/client/searchable_snapshots.py @@ -23,7 +23,7 @@ class SearchableSnapshotsClient(NamespacedClient): async def clear_cache(self, index=None, params=None, headers=None): """ Clear the cache of searchable snapshots. - ``_ + ``_ :arg index: A comma-separated list of index name to limit the operation @@ -47,7 +47,7 @@ async def clear_cache(self, index=None, params=None, headers=None): async def mount(self, repository, snapshot, body, params=None, headers=None): """ Mount a snapshot as a searchable index. - ``_ + ``_ :arg repository: The name of the repository containing the snapshot of the index to mount @@ -75,7 +75,7 @@ async def mount(self, repository, snapshot, body, params=None, headers=None): async def repository_stats(self, repository, params=None, headers=None): """ Retrieve usage statistics about a snapshot repository. - ``_ + ``_ :arg repository: The repository for which to get the stats for """ @@ -93,7 +93,7 @@ async def repository_stats(self, repository, params=None, headers=None): async def stats(self, index=None, params=None, headers=None): """ Retrieve various statistics about searchable snapshots. - ``_ + ``_ :arg index: A comma-separated list of index names """ diff --git a/elasticsearch/_async/client/security.py b/elasticsearch/_async/client/security.py index f805d5c04..ec921bfb9 100644 --- a/elasticsearch/_async/client/security.py +++ b/elasticsearch/_async/client/security.py @@ -24,7 +24,7 @@ async def authenticate(self, params=None, headers=None): """ Enables authentication as a user and retrieve information about the authenticated user. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_security/_authenticate", params=params, headers=headers @@ -34,7 +34,7 @@ async def authenticate(self, params=None, headers=None): async def change_password(self, body, username=None, params=None, headers=None): """ Changes the passwords of users in the native realm and built-in users. - ``_ + ``_ :arg body: the new password for the user :arg username: The username of the user to change the password @@ -60,7 +60,7 @@ async def clear_cached_realms(self, realms, params=None, headers=None): """ Evicts users from the user cache. Can completely clear the cache or evict specific users. - ``_ + ``_ :arg realms: Comma-separated list of realms to clear :arg usernames: Comma-separated list of usernames to clear from @@ -80,7 +80,7 @@ async def clear_cached_realms(self, realms, params=None, headers=None): async def clear_cached_roles(self, name, params=None, headers=None): """ Evicts roles from the native role cache. - ``_ + ``_ :arg name: Role name """ @@ -98,7 +98,7 @@ async def clear_cached_roles(self, name, params=None, headers=None): async def create_api_key(self, body, params=None, headers=None): """ Creates an API key for access without requiring basic authentication. - ``_ + ``_ :arg body: The api key request to create an API key :arg refresh: If `true` (the default) then refresh the affected @@ -117,7 +117,7 @@ async def create_api_key(self, body, params=None, headers=None): async def delete_privileges(self, application, name, params=None, headers=None): """ Removes application privileges. - ``_ + ``_ :arg application: Application name :arg name: Privilege name @@ -141,7 +141,7 @@ async def delete_privileges(self, application, name, params=None, headers=None): async def delete_role(self, name, params=None, headers=None): """ Removes roles in the native realm. - ``_ + ``_ :arg name: Role name :arg refresh: If `true` (the default) then refresh the affected @@ -163,7 +163,7 @@ async def delete_role(self, name, params=None, headers=None): async def delete_role_mapping(self, name, params=None, headers=None): """ Removes role mappings. - ``_ + ``_ :arg name: Role-mapping name :arg refresh: If `true` (the default) then refresh the affected @@ -185,7 +185,7 @@ async def delete_role_mapping(self, name, params=None, headers=None): async def delete_user(self, username, params=None, headers=None): """ Deletes users from the native realm. - ``_ + ``_ :arg username: username :arg refresh: If `true` (the default) then refresh the affected @@ -207,7 +207,7 @@ async def delete_user(self, username, params=None, headers=None): async def disable_user(self, username, params=None, headers=None): """ Disables users in the native realm. - ``_ + ``_ :arg username: The username of the user to disable :arg refresh: If `true` (the default) then refresh the affected @@ -229,7 +229,7 @@ async def disable_user(self, username, params=None, headers=None): async def enable_user(self, username, params=None, headers=None): """ Enables users in the native realm. - ``_ + ``_ :arg username: The username of the user to enable :arg refresh: If `true` (the default) then refresh the affected @@ -251,7 +251,7 @@ async def enable_user(self, username, params=None, headers=None): async def get_api_key(self, params=None, headers=None): """ Retrieves information for one or more API keys. - ``_ + ``_ :arg id: API key id of the API key to be retrieved :arg name: API key name of the API key to be retrieved @@ -272,7 +272,7 @@ async def get_privileges( ): """ Retrieves application privileges. - ``_ + ``_ :arg application: Application name :arg name: Privilege name @@ -288,7 +288,7 @@ async def get_privileges( async def get_role(self, name=None, params=None, headers=None): """ Retrieves roles in the native realm. - ``_ + ``_ :arg name: Role name """ @@ -300,7 +300,7 @@ async def get_role(self, name=None, params=None, headers=None): async def get_role_mapping(self, name=None, params=None, headers=None): """ Retrieves role mappings. - ``_ + ``_ :arg name: Role-Mapping name """ @@ -315,7 +315,7 @@ async def get_role_mapping(self, name=None, params=None, headers=None): async def get_token(self, body, params=None, headers=None): """ Creates a bearer token for access without requiring basic authentication. - ``_ + ``_ :arg body: The token request to get """ @@ -330,7 +330,7 @@ async def get_token(self, body, params=None, headers=None): async def get_user(self, username=None, params=None, headers=None): """ Retrieves information about users in the native realm and built-in users. - ``_ + ``_ :arg username: A comma-separated list of usernames """ @@ -345,7 +345,7 @@ async def get_user(self, username=None, params=None, headers=None): async def get_user_privileges(self, params=None, headers=None): """ Retrieves application privileges. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_security/user/_privileges", params=params, headers=headers @@ -355,7 +355,7 @@ async def get_user_privileges(self, params=None, headers=None): async def has_privileges(self, body, user=None, params=None, headers=None): """ Determines whether the specified user has a specified list of privileges. - ``_ + ``_ :arg body: The privileges to test :arg user: Username @@ -375,7 +375,7 @@ async def has_privileges(self, body, user=None, params=None, headers=None): async def invalidate_api_key(self, body, params=None, headers=None): """ Invalidates one or more API keys. - ``_ + ``_ :arg body: The api key request to invalidate API key(s) """ @@ -390,7 +390,7 @@ async def invalidate_api_key(self, body, params=None, headers=None): async def invalidate_token(self, body, params=None, headers=None): """ Invalidates one or more access tokens or refresh tokens. - ``_ + ``_ :arg body: The token to invalidate """ @@ -409,7 +409,7 @@ async def invalidate_token(self, body, params=None, headers=None): async def put_privileges(self, body, params=None, headers=None): """ Adds or updates application privileges. - ``_ + ``_ :arg body: The privilege(s) to add :arg refresh: If `true` (the default) then refresh the affected @@ -428,7 +428,7 @@ async def put_privileges(self, body, params=None, headers=None): async def put_role(self, name, body, params=None, headers=None): """ Adds and updates roles in the native realm. - ``_ + ``_ :arg name: Role name :arg body: The role to add @@ -453,7 +453,7 @@ async def put_role(self, name, body, params=None, headers=None): async def put_role_mapping(self, name, body, params=None, headers=None): """ Creates and updates role mappings. - ``_ + ``_ :arg name: Role-mapping name :arg body: The role mapping to add @@ -479,7 +479,7 @@ async def put_user(self, username, body, params=None, headers=None): """ Adds and updates users in the native realm. These users are commonly referred to as native users. - ``_ + ``_ :arg username: The username of the User :arg body: The user to add @@ -505,7 +505,7 @@ async def get_builtin_privileges(self, params=None, headers=None): """ Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_security/privilege/_builtin", params=params, headers=headers @@ -515,7 +515,7 @@ async def get_builtin_privileges(self, params=None, headers=None): async def clear_cached_privileges(self, application, params=None, headers=None): """ Evicts application privileges from the native application privileges cache. - ``_ + ``_ :arg application: A comma-separated list of application names """ diff --git a/elasticsearch/_async/client/slm.py b/elasticsearch/_async/client/slm.py index fb67a85b5..d05483dfd 100644 --- a/elasticsearch/_async/client/slm.py +++ b/elasticsearch/_async/client/slm.py @@ -23,7 +23,7 @@ class SlmClient(NamespacedClient): async def delete_lifecycle(self, policy_id, params=None, headers=None): """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :arg policy_id: The id of the snapshot lifecycle policy to remove @@ -43,7 +43,7 @@ async def execute_lifecycle(self, policy_id, params=None, headers=None): """ Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - ``_ + ``_ :arg policy_id: The id of the snapshot lifecycle policy to be executed @@ -63,7 +63,7 @@ async def execute_retention(self, params=None, headers=None): """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ return await self.transport.perform_request( "POST", "/_slm/_execute_retention", params=params, headers=headers @@ -74,7 +74,7 @@ async def get_lifecycle(self, policy_id=None, params=None, headers=None): """ Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - ``_ + ``_ :arg policy_id: Comma-separated list of snapshot lifecycle policies to retrieve @@ -91,7 +91,7 @@ async def get_stats(self, params=None, headers=None): """ Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_slm/stats", params=params, headers=headers @@ -101,7 +101,7 @@ async def get_stats(self, params=None, headers=None): async def put_lifecycle(self, policy_id, body=None, params=None, headers=None): """ Creates or updates a snapshot lifecycle policy. - ``_ + ``_ :arg policy_id: The id of the snapshot lifecycle policy :arg body: The snapshot lifecycle policy definition to register @@ -121,7 +121,7 @@ async def put_lifecycle(self, policy_id, body=None, params=None, headers=None): async def get_status(self, params=None, headers=None): """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_slm/status", params=params, headers=headers @@ -131,7 +131,7 @@ async def get_status(self, params=None, headers=None): async def start(self, params=None, headers=None): """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ return await self.transport.perform_request( "POST", "/_slm/start", params=params, headers=headers @@ -141,7 +141,7 @@ async def start(self, params=None, headers=None): async def stop(self, params=None, headers=None): """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ return await self.transport.perform_request( "POST", "/_slm/stop", params=params, headers=headers diff --git a/elasticsearch/_async/client/snapshot.py b/elasticsearch/_async/client/snapshot.py index e6b8fb509..160a7b279 100644 --- a/elasticsearch/_async/client/snapshot.py +++ b/elasticsearch/_async/client/snapshot.py @@ -23,7 +23,7 @@ class SnapshotClient(NamespacedClient): async def create(self, repository, snapshot, body=None, params=None, headers=None): """ Creates a snapshot in a repository. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A snapshot name @@ -49,7 +49,7 @@ async def create(self, repository, snapshot, body=None, params=None, headers=Non async def delete(self, repository, snapshot, params=None, headers=None): """ Deletes a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A snapshot name @@ -71,7 +71,7 @@ async def delete(self, repository, snapshot, params=None, headers=None): async def get(self, repository, snapshot, params=None, headers=None): """ Returns information about a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A comma-separated list of snapshot names @@ -98,7 +98,7 @@ async def get(self, repository, snapshot, params=None, headers=None): async def delete_repository(self, repository, params=None, headers=None): """ Deletes a repository. - ``_ + ``_ :arg repository: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -120,7 +120,7 @@ async def delete_repository(self, repository, params=None, headers=None): async def get_repository(self, repository=None, params=None, headers=None): """ Returns information about a repository. - ``_ + ``_ :arg repository: A comma-separated list of repository names :arg local: Return local information, do not retrieve the state @@ -136,7 +136,7 @@ async def get_repository(self, repository=None, params=None, headers=None): async def create_repository(self, repository, body, params=None, headers=None): """ Creates a repository. - ``_ + ``_ :arg repository: A repository name :arg body: The repository definition @@ -161,7 +161,7 @@ async def create_repository(self, repository, body, params=None, headers=None): async def restore(self, repository, snapshot, body=None, params=None, headers=None): """ Restores a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A snapshot name @@ -187,7 +187,7 @@ async def restore(self, repository, snapshot, body=None, params=None, headers=No async def status(self, repository=None, snapshot=None, params=None, headers=None): """ Returns information about the status of a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A comma-separated list of snapshot names @@ -208,7 +208,7 @@ async def status(self, repository=None, snapshot=None, params=None, headers=None async def verify_repository(self, repository, params=None, headers=None): """ Verifies a repository. - ``_ + ``_ :arg repository: A repository name :arg master_timeout: Explicit operation timeout for connection @@ -229,7 +229,7 @@ async def verify_repository(self, repository, params=None, headers=None): async def cleanup_repository(self, repository, params=None, headers=None): """ Removes stale data from repository. - ``_ + ``_ :arg repository: A repository name :arg master_timeout: Explicit operation timeout for connection diff --git a/elasticsearch/_async/client/sql.py b/elasticsearch/_async/client/sql.py index f9e34e0ae..e21fc8cf2 100644 --- a/elasticsearch/_async/client/sql.py +++ b/elasticsearch/_async/client/sql.py @@ -23,7 +23,7 @@ class SqlClient(NamespacedClient): async def clear_cursor(self, body, params=None, headers=None): """ Clears the SQL cursor - ``_ + ``_ :arg body: Specify the cursor value in the `cursor` element to clean the cursor. @@ -39,7 +39,7 @@ async def clear_cursor(self, body, params=None, headers=None): async def query(self, body, params=None, headers=None): """ Executes a SQL request - ``_ + ``_ :arg body: Use the `query` element to start a query. Use the `cursor` element to continue a query. @@ -57,7 +57,7 @@ async def query(self, body, params=None, headers=None): async def translate(self, body, params=None, headers=None): """ Translates SQL into Elasticsearch queries - ``_ + ``_ :arg body: Specify the query in the `query` element. """ diff --git a/elasticsearch/_async/client/ssl.py b/elasticsearch/_async/client/ssl.py index 1cf90f6ad..697305547 100644 --- a/elasticsearch/_async/client/ssl.py +++ b/elasticsearch/_async/client/ssl.py @@ -24,7 +24,7 @@ async def certificates(self, params=None, headers=None): """ Retrieves information about the X.509 certificates used to encrypt communications in the cluster. - ``_ + ``_ """ return await self.transport.perform_request( "GET", "/_ssl/certificates", params=params, headers=headers diff --git a/elasticsearch/_async/client/tasks.py b/elasticsearch/_async/client/tasks.py index 2a2b6ed0a..970817122 100644 --- a/elasticsearch/_async/client/tasks.py +++ b/elasticsearch/_async/client/tasks.py @@ -32,7 +32,7 @@ class TasksClient(NamespacedClient): async def list(self, params=None, headers=None): """ Returns a list of tasks. - ``_ + ``_ :arg actions: A comma-separated list of actions that should be returned. Leave empty to return all. @@ -56,7 +56,7 @@ async def list(self, params=None, headers=None): async def cancel(self, task_id=None, params=None, headers=None): """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :arg task_id: Cancel the task with specified task id (node_id:task_number) @@ -82,7 +82,7 @@ async def cancel(self, task_id=None, params=None, headers=None): async def get(self, task_id=None, params=None, headers=None): """ Returns information about a task. - ``_ + ``_ :arg task_id: Return the task with specified id (node_id:task_number) diff --git a/elasticsearch/_async/client/transform.py b/elasticsearch/_async/client/transform.py index 9734d7bab..43755b5af 100644 --- a/elasticsearch/_async/client/transform.py +++ b/elasticsearch/_async/client/transform.py @@ -23,7 +23,7 @@ class TransformClient(NamespacedClient): async def delete_transform(self, transform_id, params=None, headers=None): """ Deletes an existing transform. - ``_ + ``_ :arg transform_id: The id of the transform to delete :arg force: When `true`, the transform is deleted regardless of @@ -46,7 +46,7 @@ async def delete_transform(self, transform_id, params=None, headers=None): async def get_transform(self, transform_id=None, params=None, headers=None): """ Retrieves configuration information for transforms. - ``_ + ``_ :arg transform_id: The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all @@ -73,7 +73,7 @@ async def get_transform(self, transform_id=None, params=None, headers=None): async def get_transform_stats(self, transform_id, params=None, headers=None): """ Retrieves usage information for transforms. - ``_ + ``_ :arg transform_id: The id of the transform for which to get stats. '_all' or '*' implies all transforms @@ -104,7 +104,7 @@ async def get_transform_stats(self, transform_id, params=None, headers=None): async def preview_transform(self, body, params=None, headers=None): """ Previews a transform. - ``_ + ``_ :arg body: The definition for the transform to preview """ @@ -119,7 +119,7 @@ async def preview_transform(self, body, params=None, headers=None): async def put_transform(self, transform_id, body, params=None, headers=None): """ Instantiates a transform. - ``_ + ``_ :arg transform_id: The id of the new transform. :arg body: The transform definition @@ -142,7 +142,7 @@ async def put_transform(self, transform_id, body, params=None, headers=None): async def start_transform(self, transform_id, params=None, headers=None): """ Starts one or more transforms. - ``_ + ``_ :arg transform_id: The id of the transform to start :arg timeout: Controls the time to wait for the transform to @@ -170,7 +170,7 @@ async def start_transform(self, transform_id, params=None, headers=None): async def stop_transform(self, transform_id, params=None, headers=None): """ Stops one or more transforms. - ``_ + ``_ :arg transform_id: The id of the transform to stop :arg allow_no_match: Whether to ignore if a wildcard expression @@ -201,7 +201,7 @@ async def stop_transform(self, transform_id, params=None, headers=None): async def update_transform(self, transform_id, body, params=None, headers=None): """ Updates certain properties of a transform. - ``_ + ``_ :arg transform_id: The id of the transform. :arg body: The update transform definition diff --git a/elasticsearch/_async/client/watcher.py b/elasticsearch/_async/client/watcher.py index 5c03fd874..fc9556c1a 100644 --- a/elasticsearch/_async/client/watcher.py +++ b/elasticsearch/_async/client/watcher.py @@ -23,7 +23,7 @@ class WatcherClient(NamespacedClient): async def ack_watch(self, watch_id, action_id=None, params=None, headers=None): """ Acknowledges a watch, manually throttling the execution of the watch's actions. - ``_ + ``_ :arg watch_id: Watch ID :arg action_id: A comma-separated list of the action ids to be @@ -43,7 +43,7 @@ async def ack_watch(self, watch_id, action_id=None, params=None, headers=None): async def activate_watch(self, watch_id, params=None, headers=None): """ Activates a currently inactive watch. - ``_ + ``_ :arg watch_id: Watch ID """ @@ -61,7 +61,7 @@ async def activate_watch(self, watch_id, params=None, headers=None): async def deactivate_watch(self, watch_id, params=None, headers=None): """ Deactivates a currently active watch. - ``_ + ``_ :arg watch_id: Watch ID """ @@ -79,7 +79,7 @@ async def deactivate_watch(self, watch_id, params=None, headers=None): async def delete_watch(self, id, params=None, headers=None): """ Removes a watch from Watcher. - ``_ + ``_ :arg id: Watch ID """ @@ -97,7 +97,7 @@ async def delete_watch(self, id, params=None, headers=None): async def execute_watch(self, body=None, id=None, params=None, headers=None): """ Forces the execution of a stored watch. - ``_ + ``_ :arg body: Execution control :arg id: Watch ID @@ -116,7 +116,7 @@ async def execute_watch(self, body=None, id=None, params=None, headers=None): async def get_watch(self, id, params=None, headers=None): """ Retrieves a watch by its ID. - ``_ + ``_ :arg id: Watch ID """ @@ -131,7 +131,7 @@ async def get_watch(self, id, params=None, headers=None): async def put_watch(self, id, body=None, params=None, headers=None): """ Creates a new watch, or updates an existing one. - ``_ + ``_ :arg id: Watch ID :arg body: The watch @@ -157,7 +157,7 @@ async def put_watch(self, id, body=None, params=None, headers=None): async def start(self, params=None, headers=None): """ Starts Watcher if it is not already running. - ``_ + ``_ """ return await self.transport.perform_request( "POST", "/_watcher/_start", params=params, headers=headers @@ -167,7 +167,7 @@ async def start(self, params=None, headers=None): async def stats(self, metric=None, params=None, headers=None): """ Retrieves the current Watcher metrics. - ``_ + ``_ :arg metric: Controls what additional stat metrics should be include in the response Valid choices: _all, queued_watches, @@ -186,7 +186,7 @@ async def stats(self, metric=None, params=None, headers=None): async def stop(self, params=None, headers=None): """ Stops Watcher if it is running. - ``_ + ``_ """ return await self.transport.perform_request( "POST", "/_watcher/_stop", params=params, headers=headers diff --git a/elasticsearch/_async/client/xpack.py b/elasticsearch/_async/client/xpack.py index 9cb68bd69..676809a4e 100644 --- a/elasticsearch/_async/client/xpack.py +++ b/elasticsearch/_async/client/xpack.py @@ -27,7 +27,7 @@ def __getattr__(self, attr_name): async def info(self, params=None, headers=None): """ Retrieves information about the installed X-Pack features. - ``_ + ``_ :arg accept_enterprise: If an enterprise license is installed, return the type and mode as 'enterprise' (default: false) @@ -42,7 +42,7 @@ async def info(self, params=None, headers=None): async def usage(self, params=None, headers=None): """ Retrieves usage information about the installed X-Pack features. - ``_ + ``_ :arg master_timeout: Specify timeout for watch write operation """ diff --git a/elasticsearch/client/__init__.py b/elasticsearch/client/__init__.py index 070b55316..188817697 100644 --- a/elasticsearch/client/__init__.py +++ b/elasticsearch/client/__init__.py @@ -266,7 +266,7 @@ def close(self): def ping(self, params=None, headers=None): """ Returns whether the cluster is running. - ``_ + ``_ """ try: return self.transport.perform_request( @@ -279,7 +279,7 @@ def ping(self, params=None, headers=None): def info(self, params=None, headers=None): """ Returns basic information about the cluster. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/", params=params, headers=headers @@ -298,7 +298,7 @@ def create(self, index, id, body, doc_type=None, params=None, headers=None): """ Creates a new document in the index. Returns a 409 response when a document with a same ID already exists in the index. - ``_ + ``_ :arg index: The name of the index :arg id: Document ID @@ -349,7 +349,7 @@ def create(self, index, id, body, doc_type=None, params=None, headers=None): def index(self, index, body, doc_type=None, id=None, params=None, headers=None): """ Creates or updates a document in an index. - ``_ + ``_ :arg index: The name of the index :arg body: The document @@ -409,7 +409,7 @@ def index(self, index, body, doc_type=None, id=None, params=None, headers=None): def bulk(self, body, index=None, doc_type=None, params=None, headers=None): """ Allows to perform multiple index/update/delete operations in a single request. - ``_ + ``_ :arg body: The operation definition and data (action-data pairs), separated by newlines @@ -453,7 +453,7 @@ def bulk(self, body, index=None, doc_type=None, params=None, headers=None): def clear_scroll(self, body=None, scroll_id=None, params=None, headers=None): """ Explicitly clears the search context for a scroll. - ``_ + ``_ :arg body: A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter @@ -489,7 +489,7 @@ def clear_scroll(self, body=None, scroll_id=None, params=None, headers=None): def count(self, body=None, index=None, doc_type=None, params=None, headers=None): """ Returns number of documents matching a query. - ``_ + ``_ :arg body: A query to restrict the results specified with the Query DSL (optional) @@ -546,7 +546,7 @@ def count(self, body=None, index=None, doc_type=None, params=None, headers=None) def delete(self, index, id, doc_type=None, params=None, headers=None): """ Removes a document from the index. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -621,7 +621,7 @@ def delete(self, index, id, doc_type=None, params=None, headers=None): def delete_by_query(self, index, body, doc_type=None, params=None, headers=None): """ Deletes documents matching the provided query. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -717,7 +717,7 @@ def delete_by_query_rethrottle(self, task_id, params=None, headers=None): """ Changes the number of requests per second for a particular Delete By Query operation. - ``_ + ``_ :arg task_id: The task id to rethrottle :arg requests_per_second: The throttle to set on this request in @@ -737,7 +737,7 @@ def delete_by_query_rethrottle(self, task_id, params=None, headers=None): def delete_script(self, id, params=None, headers=None): """ Deletes a script. - ``_ + ``_ :arg id: Script ID :arg master_timeout: Specify timeout for connection to master @@ -765,7 +765,7 @@ def delete_script(self, id, params=None, headers=None): def exists(self, index, id, doc_type=None, params=None, headers=None): """ Returns information about whether a document exists in an index. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -815,7 +815,7 @@ def exists(self, index, id, doc_type=None, params=None, headers=None): def exists_source(self, index, id, doc_type=None, params=None, headers=None): """ Returns information about whether a document source exists in an index. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -868,7 +868,7 @@ def exists_source(self, index, id, doc_type=None, params=None, headers=None): def explain(self, index, id, body=None, doc_type=None, params=None, headers=None): """ Returns information about why a specific matches (or doesn't match) a query. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -920,7 +920,7 @@ def field_caps(self, body=None, index=None, params=None, headers=None): """ Returns the information about the capabilities of fields among multiple indices. - ``_ + ``_ :arg body: An index filter specified with the Query DSL :arg index: A comma-separated list of index names; use `_all` or @@ -960,7 +960,7 @@ def field_caps(self, body=None, index=None, params=None, headers=None): def get(self, index, id, doc_type=None, params=None, headers=None): """ Returns a document. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -1000,7 +1000,7 @@ def get(self, index, id, doc_type=None, params=None, headers=None): def get_script(self, id, params=None, headers=None): """ Returns a script. - ``_ + ``_ :arg id: Script ID :arg master_timeout: Specify timeout for connection to master @@ -1026,7 +1026,7 @@ def get_script(self, id, params=None, headers=None): def get_source(self, index, id, doc_type=None, params=None, headers=None): """ Returns the source of a document. - ``_ + ``_ :arg index: The name of the index :arg id: The document ID @@ -1075,7 +1075,7 @@ def get_source(self, index, id, doc_type=None, params=None, headers=None): def mget(self, body, index=None, doc_type=None, params=None, headers=None): """ Allows to get multiple documents in one request. - ``_ + ``_ :arg body: Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is @@ -1121,7 +1121,7 @@ def mget(self, body, index=None, doc_type=None, params=None, headers=None): def msearch(self, body, index=None, doc_type=None, params=None, headers=None): """ Allows to execute several search operations in one request. - ``_ + ``_ :arg body: The request definitions (metadata-search request definition pairs), separated by newlines @@ -1177,7 +1177,7 @@ def msearch_template( ): """ Allows to execute several search template operations in one request. - ``_ + ``_ :arg body: The request definitions (metadata-search request definition pairs), separated by newlines @@ -1229,7 +1229,7 @@ def mtermvectors( ): """ Returns multiple termvectors in one request. - ``_ + ``_ :arg body: Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of @@ -1281,7 +1281,7 @@ def mtermvectors( def put_script(self, id, body, context=None, params=None, headers=None): """ Creates or updates a script. - ``_ + ``_ :arg id: Script ID :arg body: The document @@ -1308,7 +1308,7 @@ def rank_eval(self, body, index=None, params=None, headers=None): """ Allows to evaluate the quality of ranked search results over a set of typical search queries - ``_ + ``_ :arg body: The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. @@ -1351,7 +1351,7 @@ def reindex(self, body, params=None, headers=None): Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster. - ``_ + ``_ :arg body: The search definition using the Query DSL and the prototype for the index request. @@ -1386,7 +1386,7 @@ def reindex(self, body, params=None, headers=None): def reindex_rethrottle(self, task_id, params=None, headers=None): """ Changes the number of requests per second for a particular Reindex operation. - ``_ + ``_ :arg task_id: The task id to rethrottle :arg requests_per_second: The throttle to set on this request in @@ -1406,7 +1406,7 @@ def reindex_rethrottle(self, task_id, params=None, headers=None): def render_search_template(self, body=None, id=None, params=None, headers=None): """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :arg body: The search definition template and its params :arg id: The id of the stored search template @@ -1439,7 +1439,7 @@ def scripts_painless_execute(self, body=None, params=None, headers=None): def scroll(self, body=None, scroll_id=None, params=None, headers=None): """ Allows to retrieve a large numbers of results from a single search request. - ``_ + ``_ :arg body: The scroll ID if not passed by URL or query parameter. @@ -1507,7 +1507,7 @@ def scroll(self, body=None, scroll_id=None, params=None, headers=None): def search(self, body=None, index=None, doc_type=None, params=None, headers=None): """ Returns results matching a query. - ``_ + ``_ :arg body: The search definition using the Query DSL :arg index: A comma-separated list of index names to search; use @@ -1629,7 +1629,7 @@ def search_shards(self, index=None, params=None, headers=None): """ Returns information about the indices and shards that a search request would be executed against. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -1671,7 +1671,7 @@ def search_template( ): """ Allows to use the Mustache language to pre-render a search definition. - ``_ + ``_ :arg body: The search definition template and its params :arg index: A comma-separated list of index names to search; use @@ -1737,7 +1737,7 @@ def termvectors( """ Returns information and statistics about terms in the fields of a particular document. - ``_ + ``_ :arg index: The index in which the document resides. :arg body: Define parameters and or supply a document to get @@ -1794,7 +1794,7 @@ def termvectors( def update(self, index, id, body, doc_type=None, params=None, headers=None): """ Updates a document with a script or partial document. - ``_ + ``_ :arg index: The name of the index :arg id: Document ID @@ -1884,7 +1884,7 @@ def update_by_query( """ Performs an update on every document in the index without changing the source, for example to pick up a mapping change. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices @@ -1983,7 +1983,7 @@ def update_by_query_rethrottle(self, task_id, params=None, headers=None): """ Changes the number of requests per second for a particular Update By Query operation. - ``_ + ``_ :arg task_id: The task id to rethrottle :arg requests_per_second: The throttle to set on this request in @@ -2013,7 +2013,7 @@ def get_script_context(self, params=None, headers=None): def get_script_languages(self, params=None, headers=None): """ Returns available script types, languages and contexts - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_script_language", params=params, headers=headers diff --git a/elasticsearch/client/async_search.py b/elasticsearch/client/async_search.py index 30ba8e8f1..a09772995 100644 --- a/elasticsearch/client/async_search.py +++ b/elasticsearch/client/async_search.py @@ -24,7 +24,7 @@ def delete(self, id, params=None, headers=None): """ Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :arg id: The async search ID """ @@ -40,7 +40,7 @@ def get(self, id, params=None, headers=None): """ Retrieves the results of a previously submitted async search request given its ID. - ``_ + ``_ :arg id: The async search ID :arg keep_alive: Specify the time interval in which the results @@ -103,7 +103,7 @@ def get(self, id, params=None, headers=None): def submit(self, body=None, index=None, params=None, headers=None): """ Executes a search request asynchronously. - ``_ + ``_ :arg body: The search definition using the Query DSL :arg index: A comma-separated list of index names to search; use diff --git a/elasticsearch/client/autoscaling.py b/elasticsearch/client/autoscaling.py index 751754ffa..838b1d440 100644 --- a/elasticsearch/client/autoscaling.py +++ b/elasticsearch/client/autoscaling.py @@ -24,7 +24,7 @@ def get_autoscaling_decision(self, params=None, headers=None): """ Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_autoscaling/decision", params=params, headers=headers @@ -34,7 +34,7 @@ def get_autoscaling_decision(self, params=None, headers=None): def delete_autoscaling_policy(self, name, params=None, headers=None): """ Deletes an autoscaling policy. - ``_ + ``_ :arg name: the name of the autoscaling policy """ @@ -52,7 +52,7 @@ def delete_autoscaling_policy(self, name, params=None, headers=None): def get_autoscaling_policy(self, name, params=None, headers=None): """ Retrieves an autoscaling policy. - ``_ + ``_ :arg name: the name of the autoscaling policy """ @@ -70,7 +70,7 @@ def get_autoscaling_policy(self, name, params=None, headers=None): def put_autoscaling_policy(self, name, body, params=None, headers=None): """ Creates a new autoscaling policy. - ``_ + ``_ :arg name: the name of the autoscaling policy :arg body: the specification of the autoscaling policy diff --git a/elasticsearch/client/cat.py b/elasticsearch/client/cat.py index 5c3a313a2..912c0f66f 100644 --- a/elasticsearch/client/cat.py +++ b/elasticsearch/client/cat.py @@ -24,7 +24,7 @@ def aliases(self, name=None, params=None, headers=None): """ Shows information about currently configured aliases to indices including filter and routing infos. - ``_ + ``_ :arg name: A comma-separated list of alias names to return :arg expand_wildcards: Whether to expand wildcard expression to @@ -49,7 +49,7 @@ def allocation(self, node_id=None, params=None, headers=None): """ Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information @@ -79,7 +79,7 @@ def count(self, index=None, params=None, headers=None): """ Provides quick access to the document count of the entire cluster, or individual indices. - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -99,7 +99,7 @@ def count(self, index=None, params=None, headers=None): def health(self, params=None, headers=None): """ Returns a concise representation of the cluster health. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -120,7 +120,7 @@ def health(self, params=None, headers=None): def help(self, params=None, headers=None): """ Returns help for the Cat APIs. - ``_ + ``_ :arg help: Return help information :arg s: Comma-separated list of column names or column aliases @@ -149,7 +149,7 @@ def indices(self, index=None, params=None, headers=None): """ Returns information about indices: number of primaries and replicas, document counts, disk size, ... - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -187,7 +187,7 @@ def indices(self, index=None, params=None, headers=None): def master(self, params=None, headers=None): """ Returns information about the master node. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -220,7 +220,7 @@ def master(self, params=None, headers=None): def nodes(self, params=None, headers=None): """ Returns basic statistics about performance of cluster nodes. - ``_ + ``_ :arg bytes: The unit in which to display byte values Valid choices: b, k, kb, m, mb, g, gb, t, tb, p, pb @@ -250,7 +250,7 @@ def nodes(self, params=None, headers=None): def recovery(self, index=None, params=None, headers=None): """ Returns information about index shard recoveries, both on-going completed. - ``_ + ``_ :arg index: Comma-separated list or wildcard expression of index names to limit the returned information @@ -280,7 +280,7 @@ def recovery(self, index=None, params=None, headers=None): def shards(self, index=None, params=None, headers=None): """ Provides a detailed view of shard allocation on nodes. - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -308,7 +308,7 @@ def shards(self, index=None, params=None, headers=None): def segments(self, index=None, params=None, headers=None): """ Provides low-level information about the segments in the shards of an index. - ``_ + ``_ :arg index: A comma-separated list of index names to limit the returned information @@ -330,7 +330,7 @@ def segments(self, index=None, params=None, headers=None): def pending_tasks(self, params=None, headers=None): """ Returns a concise representation of the cluster pending tasks. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -355,7 +355,7 @@ def thread_pool(self, thread_pool_patterns=None, params=None, headers=None): """ Returns cluster-wide thread pool statistics per node. By default the active, queue and rejected statistics are returned for all thread pools. - ``_ + ``_ :arg thread_pool_patterns: A comma-separated list of regular- expressions to filter the thread pools in the output @@ -385,7 +385,7 @@ def fielddata(self, fields=None, params=None, headers=None): """ Shows how much heap memory is currently being used by fielddata on every data node in the cluster. - ``_ + ``_ :arg fields: A comma-separated list of fields to return in the output @@ -410,7 +410,7 @@ def fielddata(self, fields=None, params=None, headers=None): def plugins(self, params=None, headers=None): """ Returns information about installed plugins across nodes node. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -432,7 +432,7 @@ def plugins(self, params=None, headers=None): def nodeattrs(self, params=None, headers=None): """ Returns information about custom node attributes. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -454,7 +454,7 @@ def nodeattrs(self, params=None, headers=None): def repositories(self, params=None, headers=None): """ Returns information about snapshot repositories registered in the cluster. - ``_ + ``_ :arg format: a short version of the Accept header, e.g. json, yaml @@ -478,7 +478,7 @@ def repositories(self, params=None, headers=None): def snapshots(self, repository=None, params=None, headers=None): """ Returns all snapshots in a specific repository. - ``_ + ``_ :arg repository: Name of repository from which to fetch the snapshot information @@ -519,7 +519,7 @@ def tasks(self, params=None, headers=None): """ Returns information about the tasks currently executing on one or more nodes in the cluster. - ``_ + ``_ :arg actions: A comma-separated list of actions that should be returned. Leave empty to return all. @@ -548,7 +548,7 @@ def tasks(self, params=None, headers=None): def templates(self, name=None, params=None, headers=None): """ Returns information about existing templates. - ``_ + ``_ :arg name: A pattern that returned template names must match :arg format: a short version of the Accept header, e.g. json, @@ -571,7 +571,7 @@ def templates(self, name=None, params=None, headers=None): def ml_data_frame_analytics(self, id=None, params=None, headers=None): """ Gets configuration and usage information about data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -600,7 +600,7 @@ def ml_data_frame_analytics(self, id=None, params=None, headers=None): def ml_datafeeds(self, datafeed_id=None, params=None, headers=None): """ Gets configuration and usage information about datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeeds stats to fetch :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -627,7 +627,7 @@ def ml_datafeeds(self, datafeed_id=None, params=None, headers=None): def ml_jobs(self, job_id=None, params=None, headers=None): """ Gets configuration and usage information about anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the jobs stats to fetch :arg allow_no_jobs: Whether to ignore if a wildcard expression @@ -667,7 +667,7 @@ def ml_jobs(self, job_id=None, params=None, headers=None): def ml_trained_models(self, model_id=None, params=None, headers=None): """ Gets configuration and usage information about inference trained models. - ``_ + ``_ :arg model_id: The ID of the trained models stats to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -705,7 +705,7 @@ def ml_trained_models(self, model_id=None, params=None, headers=None): def transforms(self, transform_id=None, params=None, headers=None): """ Gets configuration and usage information about transforms. - ``_ + ``_ :arg transform_id: The id of the transform for which to get stats. '_all' or '*' implies all transforms diff --git a/elasticsearch/client/ccr.py b/elasticsearch/client/ccr.py index 02d820574..ef1c30087 100644 --- a/elasticsearch/client/ccr.py +++ b/elasticsearch/client/ccr.py @@ -23,7 +23,7 @@ class CcrClient(NamespacedClient): def delete_auto_follow_pattern(self, name, params=None, headers=None): """ Deletes auto-follow patterns. - ``_ + ``_ :arg name: The name of the auto follow pattern. """ @@ -41,7 +41,7 @@ def delete_auto_follow_pattern(self, name, params=None, headers=None): def follow(self, index, body, params=None, headers=None): """ Creates a new follower index configured to follow the referenced leader index. - ``_ + ``_ :arg index: The name of the follower index :arg body: The name of the leader index and other optional ccr @@ -69,7 +69,7 @@ def follow_info(self, index, params=None, headers=None): """ Retrieves information about all follower indices, including parameters and status for each follower index - ``_ + ``_ :arg index: A comma-separated list of index patterns; use `_all` to perform the operation on all indices @@ -86,7 +86,7 @@ def follow_stats(self, index, params=None, headers=None): """ Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. - ``_ + ``_ :arg index: A comma-separated list of index patterns; use `_all` to perform the operation on all indices @@ -102,7 +102,7 @@ def follow_stats(self, index, params=None, headers=None): def forget_follower(self, index, body, params=None, headers=None): """ Removes the follower retention leases from the leader. - ``_ + ``_ :arg index: the name of the leader index for which specified follower retention leases should be removed @@ -128,7 +128,7 @@ def get_auto_follow_pattern(self, name=None, params=None, headers=None): """ Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. - ``_ + ``_ :arg name: The name of the auto follow pattern. """ @@ -144,7 +144,7 @@ def pause_follow(self, index, params=None, headers=None): """ Pauses a follower index. The follower index will not fetch any additional operations from the leader index. - ``_ + ``_ :arg index: The name of the follower index that should pause following its leader index. @@ -165,7 +165,7 @@ def put_auto_follow_pattern(self, name, body, params=None, headers=None): Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. - ``_ + ``_ :arg name: The name of the auto follow pattern. :arg body: The specification of the auto follow pattern @@ -186,7 +186,7 @@ def put_auto_follow_pattern(self, name, body, params=None, headers=None): def resume_follow(self, index, body=None, params=None, headers=None): """ Resumes a follower index that has been paused - ``_ + ``_ :arg index: The name of the follow index to resume following. :arg body: The name of the leader index and other optional ccr @@ -207,7 +207,7 @@ def resume_follow(self, index, body=None, params=None, headers=None): def stats(self, params=None, headers=None): """ Gets all stats related to cross-cluster replication. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_ccr/stats", params=params, headers=headers @@ -218,7 +218,7 @@ def unfollow(self, index, params=None, headers=None): """ Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. - ``_ + ``_ :arg index: The name of the follower index that should be turned into a regular index. @@ -237,7 +237,7 @@ def unfollow(self, index, params=None, headers=None): def pause_auto_follow_pattern(self, name, params=None, headers=None): """ Pauses an auto-follow pattern - ``_ + ``_ :arg name: The name of the auto follow pattern that should pause discovering new indices to follow. @@ -256,7 +256,7 @@ def pause_auto_follow_pattern(self, name, params=None, headers=None): def resume_auto_follow_pattern(self, name, params=None, headers=None): """ Resumes an auto-follow pattern that has been paused - ``_ + ``_ :arg name: The name of the auto follow pattern to resume discovering new indices to follow. diff --git a/elasticsearch/client/cluster.py b/elasticsearch/client/cluster.py index e8b036b52..d636d19b9 100644 --- a/elasticsearch/client/cluster.py +++ b/elasticsearch/client/cluster.py @@ -35,7 +35,7 @@ class ClusterClient(NamespacedClient): def health(self, index=None, params=None, headers=None): """ Returns basic information about the health of the cluster. - ``_ + ``_ :arg index: Limit the information returned to a specific index :arg expand_wildcards: Whether to expand wildcard expression to @@ -74,7 +74,7 @@ def pending_tasks(self, params=None, headers=None): """ Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. - ``_ + ``_ :arg local: Return local information, do not retrieve the state from master node (default: false) @@ -97,7 +97,7 @@ def pending_tasks(self, params=None, headers=None): def state(self, metric=None, index=None, params=None, headers=None): """ Returns a comprehensive information about the state of the cluster. - ``_ + ``_ :arg metric: Limit the information returned to the specified metrics Valid choices: _all, blocks, metadata, nodes, routing_table, @@ -136,7 +136,7 @@ def state(self, metric=None, index=None, params=None, headers=None): def stats(self, node_id=None, params=None, headers=None): """ Returns high-level overview of cluster statistics. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -161,7 +161,7 @@ def stats(self, node_id=None, params=None, headers=None): def reroute(self, body=None, params=None, headers=None): """ Allows to manually change the allocation of individual shards in the cluster. - ``_ + ``_ :arg body: The definition of `commands` to perform (`move`, `cancel`, `allocate`) @@ -186,7 +186,7 @@ def reroute(self, body=None, params=None, headers=None): def get_settings(self, params=None, headers=None): """ Returns cluster settings. - ``_ + ``_ :arg flat_settings: Return settings in flat format (default: false) @@ -204,7 +204,7 @@ def get_settings(self, params=None, headers=None): def put_settings(self, body, params=None, headers=None): """ Updates the cluster settings. - ``_ + ``_ :arg body: The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). @@ -225,7 +225,7 @@ def put_settings(self, body, params=None, headers=None): def remote_info(self, params=None, headers=None): """ Returns the information about configured remote clusters. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_remote/info", params=params, headers=headers @@ -235,7 +235,7 @@ def remote_info(self, params=None, headers=None): def allocation_explain(self, body=None, params=None, headers=None): """ Provides explanations for shard allocations in the cluster. - ``_ + ``_ :arg body: The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard' @@ -256,7 +256,7 @@ def allocation_explain(self, body=None, params=None, headers=None): def delete_component_template(self, name, params=None, headers=None): """ Deletes a component template - ``_ + ``_ :arg name: The name of the template :arg master_timeout: Specify timeout for connection to master @@ -276,7 +276,7 @@ def delete_component_template(self, name, params=None, headers=None): def get_component_template(self, name=None, params=None, headers=None): """ Returns one or more component templates - ``_ + ``_ :arg name: The comma separated names of the component templates :arg local: Return local information, do not retrieve the state @@ -295,7 +295,7 @@ def get_component_template(self, name=None, params=None, headers=None): def put_component_template(self, name, body, params=None, headers=None): """ Creates or updates a component template - ``_ + ``_ :arg name: The name of the template :arg body: The template definition @@ -320,7 +320,7 @@ def put_component_template(self, name, body, params=None, headers=None): def exists_component_template(self, name, params=None, headers=None): """ Returns information about whether a particular component template exist - ``_ + ``_ :arg name: The name of the template :arg local: Return local information, do not retrieve the state @@ -342,7 +342,7 @@ def exists_component_template(self, name, params=None, headers=None): def delete_voting_config_exclusions(self, params=None, headers=None): """ Clears cluster voting config exclusions. - ``_ + ``_ :arg wait_for_removal: Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting @@ -359,7 +359,7 @@ def delete_voting_config_exclusions(self, params=None, headers=None): def post_voting_config_exclusions(self, params=None, headers=None): """ Updates the cluster voting config exclusions by node ids or node names. - ``_ + ``_ :arg node_ids: A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you diff --git a/elasticsearch/client/dangling_indices.py b/elasticsearch/client/dangling_indices.py index 048845b62..f1b73227f 100644 --- a/elasticsearch/client/dangling_indices.py +++ b/elasticsearch/client/dangling_indices.py @@ -23,7 +23,7 @@ class DanglingIndicesClient(NamespacedClient): def delete_dangling_index(self, index_uuid, params=None, headers=None): """ Deletes the specified dangling index - ``_ + ``_ :arg index_uuid: The UUID of the dangling index :arg accept_data_loss: Must be set to true in order to delete @@ -45,7 +45,7 @@ def delete_dangling_index(self, index_uuid, params=None, headers=None): def import_dangling_index(self, index_uuid, params=None, headers=None): """ Imports the specified dangling index - ``_ + ``_ :arg index_uuid: The UUID of the dangling index :arg accept_data_loss: Must be set to true in order to import @@ -64,7 +64,7 @@ def import_dangling_index(self, index_uuid, params=None, headers=None): def list_dangling_indices(self, params=None, headers=None): """ Returns all dangling indices. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_dangling", params=params, headers=headers diff --git a/elasticsearch/client/data_frame.py b/elasticsearch/client/data_frame.py index 61eb4fb01..5d5c2da00 100644 --- a/elasticsearch/client/data_frame.py +++ b/elasticsearch/client/data_frame.py @@ -68,6 +68,7 @@ def get_data_frame_transform_stats( "GET", _make_path("_data_frame", "transforms", transform_id, "_stats"), params=params, + headers=headers, ) @query_params() diff --git a/elasticsearch/client/deprecation.py b/elasticsearch/client/deprecation.py index 76d85dafd..ac609af77 100644 --- a/elasticsearch/client/deprecation.py +++ b/elasticsearch/client/deprecation.py @@ -22,7 +22,7 @@ class DeprecationClient(NamespacedClient): @query_params() def info(self, index=None, params=None, headers=None): """ - ``_ + ``_ :arg index: Index pattern """ diff --git a/elasticsearch/client/enrich.py b/elasticsearch/client/enrich.py index 7ad6dc1b0..7b8e0ef30 100644 --- a/elasticsearch/client/enrich.py +++ b/elasticsearch/client/enrich.py @@ -23,7 +23,7 @@ class EnrichClient(NamespacedClient): def delete_policy(self, name, params=None, headers=None): """ Deletes an existing enrich policy and its enrich index. - ``_ + ``_ :arg name: The name of the enrich policy """ @@ -41,7 +41,7 @@ def delete_policy(self, name, params=None, headers=None): def execute_policy(self, name, params=None, headers=None): """ Creates the enrich index for an existing enrich policy. - ``_ + ``_ :arg name: The name of the enrich policy :arg wait_for_completion: Should the request should block until @@ -61,7 +61,7 @@ def execute_policy(self, name, params=None, headers=None): def get_policy(self, name=None, params=None, headers=None): """ Gets information about an enrich policy. - ``_ + ``_ :arg name: A comma-separated list of enrich policy names """ @@ -73,7 +73,7 @@ def get_policy(self, name=None, params=None, headers=None): def put_policy(self, name, body, params=None, headers=None): """ Creates a new enrich policy. - ``_ + ``_ :arg name: The name of the enrich policy :arg body: The enrich policy to register @@ -95,7 +95,7 @@ def stats(self, params=None, headers=None): """ Gets enrich coordinator statistics and information about enrich policies that are currently executing. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_enrich/_stats", params=params, headers=headers diff --git a/elasticsearch/client/eql.py b/elasticsearch/client/eql.py index e954f20f7..08f534271 100644 --- a/elasticsearch/client/eql.py +++ b/elasticsearch/client/eql.py @@ -23,7 +23,7 @@ class EqlClient(NamespacedClient): def search(self, index, body, params=None, headers=None): """ Returns results matching a query expressed in Event Query Language (EQL) - ``_ + ``_ :arg index: The name of the index to scope the operation :arg body: Eql request body. Use the `query` to limit the query @@ -53,7 +53,7 @@ def delete(self, id, params=None, headers=None): """ Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. - ``_ + ``_ :arg id: The async search ID """ @@ -69,7 +69,7 @@ def get(self, id, params=None, headers=None): """ Returns async results from previously executed Event Query Language (EQL) search - ``_ + ``_ :arg id: The async search ID :arg keep_alive: Update the time interval in which the results diff --git a/elasticsearch/client/graph.py b/elasticsearch/client/graph.py index 22be94439..d2e706aad 100644 --- a/elasticsearch/client/graph.py +++ b/elasticsearch/client/graph.py @@ -24,7 +24,7 @@ def explore(self, index, body=None, doc_type=None, params=None, headers=None): """ Explore extracted and summarized information about the documents and terms in an index. - ``_ + ``_ :arg index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/client/ilm.py b/elasticsearch/client/ilm.py index b88e729f8..1deec0876 100644 --- a/elasticsearch/client/ilm.py +++ b/elasticsearch/client/ilm.py @@ -24,7 +24,7 @@ def delete_lifecycle(self, policy, params=None, headers=None): """ Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. - ``_ + ``_ :arg policy: The name of the index lifecycle policy """ @@ -43,7 +43,7 @@ def explain_lifecycle(self, index, params=None, headers=None): """ Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. - ``_ + ``_ :arg index: The name of the index to explain :arg only_errors: filters the indices included in the response @@ -63,7 +63,7 @@ def get_lifecycle(self, policy=None, params=None, headers=None): """ Returns the specified policy definition. Includes the policy version and last modified date. - ``_ + ``_ :arg policy: The name of the index lifecycle policy """ @@ -75,7 +75,7 @@ def get_lifecycle(self, policy=None, params=None, headers=None): def get_status(self, params=None, headers=None): """ Retrieves the current index lifecycle management (ILM) status. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_ilm/status", params=params, headers=headers @@ -85,7 +85,7 @@ def get_status(self, params=None, headers=None): def move_to_step(self, index, body=None, params=None, headers=None): """ Manually moves an index into the specified step and executes that step. - ``_ + ``_ :arg index: The name of the index whose lifecycle step is to change @@ -106,7 +106,7 @@ def move_to_step(self, index, body=None, params=None, headers=None): def put_lifecycle(self, policy, body=None, params=None, headers=None): """ Creates a lifecycle policy - ``_ + ``_ :arg policy: The name of the index lifecycle policy :arg body: The lifecycle policy definition to register @@ -126,7 +126,7 @@ def put_lifecycle(self, policy, body=None, params=None, headers=None): def remove_policy(self, index, params=None, headers=None): """ Removes the assigned lifecycle policy and stops managing the specified index - ``_ + ``_ :arg index: The name of the index to remove policy on """ @@ -141,7 +141,7 @@ def remove_policy(self, index, params=None, headers=None): def retry(self, index, params=None, headers=None): """ Retries executing the policy for an index that is in the ERROR step. - ``_ + ``_ :arg index: The name of the indices (comma-separated) whose failed lifecycle step is to be retry @@ -157,7 +157,7 @@ def retry(self, index, params=None, headers=None): def start(self, params=None, headers=None): """ Start the index lifecycle management (ILM) plugin. - ``_ + ``_ """ return self.transport.perform_request( "POST", "/_ilm/start", params=params, headers=headers @@ -168,7 +168,7 @@ def stop(self, params=None, headers=None): """ Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin - ``_ + ``_ """ return self.transport.perform_request( "POST", "/_ilm/stop", params=params, headers=headers diff --git a/elasticsearch/client/indices.py b/elasticsearch/client/indices.py index 9bd8d6bf1..e0252ce22 100644 --- a/elasticsearch/client/indices.py +++ b/elasticsearch/client/indices.py @@ -24,7 +24,7 @@ def analyze(self, body=None, index=None, params=None, headers=None): """ Performs the analysis process on a text and return the tokens breakdown of the text. - ``_ + ``_ :arg body: Define analyzer/tokenizer parameters and the text on which the analysis should be performed @@ -42,7 +42,7 @@ def analyze(self, body=None, index=None, params=None, headers=None): def refresh(self, index=None, params=None, headers=None): """ Performs the refresh operation in one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -69,7 +69,7 @@ def refresh(self, index=None, params=None, headers=None): def flush(self, index=None, params=None, headers=None): """ Performs the flush operation on one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string for all indices @@ -101,7 +101,7 @@ def flush(self, index=None, params=None, headers=None): def create(self, index, body=None, params=None, headers=None): """ Creates an index with optional settings and mappings. - ``_ + ``_ :arg index: The name of the index :arg body: The configuration for the index (`settings` and @@ -124,7 +124,7 @@ def create(self, index, body=None, params=None, headers=None): def clone(self, index, target, body=None, params=None, headers=None): """ Clones an index - ``_ + ``_ :arg index: The name of the source index to clone :arg target: The name of the target index to clone into @@ -160,7 +160,7 @@ def clone(self, index, target, body=None, params=None, headers=None): def get(self, index, params=None, headers=None): """ Returns information about one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names :arg allow_no_indices: Ignore if a wildcard expression resolves @@ -198,7 +198,7 @@ def get(self, index, params=None, headers=None): def open(self, index, params=None, headers=None): """ Opens an index. - ``_ + ``_ :arg index: A comma separated list of indices to open :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -232,7 +232,7 @@ def open(self, index, params=None, headers=None): def close(self, index, params=None, headers=None): """ Closes an index. - ``_ + ``_ :arg index: A comma separated list of indices to close :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -265,7 +265,7 @@ def close(self, index, params=None, headers=None): def delete(self, index, params=None, headers=None): """ Deletes an index. - ``_ + ``_ :arg index: A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices @@ -297,7 +297,7 @@ def delete(self, index, params=None, headers=None): def exists(self, index, params=None, headers=None): """ Returns information about whether a particular index exists. - ``_ + ``_ :arg index: A comma-separated list of index names :arg allow_no_indices: Ignore if a wildcard expression resolves @@ -326,7 +326,7 @@ def exists_type(self, index, doc_type, params=None, headers=None): """ Returns information about whether a particular document type exists. (DEPRECATED) - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` to check the types across all indices @@ -365,7 +365,7 @@ def exists_type(self, index, doc_type, params=None, headers=None): def put_mapping(self, body, index=None, doc_type=None, params=None, headers=None): """ Updates the index mappings. - ``_ + ``_ :arg body: The mapping definition :arg index: A comma-separated list of index names the mapping @@ -412,7 +412,7 @@ def put_mapping(self, body, index=None, doc_type=None, params=None, headers=None def get_mapping(self, index=None, doc_type=None, params=None, headers=None): """ Returns mappings for one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names :arg doc_type: A comma-separated list of document types @@ -450,7 +450,7 @@ def get_field_mapping( ): """ Returns mapping for one or more fields. - ``_ + ``_ :arg fields: A comma-separated list of fields :arg index: A comma-separated list of index names @@ -484,7 +484,7 @@ def get_field_mapping( def put_alias(self, index, name, body=None, params=None, headers=None): """ Creates or updates an alias. - ``_ + ``_ :arg index: A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the @@ -511,7 +511,7 @@ def put_alias(self, index, name, body=None, params=None, headers=None): def exists_alias(self, name, index=None, params=None, headers=None): """ Returns information about whether a particular alias exists. - ``_ + ``_ :arg name: A comma-separated list of alias names to return :arg index: A comma-separated list of index names to filter @@ -538,7 +538,7 @@ def exists_alias(self, name, index=None, params=None, headers=None): def get_alias(self, index=None, name=None, params=None, headers=None): """ Returns an alias. - ``_ + ``_ :arg index: A comma-separated list of index names to filter aliases @@ -562,7 +562,7 @@ def get_alias(self, index=None, name=None, params=None, headers=None): def update_aliases(self, body, params=None, headers=None): """ Updates index aliases. - ``_ + ``_ :arg body: The definition of `actions` to perform :arg master_timeout: Specify timeout for connection to master @@ -579,7 +579,7 @@ def update_aliases(self, body, params=None, headers=None): def delete_alias(self, index, name, params=None, headers=None): """ Deletes an alias. - ``_ + ``_ :arg index: A comma-separated list of index names (supports wildcards); use `_all` for all indices @@ -600,7 +600,7 @@ def delete_alias(self, index, name, params=None, headers=None): def put_template(self, name, body, params=None, headers=None): """ Creates or updates an index template. - ``_ + ``_ :arg name: The name of the template :arg body: The template definition @@ -629,7 +629,7 @@ def put_template(self, name, body, params=None, headers=None): def exists_template(self, name, params=None, headers=None): """ Returns information about whether a particular index template exists. - ``_ + ``_ :arg name: The comma separated names of the index templates :arg flat_settings: Return settings in flat format (default: @@ -650,7 +650,7 @@ def exists_template(self, name, params=None, headers=None): def get_template(self, name=None, params=None, headers=None): """ Returns an index template. - ``_ + ``_ :arg name: The comma separated names of the index templates :arg flat_settings: Return settings in flat format (default: @@ -670,7 +670,7 @@ def get_template(self, name=None, params=None, headers=None): def delete_template(self, name, params=None, headers=None): """ Deletes an index template. - ``_ + ``_ :arg name: The name of the template :arg master_timeout: Specify timeout for connection to master @@ -695,7 +695,7 @@ def delete_template(self, name, params=None, headers=None): def get_settings(self, index=None, name=None, params=None, headers=None): """ Returns settings for one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -732,7 +732,7 @@ def get_settings(self, index=None, name=None, params=None, headers=None): def put_settings(self, body, index=None, params=None, headers=None): """ Updates the index settings. - ``_ + ``_ :arg body: The index settings to be updated :arg index: A comma-separated list of index names; use `_all` or @@ -779,7 +779,7 @@ def put_settings(self, body, index=None, params=None, headers=None): def stats(self, index=None, metric=None, params=None, headers=None): """ Provides statistics on operations happening in an index. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -822,7 +822,7 @@ def stats(self, index=None, metric=None, params=None, headers=None): def segments(self, index=None, params=None, headers=None): """ Provides low-level information about segments in a Lucene index. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -859,7 +859,7 @@ def validate_query( ): """ Allows a user to validate a potentially expensive query without executing it. - ``_ + ``_ :arg body: The query definition specified with the Query DSL :arg index: A comma-separated list of index names to restrict @@ -912,7 +912,7 @@ def validate_query( def clear_cache(self, index=None, params=None, headers=None): """ Clears all or specific caches for one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index name to limit the operation @@ -938,7 +938,7 @@ def clear_cache(self, index=None, params=None, headers=None): def recovery(self, index=None, params=None, headers=None): """ Returns information about ongoing index shard recoveries. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -961,7 +961,7 @@ def recovery(self, index=None, params=None, headers=None): def upgrade(self, index=None, params=None, headers=None): """ The _upgrade API is no longer useful and will be removed. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -986,7 +986,7 @@ def upgrade(self, index=None, params=None, headers=None): def get_upgrade(self, index=None, params=None, headers=None): """ The _upgrade API is no longer useful and will be removed. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1008,7 +1008,7 @@ def flush_synced(self, index=None, params=None, headers=None): """ Performs a synced flush operation on one or more indices. Synced flush is deprecated and will be removed in 8.0. Use flush instead - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string for all indices @@ -1034,7 +1034,7 @@ def flush_synced(self, index=None, params=None, headers=None): def shard_stores(self, index=None, params=None, headers=None): """ Provides store information for shard copies of indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1065,7 +1065,7 @@ def shard_stores(self, index=None, params=None, headers=None): def forcemerge(self, index=None, params=None, headers=None): """ Performs the force merge operation on one or more indices. - ``_ + ``_ :arg index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -1094,7 +1094,7 @@ def forcemerge(self, index=None, params=None, headers=None): def shrink(self, index, target, body=None, params=None, headers=None): """ Allow to shrink an existing index into a new index with fewer primary shards. - ``_ + ``_ :arg index: The name of the source index to shrink :arg target: The name of the target index to shrink into @@ -1126,7 +1126,7 @@ def split(self, index, target, body=None, params=None, headers=None): """ Allows you to split an existing index into a new index with more primary shards. - ``_ + ``_ :arg index: The name of the source index to split :arg target: The name of the target index to split into @@ -1162,7 +1162,7 @@ def rollover(self, alias, body=None, new_index=None, params=None, headers=None): """ Updates an alias to point to a new index when the existing index is considered to be too large or too old. - ``_ + ``_ :arg alias: The name of the alias to rollover :arg body: The conditions that needs to be met for executing @@ -1202,7 +1202,7 @@ def freeze(self, index, params=None, headers=None): """ Freezes an index. A frozen index has almost no overhead on the cluster (except for maintaining its metadata in memory) and is read-only. - ``_ + ``_ :arg index: The name of the index to freeze :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -1237,7 +1237,7 @@ def unfreeze(self, index, params=None, headers=None): """ Unfreezes an index. When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again. - ``_ + ``_ :arg index: The name of the index to unfreeze :arg allow_no_indices: Whether to ignore if a wildcard indices @@ -1264,7 +1264,7 @@ def unfreeze(self, index, params=None, headers=None): def reload_search_analyzers(self, index, params=None, headers=None): """ Reloads an index's search analyzers and their resources. - ``_ + ``_ :arg index: A comma-separated list of index names to reload analyzers for @@ -1291,7 +1291,7 @@ def reload_search_analyzers(self, index, params=None, headers=None): def create_data_stream(self, name, body=None, params=None, headers=None): """ Creates or updates a data stream - ``_ + ``_ :arg name: The name of the data stream :arg body: The data stream definition @@ -1311,7 +1311,7 @@ def create_data_stream(self, name, body=None, params=None, headers=None): def delete_data_stream(self, name, params=None, headers=None): """ Deletes a data stream. - ``_ + ``_ :arg name: A comma-separated list of data streams to delete; use `*` to delete all data streams @@ -1327,7 +1327,7 @@ def delete_data_stream(self, name, params=None, headers=None): def delete_index_template(self, name, params=None, headers=None): """ Deletes an index template. - ``_ + ``_ :arg name: The name of the template :arg master_timeout: Specify timeout for connection to master @@ -1347,7 +1347,7 @@ def delete_index_template(self, name, params=None, headers=None): def exists_index_template(self, name, params=None, headers=None): """ Returns information about whether a particular index template exists. - ``_ + ``_ :arg name: The name of the template :arg flat_settings: Return settings in flat format (default: @@ -1368,7 +1368,7 @@ def exists_index_template(self, name, params=None, headers=None): def get_index_template(self, name=None, params=None, headers=None): """ Returns an index template. - ``_ + ``_ :arg name: The comma separated names of the index templates :arg flat_settings: Return settings in flat format (default: @@ -1386,7 +1386,7 @@ def get_index_template(self, name=None, params=None, headers=None): def put_index_template(self, name, body, params=None, headers=None): """ Creates or updates an index template. - ``_ + ``_ :arg name: The name of the template :arg body: The template definition @@ -1413,7 +1413,7 @@ def simulate_index_template(self, name, body=None, params=None, headers=None): """ Simulate matching the given index name against the index templates in the system - ``_ + ``_ :arg name: The name of the index (it must be a concrete index name) @@ -1441,7 +1441,7 @@ def simulate_index_template(self, name, body=None, params=None, headers=None): def get_data_stream(self, name=None, params=None, headers=None): """ Returns data streams. - ``_ + ``_ :arg name: A comma-separated list of data streams to get; use `*` to get all data streams @@ -1454,7 +1454,7 @@ def get_data_stream(self, name=None, params=None, headers=None): def simulate_template(self, body=None, name=None, params=None, headers=None): """ Simulate resolving the given template name or body - ``_ + ``_ :arg body: New index template definition to be simulated, if no index template name is specified @@ -1531,7 +1531,7 @@ def add_block(self, index, block, params=None, headers=None): def data_streams_stats(self, name=None, params=None, headers=None): """ Provides statistics on operations happening in a data stream. - ``_ + ``_ :arg name: A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams diff --git a/elasticsearch/client/ingest.py b/elasticsearch/client/ingest.py index 879983db7..08c34f160 100644 --- a/elasticsearch/client/ingest.py +++ b/elasticsearch/client/ingest.py @@ -23,7 +23,7 @@ class IngestClient(NamespacedClient): def get_pipeline(self, id=None, params=None, headers=None): """ Returns a pipeline. - ``_ + ``_ :arg id: Comma separated list of pipeline ids. Wildcards supported @@ -38,7 +38,7 @@ def get_pipeline(self, id=None, params=None, headers=None): def put_pipeline(self, id, body, params=None, headers=None): """ Creates or updates a pipeline. - ``_ + ``_ :arg id: Pipeline ID :arg body: The ingest definition @@ -62,7 +62,7 @@ def put_pipeline(self, id, body, params=None, headers=None): def delete_pipeline(self, id, params=None, headers=None): """ Deletes a pipeline. - ``_ + ``_ :arg id: Pipeline ID :arg master_timeout: Explicit operation timeout for connection @@ -83,7 +83,7 @@ def delete_pipeline(self, id, params=None, headers=None): def simulate(self, body, id=None, params=None, headers=None): """ Allows to simulate a pipeline with example documents. - ``_ + ``_ :arg body: The simulate definition :arg id: Pipeline ID @@ -105,7 +105,7 @@ def simulate(self, body, id=None, params=None, headers=None): def processor_grok(self, params=None, headers=None): """ Returns a list of the built-in patterns. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_ingest/processor/grok", params=params, headers=headers diff --git a/elasticsearch/client/license.py b/elasticsearch/client/license.py index 71481e268..da9ef4067 100644 --- a/elasticsearch/client/license.py +++ b/elasticsearch/client/license.py @@ -23,7 +23,7 @@ class LicenseClient(NamespacedClient): def delete(self, params=None, headers=None): """ Deletes licensing information for the cluster - ``_ + ``_ """ return self.transport.perform_request( "DELETE", "/_license", params=params, headers=headers @@ -33,7 +33,7 @@ def delete(self, params=None, headers=None): def get(self, params=None, headers=None): """ Retrieves licensing information for the cluster - ``_ + ``_ :arg accept_enterprise: If the active license is an enterprise license, return type as 'enterprise' (default: false) @@ -48,7 +48,7 @@ def get(self, params=None, headers=None): def get_basic_status(self, params=None, headers=None): """ Retrieves information about the status of the basic license. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_license/basic_status", params=params, headers=headers @@ -58,7 +58,7 @@ def get_basic_status(self, params=None, headers=None): def get_trial_status(self, params=None, headers=None): """ Retrieves information about the status of the trial license. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_license/trial_status", params=params, headers=headers @@ -68,7 +68,7 @@ def get_trial_status(self, params=None, headers=None): def post(self, body=None, params=None, headers=None): """ Updates the license for the cluster. - ``_ + ``_ :arg body: licenses to be installed :arg acknowledge: whether the user has acknowledged acknowledge @@ -82,7 +82,7 @@ def post(self, body=None, params=None, headers=None): def post_start_basic(self, params=None, headers=None): """ Starts an indefinite basic license. - ``_ + ``_ :arg acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -95,7 +95,7 @@ def post_start_basic(self, params=None, headers=None): def post_start_trial(self, params=None, headers=None): """ starts a limited time trial license. - ``_ + ``_ :arg acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/client/migration.py b/elasticsearch/client/migration.py index 9af859a59..57b48f0cd 100644 --- a/elasticsearch/client/migration.py +++ b/elasticsearch/client/migration.py @@ -25,7 +25,7 @@ def deprecations(self, index=None, params=None, headers=None): Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. - ``_ + ``_ :arg index: Index pattern """ diff --git a/elasticsearch/client/ml.py b/elasticsearch/client/ml.py index 705a2bc4f..dfbffc242 100644 --- a/elasticsearch/client/ml.py +++ b/elasticsearch/client/ml.py @@ -24,7 +24,7 @@ def close_job(self, job_id, body=None, params=None, headers=None): """ Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. - ``_ + ``_ :arg job_id: The name of the job to close :arg body: The URL params optionally sent in the body @@ -50,7 +50,7 @@ def close_job(self, job_id, body=None, params=None, headers=None): def delete_calendar(self, calendar_id, params=None, headers=None): """ Deletes a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to delete """ @@ -70,7 +70,7 @@ def delete_calendar(self, calendar_id, params=None, headers=None): def delete_calendar_event(self, calendar_id, event_id, params=None, headers=None): """ Deletes scheduled events from a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg event_id: The ID of the event to remove from the calendar @@ -90,7 +90,7 @@ def delete_calendar_event(self, calendar_id, event_id, params=None, headers=None def delete_calendar_job(self, calendar_id, job_id, params=None, headers=None): """ Deletes anomaly detection jobs from a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg job_id: The ID of the job to remove from the calendar @@ -110,7 +110,7 @@ def delete_calendar_job(self, calendar_id, job_id, params=None, headers=None): def delete_datafeed(self, datafeed_id, params=None, headers=None): """ Deletes an existing datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to delete :arg force: True if the datafeed should be forcefully deleted @@ -131,7 +131,7 @@ def delete_datafeed(self, datafeed_id, params=None, headers=None): def delete_expired_data(self, body=None, job_id=None, params=None, headers=None): """ Deletes expired and unused machine learning data. - ``_ + ``_ :arg body: deleting expired data parameters :arg job_id: The ID of the job(s) to perform expired data @@ -153,7 +153,7 @@ def delete_expired_data(self, body=None, job_id=None, params=None, headers=None) def delete_filter(self, filter_id, params=None, headers=None): """ Deletes a filter. - ``_ + ``_ :arg filter_id: The ID of the filter to delete """ @@ -171,7 +171,7 @@ def delete_filter(self, filter_id, params=None, headers=None): def delete_forecast(self, job_id, forecast_id=None, params=None, headers=None): """ Deletes forecasts from a machine learning job. - ``_ + ``_ :arg job_id: The ID of the job from which to delete forecasts :arg forecast_id: The ID of the forecast to delete, can be comma @@ -195,7 +195,7 @@ def delete_forecast(self, job_id, forecast_id=None, params=None, headers=None): def delete_job(self, job_id, params=None, headers=None): """ Deletes an existing anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job to delete :arg force: True if the job should be forcefully deleted @@ -216,7 +216,7 @@ def delete_job(self, job_id, params=None, headers=None): def delete_model_snapshot(self, job_id, snapshot_id, params=None, headers=None): """ Deletes an existing model snapshot. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg snapshot_id: The ID of the snapshot to delete @@ -254,7 +254,7 @@ def find_file_structure(self, body, params=None, headers=None): """ Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. - ``_ + ``_ :arg body: The contents of the file to be analyzed :arg charset: Optional parameter to specify the character set of @@ -305,7 +305,7 @@ def find_file_structure(self, body, params=None, headers=None): def flush_job(self, job_id, body=None, params=None, headers=None): """ Forces any buffered data to be processed by the job. - ``_ + ``_ :arg job_id: The name of the job to flush :arg body: Flush parameters @@ -335,7 +335,7 @@ def flush_job(self, job_id, body=None, params=None, headers=None): def forecast(self, job_id, params=None, headers=None): """ Predicts the future behavior of a time series by using its historical behavior. - ``_ + ``_ :arg job_id: The ID of the job to forecast for :arg duration: The duration of the forecast @@ -368,7 +368,7 @@ def forecast(self, job_id, params=None, headers=None): def get_buckets(self, job_id, body=None, timestamp=None, params=None, headers=None): """ Retrieves anomaly detection job results for one or more buckets. - ``_ + ``_ :arg job_id: ID of the job to get bucket results from :arg body: Bucket selection details if not provided in URI @@ -405,7 +405,7 @@ def get_buckets(self, job_id, body=None, timestamp=None, params=None, headers=No def get_calendar_events(self, calendar_id, params=None, headers=None): """ Retrieves information about the scheduled events in calendars. - ``_ + ``_ :arg calendar_id: The ID of the calendar containing the events :arg end: Get events before this time @@ -435,7 +435,7 @@ def get_calendar_events(self, calendar_id, params=None, headers=None): def get_calendars(self, body=None, calendar_id=None, params=None, headers=None): """ Retrieves configuration information for calendars. - ``_ + ``_ :arg body: The from and size parameters optionally sent in the body @@ -461,7 +461,7 @@ def get_categories( ): """ Retrieves anomaly detection job results for one or more categories. - ``_ + ``_ :arg job_id: The name of the job :arg body: Category selection details if not provided in URI @@ -494,7 +494,7 @@ def get_categories( def get_datafeed_stats(self, datafeed_id=None, params=None, headers=None): """ Retrieves usage information for datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeeds stats to fetch :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -512,7 +512,7 @@ def get_datafeed_stats(self, datafeed_id=None, params=None, headers=None): def get_datafeeds(self, datafeed_id=None, params=None, headers=None): """ Retrieves configuration information for datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeeds to fetch :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -530,7 +530,7 @@ def get_datafeeds(self, datafeed_id=None, params=None, headers=None): def get_filters(self, filter_id=None, params=None, headers=None): """ Retrieves filters. - ``_ + ``_ :arg filter_id: The ID of the filter to fetch :arg from_: skips a number of filters @@ -560,7 +560,7 @@ def get_filters(self, filter_id=None, params=None, headers=None): def get_influencers(self, job_id, body=None, params=None, headers=None): """ Retrieves anomaly detection job results for one or more influencers. - ``_ + ``_ :arg job_id: Identifier for the anomaly detection job :arg body: Influencer selection criteria @@ -594,7 +594,7 @@ def get_influencers(self, job_id, body=None, params=None, headers=None): def get_job_stats(self, job_id=None, params=None, headers=None): """ Retrieves usage information for anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the jobs stats to fetch :arg allow_no_jobs: Whether to ignore if a wildcard expression @@ -612,7 +612,7 @@ def get_job_stats(self, job_id=None, params=None, headers=None): def get_jobs(self, job_id=None, params=None, headers=None): """ Retrieves configuration information for anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the jobs to fetch :arg allow_no_jobs: Whether to ignore if a wildcard expression @@ -632,7 +632,7 @@ def get_model_snapshots( ): """ Retrieves information about model snapshots. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg body: Model snapshot selection criteria @@ -676,7 +676,7 @@ def get_overall_buckets(self, job_id, body=None, params=None, headers=None): """ Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. - ``_ + ``_ :arg job_id: The job IDs for which to calculate overall bucket results @@ -724,7 +724,7 @@ def get_overall_buckets(self, job_id, body=None, params=None, headers=None): def get_records(self, job_id, body=None, params=None, headers=None): """ Retrieves anomaly records for an anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job :arg body: Record selection criteria @@ -757,7 +757,7 @@ def get_records(self, job_id, body=None, params=None, headers=None): def info(self, params=None, headers=None): """ Returns defaults and limits used by machine learning. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_ml/info", params=params, headers=headers @@ -767,7 +767,7 @@ def info(self, params=None, headers=None): def open_job(self, job_id, params=None, headers=None): """ Opens one or more anomaly detection jobs. - ``_ + ``_ :arg job_id: The ID of the job to open """ @@ -785,7 +785,7 @@ def open_job(self, job_id, params=None, headers=None): def post_calendar_events(self, calendar_id, body, params=None, headers=None): """ Posts scheduled events in a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg body: A list of events @@ -806,7 +806,7 @@ def post_calendar_events(self, calendar_id, body, params=None, headers=None): def post_data(self, job_id, body, params=None, headers=None): """ Sends data to an anomaly detection job for analysis. - ``_ + ``_ :arg job_id: The name of the job receiving the data :arg body: The data to process @@ -832,7 +832,7 @@ def post_data(self, job_id, body, params=None, headers=None): def preview_datafeed(self, datafeed_id, params=None, headers=None): """ Previews a datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to preview """ @@ -852,7 +852,7 @@ def preview_datafeed(self, datafeed_id, params=None, headers=None): def put_calendar(self, calendar_id, body=None, params=None, headers=None): """ Instantiates a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to create :arg body: The calendar details @@ -874,7 +874,7 @@ def put_calendar(self, calendar_id, body=None, params=None, headers=None): def put_calendar_job(self, calendar_id, job_id, params=None, headers=None): """ Adds an anomaly detection job to a calendar. - ``_ + ``_ :arg calendar_id: The ID of the calendar to modify :arg job_id: The ID of the job to add to the calendar @@ -896,7 +896,7 @@ def put_calendar_job(self, calendar_id, job_id, params=None, headers=None): def put_datafeed(self, datafeed_id, body, params=None, headers=None): """ Instantiates a datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to create :arg body: The datafeed config @@ -926,7 +926,7 @@ def put_datafeed(self, datafeed_id, body, params=None, headers=None): def put_filter(self, filter_id, body, params=None, headers=None): """ Instantiates a filter. - ``_ + ``_ :arg filter_id: The ID of the filter to create :arg body: The filter details @@ -947,7 +947,7 @@ def put_filter(self, filter_id, body, params=None, headers=None): def put_job(self, job_id, body, params=None, headers=None): """ Instantiates an anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job to create :arg body: The job @@ -970,7 +970,7 @@ def revert_model_snapshot( ): """ Reverts to a specific snapshot. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg snapshot_id: The ID of the snapshot to revert to @@ -1002,7 +1002,7 @@ def set_upgrade_mode(self, params=None, headers=None): """ Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. - ``_ + ``_ :arg enabled: Whether to enable upgrade_mode ML setting or not. Defaults to false. @@ -1017,7 +1017,7 @@ def set_upgrade_mode(self, params=None, headers=None): def start_datafeed(self, datafeed_id, body=None, params=None, headers=None): """ Starts one or more datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to start :arg body: The start datafeed parameters @@ -1044,7 +1044,7 @@ def start_datafeed(self, datafeed_id, body=None, params=None, headers=None): def stop_datafeed(self, datafeed_id, params=None, headers=None): """ Stops one or more datafeeds. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to stop :arg allow_no_datafeeds: Whether to ignore if a wildcard @@ -1072,7 +1072,7 @@ def stop_datafeed(self, datafeed_id, params=None, headers=None): def update_datafeed(self, datafeed_id, body, params=None, headers=None): """ Updates certain properties of a datafeed. - ``_ + ``_ :arg datafeed_id: The ID of the datafeed to update :arg body: The datafeed update settings @@ -1102,7 +1102,7 @@ def update_datafeed(self, datafeed_id, body, params=None, headers=None): def update_filter(self, filter_id, body, params=None, headers=None): """ Updates the description of a filter, adds items, or removes items. - ``_ + ``_ :arg filter_id: The ID of the filter to update :arg body: The filter update @@ -1123,7 +1123,7 @@ def update_filter(self, filter_id, body, params=None, headers=None): def update_job(self, job_id, body, params=None, headers=None): """ Updates certain properties of an anomaly detection job. - ``_ + ``_ :arg job_id: The ID of the job to create :arg body: The job update settings @@ -1146,7 +1146,7 @@ def update_model_snapshot( ): """ Updates certain properties of a snapshot. - ``_ + ``_ :arg job_id: The ID of the job to fetch :arg snapshot_id: The ID of the snapshot to update @@ -1213,7 +1213,7 @@ def validate_detector(self, body, params=None, headers=None): def delete_data_frame_analytics(self, id, params=None, headers=None): """ Deletes an existing data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to delete :arg force: True if the job should be forcefully deleted @@ -1234,7 +1234,7 @@ def delete_data_frame_analytics(self, id, params=None, headers=None): def evaluate_data_frame(self, body, params=None, headers=None): """ Evaluates the data frame analytics for an annotated index. - ``_ + ``_ :arg body: The evaluation definition """ @@ -1253,7 +1253,7 @@ def evaluate_data_frame(self, body, params=None, headers=None): def get_data_frame_analytics(self, id=None, params=None, headers=None): """ Retrieves configuration information for data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1278,7 +1278,7 @@ def get_data_frame_analytics(self, id=None, params=None, headers=None): def get_data_frame_analytics_stats(self, id=None, params=None, headers=None): """ Retrieves usage information for data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics stats to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1303,7 +1303,7 @@ def get_data_frame_analytics_stats(self, id=None, params=None, headers=None): def put_data_frame_analytics(self, id, body, params=None, headers=None): """ Instantiates a data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to create :arg body: The data frame analytics configuration @@ -1324,7 +1324,7 @@ def put_data_frame_analytics(self, id, body, params=None, headers=None): def start_data_frame_analytics(self, id, body=None, params=None, headers=None): """ Starts a data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to start :arg body: The start data frame analytics parameters @@ -1346,7 +1346,7 @@ def start_data_frame_analytics(self, id, body=None, params=None, headers=None): def stop_data_frame_analytics(self, id, body=None, params=None, headers=None): """ Stops one or more data frame analytics jobs. - ``_ + ``_ :arg id: The ID of the data frame analytics to stop :arg body: The stop data frame analytics parameters @@ -1374,7 +1374,7 @@ def delete_trained_model(self, model_id, params=None, headers=None): """ Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. - ``_ + ``_ :arg model_id: The ID of the trained model to delete """ @@ -1394,7 +1394,7 @@ def explain_data_frame_analytics( ): """ Explains a data frame analytics config. - ``_ + ``_ :arg body: The data frame analytics config to explain :arg id: The ID of the data frame analytics to explain @@ -1419,7 +1419,7 @@ def explain_data_frame_analytics( def get_trained_models(self, model_id=None, params=None, headers=None): """ Retrieves configuration information for a trained inference model. - ``_ + ``_ :arg model_id: The ID of the trained models to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1454,7 +1454,7 @@ def get_trained_models(self, model_id=None, params=None, headers=None): def get_trained_models_stats(self, model_id=None, params=None, headers=None): """ Retrieves usage information for trained inference models. - ``_ + ``_ :arg model_id: The ID of the trained models stats to fetch :arg allow_no_match: Whether to ignore if a wildcard expression @@ -1479,7 +1479,7 @@ def get_trained_models_stats(self, model_id=None, params=None, headers=None): def put_trained_model(self, model_id, body, params=None, headers=None): """ Creates an inference trained model. - ``_ + ``_ :arg model_id: The ID of the trained models to store :arg body: The trained model configuration @@ -1500,7 +1500,7 @@ def put_trained_model(self, model_id, body, params=None, headers=None): def estimate_model_memory(self, body, params=None, headers=None): """ Estimates the model memory - ``_ + ``_ :arg body: The analysis config, plus cardinality estimates for fields it references @@ -1520,7 +1520,7 @@ def estimate_model_memory(self, body, params=None, headers=None): def update_data_frame_analytics(self, id, body, params=None, headers=None): """ Updates certain properties of a data frame analytics job. - ``_ + ``_ :arg id: The ID of the data frame analytics to update :arg body: The data frame analytics settings to update diff --git a/elasticsearch/client/monitoring.py b/elasticsearch/client/monitoring.py index 7afb5a58b..d3b5afdaa 100644 --- a/elasticsearch/client/monitoring.py +++ b/elasticsearch/client/monitoring.py @@ -23,7 +23,7 @@ class MonitoringClient(NamespacedClient): def bulk(self, body, doc_type=None, params=None, headers=None): """ Used by the monitoring features to send monitoring data. - ``_ + ``_ :arg body: The operation definition and data (action-data pairs), separated by newlines diff --git a/elasticsearch/client/nodes.py b/elasticsearch/client/nodes.py index 0ee896208..fbbafbd94 100644 --- a/elasticsearch/client/nodes.py +++ b/elasticsearch/client/nodes.py @@ -25,7 +25,7 @@ def reload_secure_settings( ): """ Reloads secure settings. - ``_ + ``_ :arg body: An object containing the password for the elasticsearch keystore @@ -46,7 +46,7 @@ def reload_secure_settings( def info(self, node_id=None, metric=None, params=None, headers=None): """ Returns information about nodes in the cluster. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -78,7 +78,7 @@ def stats( ): """ Returns statistical information about nodes in the cluster. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -122,7 +122,7 @@ def stats( def hot_threads(self, node_id=None, params=None, headers=None): """ Returns information about hot threads on each node in the cluster. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from @@ -155,7 +155,7 @@ def hot_threads(self, node_id=None, params=None, headers=None): def usage(self, node_id=None, metric=None, params=None, headers=None): """ Returns low-level information about REST actions usage on nodes. - ``_ + ``_ :arg node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from diff --git a/elasticsearch/client/remote.py b/elasticsearch/client/remote.py index 442ba4dab..7f68fab99 100644 --- a/elasticsearch/client/remote.py +++ b/elasticsearch/client/remote.py @@ -22,7 +22,7 @@ class RemoteClient(NamespacedClient): @query_params() def info(self, params=None, headers=None): """ - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_remote/info", params=params, headers=headers diff --git a/elasticsearch/client/rollup.py b/elasticsearch/client/rollup.py index a2886fb27..5985dd669 100644 --- a/elasticsearch/client/rollup.py +++ b/elasticsearch/client/rollup.py @@ -23,7 +23,7 @@ class RollupClient(NamespacedClient): def delete_job(self, id, params=None, headers=None): """ Deletes an existing rollup job. - ``_ + ``_ :arg id: The ID of the job to delete """ @@ -38,7 +38,7 @@ def delete_job(self, id, params=None, headers=None): def get_jobs(self, id=None, params=None, headers=None): """ Retrieves the configuration, stats, and status of rollup jobs. - ``_ + ``_ :arg id: The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs @@ -52,7 +52,7 @@ def get_rollup_caps(self, id=None, params=None, headers=None): """ Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - ``_ + ``_ :arg id: The ID of the index to check rollup capabilities on, or left blank for all jobs @@ -66,7 +66,7 @@ def get_rollup_index_caps(self, index, params=None, headers=None): """ Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). - ``_ + ``_ :arg index: The rollup index or index pattern to obtain rollup capabilities from. @@ -82,7 +82,7 @@ def get_rollup_index_caps(self, index, params=None, headers=None): def put_job(self, id, body, params=None, headers=None): """ Creates a rollup job. - ``_ + ``_ :arg id: The ID of the job to create :arg body: The job configuration @@ -103,7 +103,7 @@ def put_job(self, id, body, params=None, headers=None): def rollup_search(self, index, body, doc_type=None, params=None, headers=None): """ Enables searching rolled-up data using the standard query DSL. - ``_ + ``_ :arg index: The indices or index-pattern(s) (containing rollup or regular data) that should be searched @@ -130,7 +130,7 @@ def rollup_search(self, index, body, doc_type=None, params=None, headers=None): def start_job(self, id, params=None, headers=None): """ Starts an existing, stopped rollup job. - ``_ + ``_ :arg id: The ID of the job to start """ @@ -148,7 +148,7 @@ def start_job(self, id, params=None, headers=None): def stop_job(self, id, params=None, headers=None): """ Stops an existing, started rollup job. - ``_ + ``_ :arg id: The ID of the job to stop :arg timeout: Block for (at maximum) the specified duration diff --git a/elasticsearch/client/searchable_snapshots.py b/elasticsearch/client/searchable_snapshots.py index d294086c8..400485672 100644 --- a/elasticsearch/client/searchable_snapshots.py +++ b/elasticsearch/client/searchable_snapshots.py @@ -23,7 +23,7 @@ class SearchableSnapshotsClient(NamespacedClient): def clear_cache(self, index=None, params=None, headers=None): """ Clear the cache of searchable snapshots. - ``_ + ``_ :arg index: A comma-separated list of index name to limit the operation @@ -47,7 +47,7 @@ def clear_cache(self, index=None, params=None, headers=None): def mount(self, repository, snapshot, body, params=None, headers=None): """ Mount a snapshot as a searchable index. - ``_ + ``_ :arg repository: The name of the repository containing the snapshot of the index to mount @@ -75,7 +75,7 @@ def mount(self, repository, snapshot, body, params=None, headers=None): def repository_stats(self, repository, params=None, headers=None): """ Retrieve usage statistics about a snapshot repository. - ``_ + ``_ :arg repository: The repository for which to get the stats for """ @@ -93,7 +93,7 @@ def repository_stats(self, repository, params=None, headers=None): def stats(self, index=None, params=None, headers=None): """ Retrieve various statistics about searchable snapshots. - ``_ + ``_ :arg index: A comma-separated list of index names """ diff --git a/elasticsearch/client/security.py b/elasticsearch/client/security.py index 059cc0d49..0e1474e07 100644 --- a/elasticsearch/client/security.py +++ b/elasticsearch/client/security.py @@ -24,7 +24,7 @@ def authenticate(self, params=None, headers=None): """ Enables authentication as a user and retrieve information about the authenticated user. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_security/_authenticate", params=params, headers=headers @@ -34,7 +34,7 @@ def authenticate(self, params=None, headers=None): def change_password(self, body, username=None, params=None, headers=None): """ Changes the passwords of users in the native realm and built-in users. - ``_ + ``_ :arg body: the new password for the user :arg username: The username of the user to change the password @@ -60,7 +60,7 @@ def clear_cached_realms(self, realms, params=None, headers=None): """ Evicts users from the user cache. Can completely clear the cache or evict specific users. - ``_ + ``_ :arg realms: Comma-separated list of realms to clear :arg usernames: Comma-separated list of usernames to clear from @@ -80,7 +80,7 @@ def clear_cached_realms(self, realms, params=None, headers=None): def clear_cached_roles(self, name, params=None, headers=None): """ Evicts roles from the native role cache. - ``_ + ``_ :arg name: Role name """ @@ -98,7 +98,7 @@ def clear_cached_roles(self, name, params=None, headers=None): def create_api_key(self, body, params=None, headers=None): """ Creates an API key for access without requiring basic authentication. - ``_ + ``_ :arg body: The api key request to create an API key :arg refresh: If `true` (the default) then refresh the affected @@ -117,7 +117,7 @@ def create_api_key(self, body, params=None, headers=None): def delete_privileges(self, application, name, params=None, headers=None): """ Removes application privileges. - ``_ + ``_ :arg application: Application name :arg name: Privilege name @@ -141,7 +141,7 @@ def delete_privileges(self, application, name, params=None, headers=None): def delete_role(self, name, params=None, headers=None): """ Removes roles in the native realm. - ``_ + ``_ :arg name: Role name :arg refresh: If `true` (the default) then refresh the affected @@ -163,7 +163,7 @@ def delete_role(self, name, params=None, headers=None): def delete_role_mapping(self, name, params=None, headers=None): """ Removes role mappings. - ``_ + ``_ :arg name: Role-mapping name :arg refresh: If `true` (the default) then refresh the affected @@ -185,7 +185,7 @@ def delete_role_mapping(self, name, params=None, headers=None): def delete_user(self, username, params=None, headers=None): """ Deletes users from the native realm. - ``_ + ``_ :arg username: username :arg refresh: If `true` (the default) then refresh the affected @@ -207,7 +207,7 @@ def delete_user(self, username, params=None, headers=None): def disable_user(self, username, params=None, headers=None): """ Disables users in the native realm. - ``_ + ``_ :arg username: The username of the user to disable :arg refresh: If `true` (the default) then refresh the affected @@ -229,7 +229,7 @@ def disable_user(self, username, params=None, headers=None): def enable_user(self, username, params=None, headers=None): """ Enables users in the native realm. - ``_ + ``_ :arg username: The username of the user to enable :arg refresh: If `true` (the default) then refresh the affected @@ -251,7 +251,7 @@ def enable_user(self, username, params=None, headers=None): def get_api_key(self, params=None, headers=None): """ Retrieves information for one or more API keys. - ``_ + ``_ :arg id: API key id of the API key to be retrieved :arg name: API key name of the API key to be retrieved @@ -270,7 +270,7 @@ def get_api_key(self, params=None, headers=None): def get_privileges(self, application=None, name=None, params=None, headers=None): """ Retrieves application privileges. - ``_ + ``_ :arg application: Application name :arg name: Privilege name @@ -286,7 +286,7 @@ def get_privileges(self, application=None, name=None, params=None, headers=None) def get_role(self, name=None, params=None, headers=None): """ Retrieves roles in the native realm. - ``_ + ``_ :arg name: Role name """ @@ -298,7 +298,7 @@ def get_role(self, name=None, params=None, headers=None): def get_role_mapping(self, name=None, params=None, headers=None): """ Retrieves role mappings. - ``_ + ``_ :arg name: Role-Mapping name """ @@ -313,7 +313,7 @@ def get_role_mapping(self, name=None, params=None, headers=None): def get_token(self, body, params=None, headers=None): """ Creates a bearer token for access without requiring basic authentication. - ``_ + ``_ :arg body: The token request to get """ @@ -328,7 +328,7 @@ def get_token(self, body, params=None, headers=None): def get_user(self, username=None, params=None, headers=None): """ Retrieves information about users in the native realm and built-in users. - ``_ + ``_ :arg username: A comma-separated list of usernames """ @@ -343,7 +343,7 @@ def get_user(self, username=None, params=None, headers=None): def get_user_privileges(self, params=None, headers=None): """ Retrieves application privileges. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_security/user/_privileges", params=params, headers=headers @@ -353,7 +353,7 @@ def get_user_privileges(self, params=None, headers=None): def has_privileges(self, body, user=None, params=None, headers=None): """ Determines whether the specified user has a specified list of privileges. - ``_ + ``_ :arg body: The privileges to test :arg user: Username @@ -373,7 +373,7 @@ def has_privileges(self, body, user=None, params=None, headers=None): def invalidate_api_key(self, body, params=None, headers=None): """ Invalidates one or more API keys. - ``_ + ``_ :arg body: The api key request to invalidate API key(s) """ @@ -388,7 +388,7 @@ def invalidate_api_key(self, body, params=None, headers=None): def invalidate_token(self, body, params=None, headers=None): """ Invalidates one or more access tokens or refresh tokens. - ``_ + ``_ :arg body: The token to invalidate """ @@ -407,7 +407,7 @@ def invalidate_token(self, body, params=None, headers=None): def put_privileges(self, body, params=None, headers=None): """ Adds or updates application privileges. - ``_ + ``_ :arg body: The privilege(s) to add :arg refresh: If `true` (the default) then refresh the affected @@ -426,7 +426,7 @@ def put_privileges(self, body, params=None, headers=None): def put_role(self, name, body, params=None, headers=None): """ Adds and updates roles in the native realm. - ``_ + ``_ :arg name: Role name :arg body: The role to add @@ -451,7 +451,7 @@ def put_role(self, name, body, params=None, headers=None): def put_role_mapping(self, name, body, params=None, headers=None): """ Creates and updates role mappings. - ``_ + ``_ :arg name: Role-mapping name :arg body: The role mapping to add @@ -477,7 +477,7 @@ def put_user(self, username, body, params=None, headers=None): """ Adds and updates users in the native realm. These users are commonly referred to as native users. - ``_ + ``_ :arg username: The username of the User :arg body: The user to add @@ -503,7 +503,7 @@ def get_builtin_privileges(self, params=None, headers=None): """ Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_security/privilege/_builtin", params=params, headers=headers @@ -513,7 +513,7 @@ def get_builtin_privileges(self, params=None, headers=None): def clear_cached_privileges(self, application, params=None, headers=None): """ Evicts application privileges from the native application privileges cache. - ``_ + ``_ :arg application: A comma-separated list of application names """ diff --git a/elasticsearch/client/slm.py b/elasticsearch/client/slm.py index aec30a51a..501dadb8d 100644 --- a/elasticsearch/client/slm.py +++ b/elasticsearch/client/slm.py @@ -23,7 +23,7 @@ class SlmClient(NamespacedClient): def delete_lifecycle(self, policy_id, params=None, headers=None): """ Deletes an existing snapshot lifecycle policy. - ``_ + ``_ :arg policy_id: The id of the snapshot lifecycle policy to remove @@ -43,7 +43,7 @@ def execute_lifecycle(self, policy_id, params=None, headers=None): """ Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. - ``_ + ``_ :arg policy_id: The id of the snapshot lifecycle policy to be executed @@ -63,7 +63,7 @@ def execute_retention(self, params=None, headers=None): """ Deletes any snapshots that are expired according to the policy's retention rules. - ``_ + ``_ """ return self.transport.perform_request( "POST", "/_slm/_execute_retention", params=params, headers=headers @@ -74,7 +74,7 @@ def get_lifecycle(self, policy_id=None, params=None, headers=None): """ Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. - ``_ + ``_ :arg policy_id: Comma-separated list of snapshot lifecycle policies to retrieve @@ -91,7 +91,7 @@ def get_stats(self, params=None, headers=None): """ Returns global and policy-level statistics about actions taken by snapshot lifecycle management. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_slm/stats", params=params, headers=headers @@ -101,7 +101,7 @@ def get_stats(self, params=None, headers=None): def put_lifecycle(self, policy_id, body=None, params=None, headers=None): """ Creates or updates a snapshot lifecycle policy. - ``_ + ``_ :arg policy_id: The id of the snapshot lifecycle policy :arg body: The snapshot lifecycle policy definition to register @@ -121,7 +121,7 @@ def put_lifecycle(self, policy_id, body=None, params=None, headers=None): def get_status(self, params=None, headers=None): """ Retrieves the status of snapshot lifecycle management (SLM). - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_slm/status", params=params, headers=headers @@ -131,7 +131,7 @@ def get_status(self, params=None, headers=None): def start(self, params=None, headers=None): """ Turns on snapshot lifecycle management (SLM). - ``_ + ``_ """ return self.transport.perform_request( "POST", "/_slm/start", params=params, headers=headers @@ -141,7 +141,7 @@ def start(self, params=None, headers=None): def stop(self, params=None, headers=None): """ Turns off snapshot lifecycle management (SLM). - ``_ + ``_ """ return self.transport.perform_request( "POST", "/_slm/stop", params=params, headers=headers diff --git a/elasticsearch/client/snapshot.py b/elasticsearch/client/snapshot.py index a9a4ef6bc..cf222fef8 100644 --- a/elasticsearch/client/snapshot.py +++ b/elasticsearch/client/snapshot.py @@ -23,7 +23,7 @@ class SnapshotClient(NamespacedClient): def create(self, repository, snapshot, body=None, params=None, headers=None): """ Creates a snapshot in a repository. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A snapshot name @@ -49,7 +49,7 @@ def create(self, repository, snapshot, body=None, params=None, headers=None): def delete(self, repository, snapshot, params=None, headers=None): """ Deletes a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A snapshot name @@ -71,7 +71,7 @@ def delete(self, repository, snapshot, params=None, headers=None): def get(self, repository, snapshot, params=None, headers=None): """ Returns information about a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A comma-separated list of snapshot names @@ -98,7 +98,7 @@ def get(self, repository, snapshot, params=None, headers=None): def delete_repository(self, repository, params=None, headers=None): """ Deletes a repository. - ``_ + ``_ :arg repository: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -120,7 +120,7 @@ def delete_repository(self, repository, params=None, headers=None): def get_repository(self, repository=None, params=None, headers=None): """ Returns information about a repository. - ``_ + ``_ :arg repository: A comma-separated list of repository names :arg local: Return local information, do not retrieve the state @@ -136,7 +136,7 @@ def get_repository(self, repository=None, params=None, headers=None): def create_repository(self, repository, body, params=None, headers=None): """ Creates a repository. - ``_ + ``_ :arg repository: A repository name :arg body: The repository definition @@ -161,7 +161,7 @@ def create_repository(self, repository, body, params=None, headers=None): def restore(self, repository, snapshot, body=None, params=None, headers=None): """ Restores a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A snapshot name @@ -187,7 +187,7 @@ def restore(self, repository, snapshot, body=None, params=None, headers=None): def status(self, repository=None, snapshot=None, params=None, headers=None): """ Returns information about the status of a snapshot. - ``_ + ``_ :arg repository: A repository name :arg snapshot: A comma-separated list of snapshot names @@ -208,7 +208,7 @@ def status(self, repository=None, snapshot=None, params=None, headers=None): def verify_repository(self, repository, params=None, headers=None): """ Verifies a repository. - ``_ + ``_ :arg repository: A repository name :arg master_timeout: Explicit operation timeout for connection @@ -229,7 +229,7 @@ def verify_repository(self, repository, params=None, headers=None): def cleanup_repository(self, repository, params=None, headers=None): """ Removes stale data from repository. - ``_ + ``_ :arg repository: A repository name :arg master_timeout: Explicit operation timeout for connection diff --git a/elasticsearch/client/sql.py b/elasticsearch/client/sql.py index a4179ff06..29c3246d8 100644 --- a/elasticsearch/client/sql.py +++ b/elasticsearch/client/sql.py @@ -23,7 +23,7 @@ class SqlClient(NamespacedClient): def clear_cursor(self, body, params=None, headers=None): """ Clears the SQL cursor - ``_ + ``_ :arg body: Specify the cursor value in the `cursor` element to clean the cursor. @@ -39,7 +39,7 @@ def clear_cursor(self, body, params=None, headers=None): def query(self, body, params=None, headers=None): """ Executes a SQL request - ``_ + ``_ :arg body: Use the `query` element to start a query. Use the `cursor` element to continue a query. @@ -57,7 +57,7 @@ def query(self, body, params=None, headers=None): def translate(self, body, params=None, headers=None): """ Translates SQL into Elasticsearch queries - ``_ + ``_ :arg body: Specify the query in the `query` element. """ diff --git a/elasticsearch/client/ssl.py b/elasticsearch/client/ssl.py index 743aecffb..7e0b4af06 100644 --- a/elasticsearch/client/ssl.py +++ b/elasticsearch/client/ssl.py @@ -24,7 +24,7 @@ def certificates(self, params=None, headers=None): """ Retrieves information about the X.509 certificates used to encrypt communications in the cluster. - ``_ + ``_ """ return self.transport.perform_request( "GET", "/_ssl/certificates", params=params, headers=headers diff --git a/elasticsearch/client/tasks.py b/elasticsearch/client/tasks.py index 45e0b865d..fb836f6de 100644 --- a/elasticsearch/client/tasks.py +++ b/elasticsearch/client/tasks.py @@ -32,7 +32,7 @@ class TasksClient(NamespacedClient): def list(self, params=None, headers=None): """ Returns a list of tasks. - ``_ + ``_ :arg actions: A comma-separated list of actions that should be returned. Leave empty to return all. @@ -56,7 +56,7 @@ def list(self, params=None, headers=None): def cancel(self, task_id=None, params=None, headers=None): """ Cancels a task, if it can be cancelled through an API. - ``_ + ``_ :arg task_id: Cancel the task with specified task id (node_id:task_number) @@ -82,7 +82,7 @@ def cancel(self, task_id=None, params=None, headers=None): def get(self, task_id=None, params=None, headers=None): """ Returns information about a task. - ``_ + ``_ :arg task_id: Return the task with specified id (node_id:task_number) diff --git a/elasticsearch/client/transform.py b/elasticsearch/client/transform.py index a2c6c6f51..bd9bf2e91 100644 --- a/elasticsearch/client/transform.py +++ b/elasticsearch/client/transform.py @@ -23,7 +23,7 @@ class TransformClient(NamespacedClient): def delete_transform(self, transform_id, params=None, headers=None): """ Deletes an existing transform. - ``_ + ``_ :arg transform_id: The id of the transform to delete :arg force: When `true`, the transform is deleted regardless of @@ -46,7 +46,7 @@ def delete_transform(self, transform_id, params=None, headers=None): def get_transform(self, transform_id=None, params=None, headers=None): """ Retrieves configuration information for transforms. - ``_ + ``_ :arg transform_id: The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all @@ -73,7 +73,7 @@ def get_transform(self, transform_id=None, params=None, headers=None): def get_transform_stats(self, transform_id, params=None, headers=None): """ Retrieves usage information for transforms. - ``_ + ``_ :arg transform_id: The id of the transform for which to get stats. '_all' or '*' implies all transforms @@ -104,7 +104,7 @@ def get_transform_stats(self, transform_id, params=None, headers=None): def preview_transform(self, body, params=None, headers=None): """ Previews a transform. - ``_ + ``_ :arg body: The definition for the transform to preview """ @@ -119,7 +119,7 @@ def preview_transform(self, body, params=None, headers=None): def put_transform(self, transform_id, body, params=None, headers=None): """ Instantiates a transform. - ``_ + ``_ :arg transform_id: The id of the new transform. :arg body: The transform definition @@ -142,7 +142,7 @@ def put_transform(self, transform_id, body, params=None, headers=None): def start_transform(self, transform_id, params=None, headers=None): """ Starts one or more transforms. - ``_ + ``_ :arg transform_id: The id of the transform to start :arg timeout: Controls the time to wait for the transform to @@ -170,7 +170,7 @@ def start_transform(self, transform_id, params=None, headers=None): def stop_transform(self, transform_id, params=None, headers=None): """ Stops one or more transforms. - ``_ + ``_ :arg transform_id: The id of the transform to stop :arg allow_no_match: Whether to ignore if a wildcard expression @@ -201,7 +201,7 @@ def stop_transform(self, transform_id, params=None, headers=None): def update_transform(self, transform_id, body, params=None, headers=None): """ Updates certain properties of a transform. - ``_ + ``_ :arg transform_id: The id of the transform. :arg body: The update transform definition diff --git a/elasticsearch/client/watcher.py b/elasticsearch/client/watcher.py index 7b7636c5c..6c5c37b95 100644 --- a/elasticsearch/client/watcher.py +++ b/elasticsearch/client/watcher.py @@ -23,7 +23,7 @@ class WatcherClient(NamespacedClient): def ack_watch(self, watch_id, action_id=None, params=None, headers=None): """ Acknowledges a watch, manually throttling the execution of the watch's actions. - ``_ + ``_ :arg watch_id: Watch ID :arg action_id: A comma-separated list of the action ids to be @@ -43,7 +43,7 @@ def ack_watch(self, watch_id, action_id=None, params=None, headers=None): def activate_watch(self, watch_id, params=None, headers=None): """ Activates a currently inactive watch. - ``_ + ``_ :arg watch_id: Watch ID """ @@ -61,7 +61,7 @@ def activate_watch(self, watch_id, params=None, headers=None): def deactivate_watch(self, watch_id, params=None, headers=None): """ Deactivates a currently active watch. - ``_ + ``_ :arg watch_id: Watch ID """ @@ -79,7 +79,7 @@ def deactivate_watch(self, watch_id, params=None, headers=None): def delete_watch(self, id, params=None, headers=None): """ Removes a watch from Watcher. - ``_ + ``_ :arg id: Watch ID """ @@ -97,7 +97,7 @@ def delete_watch(self, id, params=None, headers=None): def execute_watch(self, body=None, id=None, params=None, headers=None): """ Forces the execution of a stored watch. - ``_ + ``_ :arg body: Execution control :arg id: Watch ID @@ -116,7 +116,7 @@ def execute_watch(self, body=None, id=None, params=None, headers=None): def get_watch(self, id, params=None, headers=None): """ Retrieves a watch by its ID. - ``_ + ``_ :arg id: Watch ID """ @@ -131,7 +131,7 @@ def get_watch(self, id, params=None, headers=None): def put_watch(self, id, body=None, params=None, headers=None): """ Creates a new watch, or updates an existing one. - ``_ + ``_ :arg id: Watch ID :arg body: The watch @@ -157,7 +157,7 @@ def put_watch(self, id, body=None, params=None, headers=None): def start(self, params=None, headers=None): """ Starts Watcher if it is not already running. - ``_ + ``_ """ return self.transport.perform_request( "POST", "/_watcher/_start", params=params, headers=headers @@ -167,7 +167,7 @@ def start(self, params=None, headers=None): def stats(self, metric=None, params=None, headers=None): """ Retrieves the current Watcher metrics. - ``_ + ``_ :arg metric: Controls what additional stat metrics should be include in the response Valid choices: _all, queued_watches, @@ -186,7 +186,7 @@ def stats(self, metric=None, params=None, headers=None): def stop(self, params=None, headers=None): """ Stops Watcher if it is running. - ``_ + ``_ """ return self.transport.perform_request( "POST", "/_watcher/_stop", params=params, headers=headers diff --git a/elasticsearch/client/xpack.py b/elasticsearch/client/xpack.py index 76f857fe5..aa74982e5 100644 --- a/elasticsearch/client/xpack.py +++ b/elasticsearch/client/xpack.py @@ -27,7 +27,7 @@ def __getattr__(self, attr_name): def info(self, params=None, headers=None): """ Retrieves information about the installed X-Pack features. - ``_ + ``_ :arg accept_enterprise: If an enterprise license is installed, return the type and mode as 'enterprise' (default: false) @@ -42,7 +42,7 @@ def info(self, params=None, headers=None): def usage(self, params=None, headers=None): """ Retrieves usage information about the installed X-Pack features. - ``_ + ``_ :arg master_timeout: Specify timeout for watch write operation """ diff --git a/utils/generate_api.py b/utils/generate_api.py index 94815fab8..11ead0ab3 100644 --- a/utils/generate_api.py +++ b/utils/generate_api.py @@ -38,7 +38,7 @@ # global substitutions for python keywords SUBSTITUTIONS = {"type": "doc_type", "from": "from_"} # api path(s) -BRANCH_NAME = "7.x" +BRANCH_NAME = "7.9" CODE_ROOT = Path(__file__).absolute().parent.parent BASE_PATH = ( CODE_ROOT.parent