From c1fbdef75e882be6ee904022047e1afaa99d4202 Mon Sep 17 00:00:00 2001 From: Seth Michael Larson Date: Tue, 20 Oct 2020 13:02:15 -0500 Subject: [PATCH] API: Update Elasticsearch APIs for 7.x --- elasticsearch/_async/client/__init__.py | 40 ++++ elasticsearch/_async/client/__init__.pyi | 120 ++++++++---- elasticsearch/_async/client/async_search.py | 3 + elasticsearch/_async/client/async_search.pyi | 9 +- elasticsearch/_async/client/autoscaling.py | 4 + elasticsearch/_async/client/autoscaling.pyi | 12 +- elasticsearch/_async/client/cat.py | 25 +++ elasticsearch/_async/client/cat.pyi | 75 ++++--- elasticsearch/_async/client/ccr.py | 13 ++ elasticsearch/_async/client/ccr.pyi | 39 ++-- elasticsearch/_async/client/cluster.py | 15 ++ elasticsearch/_async/client/cluster.pyi | 45 +++-- .../_async/client/dangling_indices.py | 3 + .../_async/client/dangling_indices.pyi | 9 +- elasticsearch/_async/client/data_frame.py | 1 + elasticsearch/_async/client/data_frame.pyi | 7 + elasticsearch/_async/client/deprecation.pyi | 1 + elasticsearch/_async/client/enrich.py | 5 + elasticsearch/_async/client/enrich.pyi | 15 +- elasticsearch/_async/client/eql.py | 3 + elasticsearch/_async/client/eql.pyi | 9 +- elasticsearch/_async/client/graph.py | 1 + elasticsearch/_async/client/graph.pyi | 3 +- elasticsearch/_async/client/ilm.py | 10 + elasticsearch/_async/client/ilm.pyi | 30 ++- elasticsearch/_async/client/indices.py | 53 +++++ elasticsearch/_async/client/indices.pyi | 159 ++++++++++----- elasticsearch/_async/client/ingest.py | 5 + elasticsearch/_async/client/ingest.pyi | 15 +- elasticsearch/_async/client/license.py | 7 + elasticsearch/_async/client/license.pyi | 21 +- elasticsearch/_async/client/migration.py | 1 + elasticsearch/_async/client/migration.pyi | 3 +- elasticsearch/_async/client/ml.py | 78 +++++++- elasticsearch/_async/client/ml.pyi | 185 ++++++++++++------ elasticsearch/_async/client/monitoring.py | 1 + elasticsearch/_async/client/monitoring.pyi | 3 +- elasticsearch/_async/client/nodes.py | 5 + elasticsearch/_async/client/nodes.pyi | 15 +- elasticsearch/_async/client/remote.pyi | 1 + elasticsearch/_async/client/rollup.py | 8 + elasticsearch/_async/client/rollup.pyi | 24 ++- .../_async/client/searchable_snapshots.py | 4 + .../_async/client/searchable_snapshots.pyi | 12 +- elasticsearch/_async/client/security.py | 56 +++++- elasticsearch/_async/client/security.pyi | 100 +++++++--- elasticsearch/_async/client/slm.py | 9 + elasticsearch/_async/client/slm.pyi | 27 ++- elasticsearch/_async/client/snapshot.py | 38 ++++ elasticsearch/_async/client/snapshot.pyi | 49 ++++- elasticsearch/_async/client/sql.py | 3 + elasticsearch/_async/client/sql.pyi | 9 +- elasticsearch/_async/client/ssl.py | 1 + elasticsearch/_async/client/ssl.pyi | 3 +- elasticsearch/_async/client/tasks.py | 3 + elasticsearch/_async/client/tasks.pyi | 9 +- elasticsearch/_async/client/transform.py | 12 +- elasticsearch/_async/client/transform.pyi | 25 ++- elasticsearch/_async/client/watcher.py | 10 + elasticsearch/_async/client/watcher.pyi | 30 ++- elasticsearch/_async/client/xpack.py | 2 + elasticsearch/_async/client/xpack.pyi | 6 +- elasticsearch/client/__init__.py | 40 ++++ elasticsearch/client/__init__.pyi | 120 ++++++++---- elasticsearch/client/async_search.py | 3 + elasticsearch/client/async_search.pyi | 9 +- elasticsearch/client/autoscaling.py | 4 + elasticsearch/client/autoscaling.pyi | 12 +- elasticsearch/client/cat.py | 25 +++ elasticsearch/client/cat.pyi | 75 ++++--- elasticsearch/client/ccr.py | 13 ++ elasticsearch/client/ccr.pyi | 39 ++-- elasticsearch/client/cluster.py | 15 ++ elasticsearch/client/cluster.pyi | 45 +++-- elasticsearch/client/dangling_indices.py | 3 + elasticsearch/client/dangling_indices.pyi | 9 +- elasticsearch/client/data_frame.py | 1 + elasticsearch/client/data_frame.pyi | 7 + elasticsearch/client/deprecation.pyi | 1 + elasticsearch/client/enrich.py | 5 + elasticsearch/client/enrich.pyi | 15 +- elasticsearch/client/eql.py | 3 + elasticsearch/client/eql.pyi | 9 +- elasticsearch/client/graph.py | 1 + elasticsearch/client/graph.pyi | 3 +- elasticsearch/client/ilm.py | 10 + elasticsearch/client/ilm.pyi | 30 ++- elasticsearch/client/indices.py | 53 +++++ elasticsearch/client/indices.pyi | 159 ++++++++++----- elasticsearch/client/ingest.py | 5 + elasticsearch/client/ingest.pyi | 15 +- elasticsearch/client/license.py | 7 + elasticsearch/client/license.pyi | 21 +- elasticsearch/client/migration.py | 1 + elasticsearch/client/migration.pyi | 3 +- elasticsearch/client/ml.py | 78 +++++++- elasticsearch/client/ml.pyi | 185 ++++++++++++------ elasticsearch/client/monitoring.py | 1 + elasticsearch/client/monitoring.pyi | 3 +- elasticsearch/client/nodes.py | 5 + elasticsearch/client/nodes.pyi | 15 +- elasticsearch/client/remote.pyi | 1 + elasticsearch/client/rollup.py | 8 + elasticsearch/client/rollup.pyi | 24 ++- elasticsearch/client/searchable_snapshots.py | 4 + elasticsearch/client/searchable_snapshots.pyi | 12 +- elasticsearch/client/security.py | 56 +++++- elasticsearch/client/security.pyi | 100 +++++++--- elasticsearch/client/slm.py | 9 + elasticsearch/client/slm.pyi | 27 ++- elasticsearch/client/snapshot.py | 38 ++++ elasticsearch/client/snapshot.pyi | 49 ++++- elasticsearch/client/sql.py | 3 + elasticsearch/client/sql.pyi | 9 +- elasticsearch/client/ssl.py | 1 + elasticsearch/client/ssl.pyi | 3 +- elasticsearch/client/tasks.py | 3 + elasticsearch/client/tasks.pyi | 9 +- elasticsearch/client/transform.py | 12 +- elasticsearch/client/transform.pyi | 25 ++- elasticsearch/client/watcher.py | 10 + elasticsearch/client/watcher.pyi | 30 ++- elasticsearch/client/xpack.py | 2 + elasticsearch/client/xpack.pyi | 6 +- 124 files changed, 2278 insertions(+), 700 deletions(-) diff --git a/elasticsearch/_async/client/__init__.py b/elasticsearch/_async/client/__init__.py index 0f1d9a9a..deb8b4b2 100644 --- a/elasticsearch/_async/client/__init__.py +++ b/elasticsearch/_async/client/__init__.py @@ -266,6 +266,7 @@ class AsyncElasticsearch(object): async def ping(self, params=None, headers=None): """ Returns whether the cluster is running. + ``_ """ try: @@ -279,6 +280,7 @@ class AsyncElasticsearch(object): async def info(self, params=None, headers=None): """ Returns basic information about the cluster. + ``_ """ return await self.transport.perform_request( @@ -298,6 +300,7 @@ class AsyncElasticsearch(object): """ 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 @@ -352,6 +355,7 @@ class AsyncElasticsearch(object): ): """ Creates or updates a document in an index. + ``_ :arg index: The name of the index @@ -415,6 +419,7 @@ class AsyncElasticsearch(object): 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 @@ -461,6 +466,7 @@ class AsyncElasticsearch(object): 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 @@ -499,6 +505,7 @@ class AsyncElasticsearch(object): ): """ Returns number of documents matching a query. + ``_ :arg body: A query to restrict the results specified with the @@ -556,6 +563,7 @@ class AsyncElasticsearch(object): 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 @@ -633,6 +641,7 @@ class AsyncElasticsearch(object): ): """ Deletes documents matching the provided query. + ``_ :arg index: A comma-separated list of index names to search; use @@ -729,6 +738,7 @@ class AsyncElasticsearch(object): """ Changes the number of requests per second for a particular Delete By Query operation. + ``_ :arg task_id: The task id to rethrottle @@ -749,6 +759,7 @@ class AsyncElasticsearch(object): async def delete_script(self, id, params=None, headers=None): """ Deletes a script. + ``_ :arg id: Script ID @@ -777,6 +788,7 @@ class AsyncElasticsearch(object): 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 @@ -827,6 +839,7 @@ class AsyncElasticsearch(object): 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 @@ -882,6 +895,7 @@ class AsyncElasticsearch(object): ): """ Returns information about why a specific matches (or doesn't match) a query. + ``_ :arg index: The name of the index @@ -934,6 +948,7 @@ class AsyncElasticsearch(object): """ Returns the information about the capabilities of fields among multiple indices. + ``_ :arg body: An index filter specified with the Query DSL @@ -974,6 +989,7 @@ class AsyncElasticsearch(object): async def get(self, index, id, doc_type=None, params=None, headers=None): """ Returns a document. + ``_ :arg index: The name of the index @@ -1014,6 +1030,7 @@ class AsyncElasticsearch(object): async def get_script(self, id, params=None, headers=None): """ Returns a script. + ``_ :arg id: Script ID @@ -1040,6 +1057,7 @@ class AsyncElasticsearch(object): 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 @@ -1089,6 +1107,7 @@ class AsyncElasticsearch(object): 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` @@ -1135,6 +1154,7 @@ class AsyncElasticsearch(object): 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 @@ -1191,6 +1211,7 @@ class AsyncElasticsearch(object): ): """ Allows to execute several search template operations in one request. + ``_ :arg body: The request definitions (metadata-search request @@ -1243,6 +1264,7 @@ class AsyncElasticsearch(object): ): """ Returns multiple termvectors in one request. + ``_ :arg body: Define ids, documents, parameters or a list of @@ -1295,6 +1317,7 @@ class AsyncElasticsearch(object): async def put_script(self, id, body, context=None, params=None, headers=None): """ Creates or updates a script. + ``_ :arg id: Script ID @@ -1322,6 +1345,7 @@ class AsyncElasticsearch(object): """ Allows to evaluate the quality of ranked search results over a set of typical search queries + ``_ :arg body: The ranking evaluation search definition, including @@ -1365,6 +1389,7 @@ class AsyncElasticsearch(object): 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 @@ -1400,6 +1425,7 @@ class AsyncElasticsearch(object): 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 @@ -1422,6 +1448,7 @@ class AsyncElasticsearch(object): ): """ Allows to use the Mustache language to pre-render a search definition. + ``_ :arg body: The search definition template and its params @@ -1439,6 +1466,7 @@ class AsyncElasticsearch(object): async def scripts_painless_execute(self, body=None, params=None, headers=None): """ Allows an arbitrary script to be executed and a result to be returned + ``_ :arg body: The script to execute @@ -1455,6 +1483,7 @@ class AsyncElasticsearch(object): 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 @@ -1525,6 +1554,7 @@ class AsyncElasticsearch(object): ): """ Returns results matching a query. + ``_ :arg body: The search definition using the Query DSL @@ -1647,6 +1677,7 @@ class AsyncElasticsearch(object): """ 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 @@ -1689,6 +1720,7 @@ class AsyncElasticsearch(object): ): """ Allows to use the Mustache language to pre-render a search definition. + ``_ :arg body: The search definition template and its params @@ -1755,6 +1787,7 @@ class AsyncElasticsearch(object): """ Returns information and statistics about terms in the fields of a particular document. + ``_ :arg index: The index in which the document resides. @@ -1813,6 +1846,7 @@ class AsyncElasticsearch(object): 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 @@ -1905,6 +1939,7 @@ class AsyncElasticsearch(object): """ 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 @@ -2004,6 +2039,7 @@ class AsyncElasticsearch(object): """ Changes the number of requests per second for a particular Update By Query operation. + ``_ :arg task_id: The task id to rethrottle @@ -2024,6 +2060,7 @@ class AsyncElasticsearch(object): async def get_script_context(self, params=None, headers=None): """ Returns all script contexts. + ``_ """ return await self.transport.perform_request( @@ -2034,6 +2071,7 @@ class AsyncElasticsearch(object): async def get_script_languages(self, params=None, headers=None): """ Returns available script types, languages and contexts + ``_ """ return await self.transport.perform_request( @@ -2044,6 +2082,7 @@ class AsyncElasticsearch(object): async def close_point_in_time(self, body=None, params=None, headers=None): """ Close a point in time + ``_ :arg body: a point-in-time id to close @@ -2058,6 +2097,7 @@ class AsyncElasticsearch(object): async def open_point_in_time(self, index=None, params=None, headers=None): """ Open a point in time that can be used in subsequent searches + ``_ :arg index: A comma-separated list of index names to open point diff --git a/elasticsearch/_async/client/__init__.pyi b/elasticsearch/_async/client/__init__.pyi index 1eeed6fe..47052a4d 100644 --- a/elasticsearch/_async/client/__init__.pyi +++ b/elasticsearch/_async/client/__init__.pyi @@ -102,6 +102,7 @@ class AsyncElasticsearch(object): # AUTO-GENERATED-API-DEFINITIONS # async def ping( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -111,10 +112,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def info( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -124,12 +126,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def create( self, index: Any, id: Any, + *, body: Any, doc_type: Optional[Any] = ..., pipeline: Optional[Any] = ..., @@ -148,11 +151,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def index( self, index: Any, + *, body: Any, doc_type: Optional[Any] = ..., id: Optional[Any] = ..., @@ -176,10 +180,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def bulk( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -201,10 +206,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def clear_scroll( self, + *, body: Optional[Any] = ..., scroll_id: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -216,10 +222,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def count( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -246,12 +253,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., if_primary_term: Optional[Any] = ..., if_seq_no: Optional[Any] = ..., @@ -270,11 +278,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_by_query( self, index: Any, + *, body: Any, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -319,11 +328,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_by_query_rethrottle( self, task_id: Any, + *, requests_per_second: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -334,11 +344,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_script( self, id: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -350,12 +361,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def exists( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -376,12 +388,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def exists_source( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -401,12 +414,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def explain( self, index: Any, id: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -430,10 +444,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def field_caps( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -450,12 +465,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -476,11 +492,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_script( self, id: Any, + *, master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -491,12 +508,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_source( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -516,10 +534,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def mget( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -540,10 +559,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def msearch( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -563,10 +583,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def msearch_template( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -584,10 +605,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def mtermvectors( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -612,11 +634,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_script( self, id: Any, + *, body: Any, context: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -630,10 +653,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def rank_eval( self, + *, body: Any, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -649,10 +673,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def reindex( self, + *, body: Any, max_docs: Optional[Any] = ..., refresh: Optional[Any] = ..., @@ -671,11 +696,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def reindex_rethrottle( self, task_id: Any, + *, requests_per_second: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -686,10 +712,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def render_search_template( self, + *, body: Optional[Any] = ..., id: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -701,10 +728,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def scripts_painless_execute( self, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -715,10 +743,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def scroll( self, + *, body: Optional[Any] = ..., scroll_id: Optional[Any] = ..., rest_total_hits_as_int: Optional[Any] = ..., @@ -732,10 +761,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def search( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -790,10 +820,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def search_shards( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -810,10 +841,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def search_template( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -839,11 +871,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def termvectors( self, index: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., id: Optional[Any] = ..., @@ -867,12 +900,13 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update( self, index: Any, id: Any, + *, body: Any, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -896,11 +930,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_by_query( self, index: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -947,11 +982,12 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_by_query_rethrottle( self, task_id: Any, + *, requests_per_second: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -962,10 +998,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_script_context( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -975,10 +1012,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_script_languages( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -988,10 +1026,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def close_point_in_time( self, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1002,10 +1041,11 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def open_point_in_time( self, + *, index: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -1021,5 +1061,5 @@ class AsyncElasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/async_search.py b/elasticsearch/_async/client/async_search.py index bce2d77d..dc671475 100644 --- a/elasticsearch/_async/client/async_search.py +++ b/elasticsearch/_async/client/async_search.py @@ -24,6 +24,7 @@ class AsyncSearchClient(NamespacedClient): """ 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,6 +41,7 @@ class AsyncSearchClient(NamespacedClient): """ Retrieves the results of a previously submitted async search request given its ID. + ``_ :arg id: The async search ID @@ -103,6 +105,7 @@ class AsyncSearchClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/async_search.pyi b/elasticsearch/_async/client/async_search.pyi index 2b4acea0..0b7ca616 100644 --- a/elasticsearch/_async/client/async_search.pyi +++ b/elasticsearch/_async/client/async_search.pyi @@ -22,6 +22,7 @@ class AsyncSearchClient(NamespacedClient): async def delete( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class AsyncSearchClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get( self, id: Any, + *, keep_alive: Optional[Any] = ..., typed_keys: Optional[Any] = ..., wait_for_completion_timeout: Optional[Any] = ..., @@ -48,10 +50,11 @@ class AsyncSearchClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def submit( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -104,5 +107,5 @@ class AsyncSearchClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py index b9452379..918899a5 100644 --- a/elasticsearch/_async/client/autoscaling.py +++ b/elasticsearch/_async/client/autoscaling.py @@ -24,6 +24,7 @@ class AutoscalingClient(NamespacedClient): """ Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed. + ``_ """ return await self.transport.perform_request( @@ -34,6 +35,7 @@ class AutoscalingClient(NamespacedClient): async def delete_autoscaling_policy(self, name, params=None, headers=None): """ Deletes an autoscaling policy. + ``_ :arg name: the name of the autoscaling policy @@ -52,6 +54,7 @@ class AutoscalingClient(NamespacedClient): async def get_autoscaling_policy(self, name, params=None, headers=None): """ Retrieves an autoscaling policy. + ``_ :arg name: the name of the autoscaling policy @@ -70,6 +73,7 @@ class AutoscalingClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/autoscaling.pyi b/elasticsearch/_async/client/autoscaling.pyi index 4104e185..283f3764 100644 --- a/elasticsearch/_async/client/autoscaling.pyi +++ b/elasticsearch/_async/client/autoscaling.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class AutoscalingClient(NamespacedClient): async def get_autoscaling_decision( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,11 +31,12 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_autoscaling_policy( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -44,11 +46,12 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_autoscaling_policy( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -58,11 +61,12 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_autoscaling_policy( self, name: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -73,5 +77,5 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/cat.py b/elasticsearch/_async/client/cat.py index c96bd409..2e32dc97 100644 --- a/elasticsearch/_async/client/cat.py +++ b/elasticsearch/_async/client/cat.py @@ -24,6 +24,7 @@ class CatClient(NamespacedClient): """ Shows information about currently configured aliases to indices including filter and routing infos. + ``_ :arg name: A comma-separated list of alias names to return @@ -49,6 +50,7 @@ class CatClient(NamespacedClient): """ 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 @@ -79,6 +81,7 @@ class CatClient(NamespacedClient): """ 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 @@ -99,6 +102,7 @@ class CatClient(NamespacedClient): 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, @@ -120,6 +124,7 @@ class CatClient(NamespacedClient): async def help(self, params=None, headers=None): """ Returns help for the Cat APIs. + ``_ :arg help: Return help information @@ -149,6 +154,7 @@ class CatClient(NamespacedClient): """ 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 @@ -187,6 +193,7 @@ class CatClient(NamespacedClient): 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, @@ -220,6 +227,7 @@ class CatClient(NamespacedClient): 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 @@ -250,6 +258,7 @@ class CatClient(NamespacedClient): 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 @@ -280,6 +289,7 @@ class CatClient(NamespacedClient): 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 @@ -308,6 +318,7 @@ class CatClient(NamespacedClient): 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 @@ -330,6 +341,7 @@ class CatClient(NamespacedClient): 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, @@ -355,6 +367,7 @@ class CatClient(NamespacedClient): """ 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- @@ -385,6 +398,7 @@ class CatClient(NamespacedClient): """ 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 @@ -410,6 +424,7 @@ class CatClient(NamespacedClient): 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, @@ -432,6 +447,7 @@ class CatClient(NamespacedClient): 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, @@ -454,6 +470,7 @@ class CatClient(NamespacedClient): 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, @@ -478,6 +495,7 @@ class CatClient(NamespacedClient): 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 @@ -519,6 +537,7 @@ class CatClient(NamespacedClient): """ 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 @@ -548,6 +567,7 @@ class CatClient(NamespacedClient): 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 @@ -571,6 +591,7 @@ class CatClient(NamespacedClient): 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 @@ -602,6 +623,7 @@ class CatClient(NamespacedClient): 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 @@ -642,6 +664,7 @@ class CatClient(NamespacedClient): 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 @@ -685,6 +708,7 @@ class CatClient(NamespacedClient): 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 @@ -723,6 +747,7 @@ class CatClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/cat.pyi b/elasticsearch/_async/client/cat.pyi index f66a437e..e9c4a49b 100644 --- a/elasticsearch/_async/client/cat.pyi +++ b/elasticsearch/_async/client/cat.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class CatClient(NamespacedClient): async def aliases( self, + *, name: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., format: Optional[Any] = ..., @@ -37,10 +38,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def allocation( self, + *, node_id: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -58,10 +60,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def count( self, + *, index: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -76,10 +79,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def health( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -95,10 +99,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def help( self, + *, help: Optional[Any] = ..., s: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -110,10 +115,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def indices( self, + *, index: Optional[Any] = ..., bytes: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -136,10 +142,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def master( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -155,10 +162,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def nodes( self, + *, bytes: Optional[Any] = ..., format: Optional[Any] = ..., full_id: Optional[Any] = ..., @@ -177,10 +185,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def recovery( self, + *, index: Optional[Any] = ..., active_only: Optional[Any] = ..., bytes: Optional[Any] = ..., @@ -199,10 +208,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def shards( self, + *, index: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -221,10 +231,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def segments( self, + *, index: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -240,10 +251,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def pending_tasks( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -260,10 +272,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def thread_pool( self, + *, thread_pool_patterns: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -281,10 +294,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def fielddata( self, + *, fields: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -300,10 +314,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def plugins( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -319,10 +334,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def nodeattrs( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -338,10 +354,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def repositories( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -357,10 +374,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def snapshots( self, + *, repository: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -378,10 +396,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def tasks( self, + *, actions: Optional[Any] = ..., detailed: Optional[Any] = ..., format: Optional[Any] = ..., @@ -400,10 +419,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def templates( self, + *, name: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -420,10 +440,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def ml_data_frame_analytics( self, + *, id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., bytes: Optional[Any] = ..., @@ -441,10 +462,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def ml_datafeeds( self, + *, datafeed_id: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -462,10 +484,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def ml_jobs( self, + *, job_id: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -484,10 +507,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def ml_trained_models( self, + *, model_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., bytes: Optional[Any] = ..., @@ -507,10 +531,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def transforms( self, + *, transform_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., format: Optional[Any] = ..., @@ -529,5 +554,5 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/ccr.py b/elasticsearch/_async/client/ccr.py index a4e8d02a..683f55ce 100644 --- a/elasticsearch/_async/client/ccr.py +++ b/elasticsearch/_async/client/ccr.py @@ -23,6 +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,6 +42,7 @@ class CcrClient(NamespacedClient): 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 @@ -69,6 +71,7 @@ class CcrClient(NamespacedClient): """ 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` @@ -86,6 +89,7 @@ class CcrClient(NamespacedClient): """ 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` @@ -102,6 +106,7 @@ class CcrClient(NamespacedClient): 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 @@ -128,6 +133,7 @@ class CcrClient(NamespacedClient): """ Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + ``_ :arg name: The name of the auto follow pattern. @@ -144,6 +150,7 @@ class CcrClient(NamespacedClient): """ 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 @@ -165,6 +172,7 @@ class CcrClient(NamespacedClient): 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. @@ -186,6 +194,7 @@ class CcrClient(NamespacedClient): 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. @@ -207,6 +216,7 @@ class CcrClient(NamespacedClient): async def stats(self, params=None, headers=None): """ Gets all stats related to cross-cluster replication. + ``_ """ return await self.transport.perform_request( @@ -218,6 +228,7 @@ class CcrClient(NamespacedClient): """ 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 @@ -237,6 +248,7 @@ class CcrClient(NamespacedClient): 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 @@ -256,6 +268,7 @@ class CcrClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/ccr.pyi b/elasticsearch/_async/client/ccr.pyi index ee0a7a02..d2c085a2 100644 --- a/elasticsearch/_async/client/ccr.pyi +++ b/elasticsearch/_async/client/ccr.pyi @@ -22,6 +22,7 @@ class CcrClient(NamespacedClient): async def delete_auto_follow_pattern( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def follow( self, index: Any, + *, body: Any, wait_for_active_shards: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -47,11 +49,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def follow_info( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -61,11 +64,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def follow_stats( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -75,11 +79,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def forget_follower( self, index: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -90,10 +95,11 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_auto_follow_pattern( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -104,11 +110,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def pause_follow( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -118,11 +125,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_auto_follow_pattern( self, name: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -133,11 +141,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def resume_follow( self, index: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -148,10 +157,11 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stats( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -161,11 +171,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def unfollow( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -175,11 +186,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def pause_auto_follow_pattern( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -189,11 +201,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def resume_auto_follow_pattern( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -203,5 +216,5 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/cluster.py b/elasticsearch/_async/client/cluster.py index 951c8601..8d817156 100644 --- a/elasticsearch/_async/client/cluster.py +++ b/elasticsearch/_async/client/cluster.py @@ -35,6 +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 @@ -74,6 +75,7 @@ class ClusterClient(NamespacedClient): """ 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 @@ -97,6 +99,7 @@ class ClusterClient(NamespacedClient): 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 @@ -136,6 +139,7 @@ class ClusterClient(NamespacedClient): 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 @@ -161,6 +165,7 @@ class ClusterClient(NamespacedClient): 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`, @@ -186,6 +191,7 @@ class ClusterClient(NamespacedClient): async def get_settings(self, params=None, headers=None): """ Returns cluster settings. + ``_ :arg flat_settings: Return settings in flat format (default: @@ -204,6 +210,7 @@ class ClusterClient(NamespacedClient): 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` @@ -225,6 +232,7 @@ class ClusterClient(NamespacedClient): async def remote_info(self, params=None, headers=None): """ Returns the information about configured remote clusters. + ``_ """ return await self.transport.perform_request( @@ -235,6 +243,7 @@ class ClusterClient(NamespacedClient): 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 @@ -256,6 +265,7 @@ class ClusterClient(NamespacedClient): async def delete_component_template(self, name, params=None, headers=None): """ Deletes a component template + ``_ :arg name: The name of the template @@ -276,6 +286,7 @@ class ClusterClient(NamespacedClient): 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 @@ -295,6 +306,7 @@ class ClusterClient(NamespacedClient): 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 @@ -320,6 +332,7 @@ class ClusterClient(NamespacedClient): 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 @@ -342,6 +355,7 @@ class ClusterClient(NamespacedClient): 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 @@ -359,6 +373,7 @@ class ClusterClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/cluster.pyi b/elasticsearch/_async/client/cluster.pyi index 59b4a8f3..c70bd548 100644 --- a/elasticsearch/_async/client/cluster.pyi +++ b/elasticsearch/_async/client/cluster.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class ClusterClient(NamespacedClient): async def health( self, + *, index: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., level: Optional[Any] = ..., @@ -42,10 +43,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def pending_tasks( self, + *, local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -57,10 +59,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def state( self, + *, metric: Optional[Any] = ..., index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -80,10 +83,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stats( self, + *, node_id: Optional[Any] = ..., flat_settings: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -96,10 +100,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def reroute( self, + *, body: Optional[Any] = ..., dry_run: Optional[Any] = ..., explain: Optional[Any] = ..., @@ -116,10 +121,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_settings( self, + *, flat_settings: Optional[Any] = ..., include_defaults: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -133,10 +139,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_settings( self, + *, body: Any, flat_settings: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -150,10 +157,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def remote_info( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -163,10 +171,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def allocation_explain( self, + *, body: Optional[Any] = ..., include_disk_info: Optional[Any] = ..., include_yes_decisions: Optional[Any] = ..., @@ -179,11 +188,12 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_component_template( self, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -195,10 +205,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_component_template( self, + *, name: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -211,11 +222,12 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_component_template( self, name: Any, + *, body: Any, create: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -229,11 +241,12 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def exists_component_template( self, name: Any, + *, local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -245,10 +258,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def delete_voting_config_exclusions( self, + *, wait_for_removal: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -259,10 +273,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def post_voting_config_exclusions( self, + *, node_ids: Optional[Any] = ..., node_names: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -275,5 +290,5 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/dangling_indices.py b/elasticsearch/_async/client/dangling_indices.py index 1535dc5e..34b21bce 100644 --- a/elasticsearch/_async/client/dangling_indices.py +++ b/elasticsearch/_async/client/dangling_indices.py @@ -23,6 +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 @@ -45,6 +46,7 @@ class DanglingIndicesClient(NamespacedClient): 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 @@ -64,6 +66,7 @@ class DanglingIndicesClient(NamespacedClient): async def list_dangling_indices(self, params=None, headers=None): """ Returns all dangling indices. + ``_ """ return await self.transport.perform_request( diff --git a/elasticsearch/_async/client/dangling_indices.pyi b/elasticsearch/_async/client/dangling_indices.pyi index 980922bb..5cc699d5 100644 --- a/elasticsearch/_async/client/dangling_indices.pyi +++ b/elasticsearch/_async/client/dangling_indices.pyi @@ -22,6 +22,7 @@ class DanglingIndicesClient(NamespacedClient): async def delete_dangling_index( self, index_uuid: Any, + *, accept_data_loss: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -34,11 +35,12 @@ class DanglingIndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def import_dangling_index( self, index_uuid: Any, + *, accept_data_loss: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -51,10 +53,11 @@ class DanglingIndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def list_dangling_indices( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -64,5 +67,5 @@ class DanglingIndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/data_frame.py b/elasticsearch/_async/client/data_frame.py index 12bf19fa..f52391af 100644 --- a/elasticsearch/_async/client/data_frame.py +++ b/elasticsearch/_async/client/data_frame.py @@ -72,6 +72,7 @@ class Data_FrameClient(NamespacedClient): "GET", _make_path("_data_frame", "transforms", transform_id, "_stats"), params=params, + headers=headers, ) @query_params() diff --git a/elasticsearch/_async/client/data_frame.pyi b/elasticsearch/_async/client/data_frame.pyi index f1c6d4ff..3b7ed9d7 100644 --- a/elasticsearch/_async/client/data_frame.pyi +++ b/elasticsearch/_async/client/data_frame.pyi @@ -22,6 +22,7 @@ class Data_FrameClient(NamespacedClient): async def delete_data_frame_transform( self, transform_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -35,6 +36,7 @@ class Data_FrameClient(NamespacedClient): ) -> Any: ... async def get_data_frame_transform( self, + *, transform_id: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., @@ -52,6 +54,7 @@ class Data_FrameClient(NamespacedClient): async def get_data_frame_transform_stats( self, transform_id: Optional[Any], + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -65,6 +68,7 @@ class Data_FrameClient(NamespacedClient): ) -> Any: ... async def preview_data_frame_transform( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -80,6 +84,7 @@ class Data_FrameClient(NamespacedClient): async def put_data_frame_transform( self, transform_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -95,6 +100,7 @@ class Data_FrameClient(NamespacedClient): async def start_data_frame_transform( self, transform_id: Any, + *, timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -110,6 +116,7 @@ class Data_FrameClient(NamespacedClient): async def stop_data_frame_transform( self, transform_id: Any, + *, timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., diff --git a/elasticsearch/_async/client/deprecation.pyi b/elasticsearch/_async/client/deprecation.pyi index f7796666..ebfaf6b6 100644 --- a/elasticsearch/_async/client/deprecation.pyi +++ b/elasticsearch/_async/client/deprecation.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class DeprecationClient(NamespacedClient): async def info( self, + *, index: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., diff --git a/elasticsearch/_async/client/enrich.py b/elasticsearch/_async/client/enrich.py index d034d3ec..02de6f5d 100644 --- a/elasticsearch/_async/client/enrich.py +++ b/elasticsearch/_async/client/enrich.py @@ -23,6 +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,6 +42,7 @@ class EnrichClient(NamespacedClient): 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 @@ -61,6 +63,7 @@ class EnrichClient(NamespacedClient): 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,6 +76,7 @@ class EnrichClient(NamespacedClient): async def put_policy(self, name, body, params=None, headers=None): """ Creates a new enrich policy. + ``_ :arg name: The name of the enrich policy @@ -95,6 +99,7 @@ class EnrichClient(NamespacedClient): """ Gets enrich coordinator statistics and information about enrich policies that are currently executing. + ``_ """ return await self.transport.perform_request( diff --git a/elasticsearch/_async/client/enrich.pyi b/elasticsearch/_async/client/enrich.pyi index 8c4beea0..a0c12b2f 100644 --- a/elasticsearch/_async/client/enrich.pyi +++ b/elasticsearch/_async/client/enrich.pyi @@ -22,6 +22,7 @@ class EnrichClient(NamespacedClient): async def delete_policy( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def execute_policy( self, name: Any, + *, wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -46,10 +48,11 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_policy( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -60,11 +63,12 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_policy( self, name: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -75,10 +79,11 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stats( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -88,5 +93,5 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/eql.py b/elasticsearch/_async/client/eql.py index 3f2ff9fe..d5e72789 100644 --- a/elasticsearch/_async/client/eql.py +++ b/elasticsearch/_async/client/eql.py @@ -23,6 +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 @@ -53,6 +54,7 @@ class EqlClient(NamespacedClient): """ 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,6 +71,7 @@ class EqlClient(NamespacedClient): """ Returns async results from previously executed Event Query Language (EQL) search + ``_ :arg id: The async search ID diff --git a/elasticsearch/_async/client/eql.pyi b/elasticsearch/_async/client/eql.pyi index 8684e633..1eec5ca5 100644 --- a/elasticsearch/_async/client/eql.pyi +++ b/elasticsearch/_async/client/eql.pyi @@ -22,6 +22,7 @@ class EqlClient(NamespacedClient): async def search( self, index: Any, + *, body: Any, keep_alive: Optional[Any] = ..., keep_on_completion: Optional[Any] = ..., @@ -35,11 +36,12 @@ class EqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -49,11 +51,12 @@ class EqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get( self, id: Any, + *, keep_alive: Optional[Any] = ..., wait_for_completion_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -65,5 +68,5 @@ class EqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/graph.py b/elasticsearch/_async/client/graph.py index a0e16825..27fae983 100644 --- a/elasticsearch/_async/client/graph.py +++ b/elasticsearch/_async/client/graph.py @@ -24,6 +24,7 @@ class GraphClient(NamespacedClient): """ 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 diff --git a/elasticsearch/_async/client/graph.pyi b/elasticsearch/_async/client/graph.pyi index ff86f604..6d19d539 100644 --- a/elasticsearch/_async/client/graph.pyi +++ b/elasticsearch/_async/client/graph.pyi @@ -22,6 +22,7 @@ class GraphClient(NamespacedClient): async def explore( self, index: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., routing: Optional[Any] = ..., @@ -35,5 +36,5 @@ class GraphClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/ilm.py b/elasticsearch/_async/client/ilm.py index 5ff05bd8..7ebb3847 100644 --- a/elasticsearch/_async/client/ilm.py +++ b/elasticsearch/_async/client/ilm.py @@ -24,6 +24,7 @@ class IlmClient(NamespacedClient): """ Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. + ``_ :arg policy: The name of the index lifecycle policy @@ -43,6 +44,7 @@ class IlmClient(NamespacedClient): """ 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 @@ -63,6 +65,7 @@ class IlmClient(NamespacedClient): """ Returns the specified policy definition. Includes the policy version and last modified date. + ``_ :arg policy: The name of the index lifecycle policy @@ -75,6 +78,7 @@ class IlmClient(NamespacedClient): async def get_status(self, params=None, headers=None): """ Retrieves the current index lifecycle management (ILM) status. + ``_ """ return await self.transport.perform_request( @@ -85,6 +89,7 @@ class IlmClient(NamespacedClient): 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 @@ -106,6 +111,7 @@ class IlmClient(NamespacedClient): 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 @@ -126,6 +132,7 @@ class IlmClient(NamespacedClient): 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,6 +148,7 @@ class IlmClient(NamespacedClient): 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 @@ -157,6 +165,7 @@ class IlmClient(NamespacedClient): async def start(self, params=None, headers=None): """ Start the index lifecycle management (ILM) plugin. + ``_ """ return await self.transport.perform_request( @@ -168,6 +177,7 @@ class IlmClient(NamespacedClient): """ Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + ``_ """ return await self.transport.perform_request( diff --git a/elasticsearch/_async/client/ilm.pyi b/elasticsearch/_async/client/ilm.pyi index 40d526c0..99afa7a6 100644 --- a/elasticsearch/_async/client/ilm.pyi +++ b/elasticsearch/_async/client/ilm.pyi @@ -22,6 +22,7 @@ class IlmClient(NamespacedClient): async def delete_lifecycle( self, policy: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def explain_lifecycle( self, index: Any, + *, only_errors: Optional[Any] = ..., only_managed: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -47,10 +49,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_lifecycle( self, + *, policy: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -61,10 +64,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -74,11 +78,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def move_to_step( self, index: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -89,11 +94,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_lifecycle( self, policy: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -104,11 +110,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def remove_policy( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -118,11 +125,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def retry( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -132,10 +140,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def start( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -145,10 +154,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stop( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -158,5 +168,5 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/indices.py b/elasticsearch/_async/client/indices.py index 07214a28..4e9df53a 100644 --- a/elasticsearch/_async/client/indices.py +++ b/elasticsearch/_async/client/indices.py @@ -24,6 +24,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -42,6 +43,7 @@ class IndicesClient(NamespacedClient): 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 @@ -69,6 +71,7 @@ class IndicesClient(NamespacedClient): 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 @@ -101,6 +104,7 @@ class IndicesClient(NamespacedClient): 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 @@ -124,6 +128,7 @@ class IndicesClient(NamespacedClient): 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 @@ -160,6 +165,7 @@ class IndicesClient(NamespacedClient): 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 @@ -198,6 +204,7 @@ class IndicesClient(NamespacedClient): async def open(self, index, params=None, headers=None): """ Opens an index. + ``_ :arg index: A comma separated list of indices to open @@ -232,6 +239,7 @@ class IndicesClient(NamespacedClient): async def close(self, index, params=None, headers=None): """ Closes an index. + ``_ :arg index: A comma separated list of indices to close @@ -265,6 +273,7 @@ class IndicesClient(NamespacedClient): async def delete(self, index, params=None, headers=None): """ Deletes an index. + ``_ :arg index: A comma-separated list of indices to delete; use @@ -297,6 +306,7 @@ class IndicesClient(NamespacedClient): 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 @@ -326,6 +336,7 @@ class IndicesClient(NamespacedClient): """ Returns information about whether a particular document type exists. (DEPRECATED) + ``_ :arg index: A comma-separated list of index names; use `_all` to @@ -367,6 +378,7 @@ class IndicesClient(NamespacedClient): ): """ Updates the index mappings. + ``_ :arg body: The mapping definition @@ -414,6 +426,7 @@ class IndicesClient(NamespacedClient): 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 @@ -452,6 +465,7 @@ class IndicesClient(NamespacedClient): ): """ Returns mapping for one or more fields. + ``_ :arg fields: A comma-separated list of fields @@ -486,6 +500,7 @@ class IndicesClient(NamespacedClient): 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 @@ -513,6 +528,7 @@ class IndicesClient(NamespacedClient): 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 @@ -540,6 +556,7 @@ class IndicesClient(NamespacedClient): 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 @@ -564,6 +581,7 @@ class IndicesClient(NamespacedClient): async def update_aliases(self, body, params=None, headers=None): """ Updates index aliases. + ``_ :arg body: The definition of `actions` to perform @@ -581,6 +599,7 @@ class IndicesClient(NamespacedClient): async def delete_alias(self, index, name, params=None, headers=None): """ Deletes an alias. + ``_ :arg index: A comma-separated list of index names (supports @@ -602,6 +621,7 @@ class IndicesClient(NamespacedClient): async def put_template(self, name, body, params=None, headers=None): """ Creates or updates an index template. + ``_ :arg name: The name of the template @@ -631,6 +651,7 @@ class IndicesClient(NamespacedClient): 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 @@ -652,6 +673,7 @@ class IndicesClient(NamespacedClient): 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 @@ -672,6 +694,7 @@ class IndicesClient(NamespacedClient): async def delete_template(self, name, params=None, headers=None): """ Deletes an index template. + ``_ :arg name: The name of the template @@ -697,6 +720,7 @@ class IndicesClient(NamespacedClient): 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 @@ -734,6 +758,7 @@ class IndicesClient(NamespacedClient): async def put_settings(self, body, index=None, params=None, headers=None): """ Updates the index settings. + ``_ :arg body: The index settings to be updated @@ -781,6 +806,7 @@ class IndicesClient(NamespacedClient): 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 @@ -824,6 +850,7 @@ class IndicesClient(NamespacedClient): 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 @@ -861,6 +888,7 @@ class IndicesClient(NamespacedClient): ): """ Allows a user to validate a potentially expensive query without executing it. + ``_ :arg body: The query definition specified with the Query DSL @@ -914,6 +942,7 @@ class IndicesClient(NamespacedClient): 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 @@ -940,6 +969,7 @@ class IndicesClient(NamespacedClient): 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 @@ -963,6 +993,7 @@ class IndicesClient(NamespacedClient): 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 @@ -988,6 +1019,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1010,6 +1042,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1036,6 +1069,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1067,6 +1101,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1096,6 +1131,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1128,6 +1164,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1166,6 +1203,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1206,6 +1244,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1241,6 +1280,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1268,6 +1308,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1295,6 +1336,7 @@ class IndicesClient(NamespacedClient): async def create_data_stream(self, name, params=None, headers=None): """ Creates a data stream + ``_ :arg name: The name of the data stream @@ -1310,6 +1352,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1326,6 +1369,7 @@ class IndicesClient(NamespacedClient): async def delete_index_template(self, name, params=None, headers=None): """ Deletes an index template. + ``_ :arg name: The name of the template @@ -1346,6 +1390,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1367,6 +1412,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1385,6 +1431,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1412,6 +1459,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1440,6 +1488,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1453,6 +1502,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1477,6 +1527,7 @@ class IndicesClient(NamespacedClient): async def resolve_index(self, name, params=None, headers=None): """ Returns information about any matching indices, aliases, and data streams + ``_ :arg name: A comma-separated list of names or wildcard @@ -1502,6 +1553,7 @@ class IndicesClient(NamespacedClient): async def add_block(self, index, block, params=None, headers=None): """ Adds a block to an index. + ``_ :arg index: A comma separated list of indices to add a block to @@ -1530,6 +1582,7 @@ class IndicesClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/indices.pyi b/elasticsearch/_async/client/indices.pyi index 8ae2dd0e..82ba811d 100644 --- a/elasticsearch/_async/client/indices.pyi +++ b/elasticsearch/_async/client/indices.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class IndicesClient(NamespacedClient): async def analyze( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -32,10 +33,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def refresh( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -49,10 +51,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def flush( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -68,11 +71,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def create( self, index: Any, + *, body: Optional[Any] = ..., include_type_name: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -87,12 +91,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def clone( self, index: Any, target: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -106,11 +111,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., flat_settings: Optional[Any] = ..., @@ -128,11 +134,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def open( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -148,11 +155,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def close( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -168,11 +176,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -187,11 +196,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def exists( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., flat_settings: Optional[Any] = ..., @@ -207,12 +217,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def exists_type( self, index: Any, doc_type: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -226,10 +237,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def put_mapping( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -249,10 +261,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_mapping( self, + *, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -270,11 +283,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_field_mapping( self, fields: Any, + *, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -292,12 +306,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_alias( self, index: Any, name: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -310,11 +325,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def exists_alias( self, name: Any, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -329,10 +345,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def get_alias( self, + *, index: Optional[Any] = ..., name: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -348,10 +365,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_aliases( self, + *, body: Any, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -364,12 +382,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_alias( self, index: Any, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -381,11 +400,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_template( self, name: Any, + *, body: Any, create: Optional[Any] = ..., include_type_name: Optional[Any] = ..., @@ -400,11 +420,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def exists_template( self, name: Any, + *, flat_settings: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -417,10 +438,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def get_template( self, + *, name: Optional[Any] = ..., flat_settings: Optional[Any] = ..., include_type_name: Optional[Any] = ..., @@ -435,11 +457,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_template( self, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -451,10 +474,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_settings( self, + *, index: Optional[Any] = ..., name: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -473,10 +497,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_settings( self, + *, body: Any, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -495,10 +520,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stats( self, + *, index: Optional[Any] = ..., metric: Optional[Any] = ..., completion_fields: Optional[Any] = ..., @@ -520,10 +546,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def segments( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -538,10 +565,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def validate_query( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -566,10 +594,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def clear_cache( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -587,10 +616,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def recovery( self, + *, index: Optional[Any] = ..., active_only: Optional[Any] = ..., detailed: Optional[Any] = ..., @@ -603,10 +633,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def upgrade( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -622,10 +653,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_upgrade( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -639,10 +671,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def flush_synced( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -656,10 +689,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def shard_stores( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -674,10 +708,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def forcemerge( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -694,12 +729,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def shrink( self, index: Any, target: Any, + *, body: Optional[Any] = ..., copy_settings: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -714,12 +750,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def split( self, index: Any, target: Any, + *, body: Optional[Any] = ..., copy_settings: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -734,11 +771,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def rollover( self, alias: Any, + *, body: Optional[Any] = ..., new_index: Optional[Any] = ..., dry_run: Optional[Any] = ..., @@ -755,11 +793,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def freeze( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -775,11 +814,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def unfreeze( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -795,11 +835,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def reload_search_analyzers( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -812,11 +853,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def create_data_stream( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -826,11 +868,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_data_stream( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -840,11 +883,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_index_template( self, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -856,11 +900,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def exists_index_template( self, name: Any, + *, flat_settings: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -873,10 +918,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... async def get_index_template( self, + *, name: Optional[Any] = ..., flat_settings: Optional[Any] = ..., local: Optional[Any] = ..., @@ -890,11 +936,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_index_template( self, name: Any, + *, body: Any, cause: Optional[Any] = ..., create: Optional[Any] = ..., @@ -908,11 +955,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def simulate_index_template( self, name: Any, + *, body: Optional[Any] = ..., cause: Optional[Any] = ..., create: Optional[Any] = ..., @@ -926,10 +974,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_data_stream( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -940,10 +989,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def simulate_template( self, + *, body: Optional[Any] = ..., name: Optional[Any] = ..., cause: Optional[Any] = ..., @@ -958,11 +1008,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def resolve_index( self, name: Any, + *, expand_wildcards: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -973,12 +1024,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def add_block( self, index: Any, block: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -993,10 +1045,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def data_streams_stats( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1007,5 +1060,5 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/ingest.py b/elasticsearch/_async/client/ingest.py index 058855bc..17fef146 100644 --- a/elasticsearch/_async/client/ingest.py +++ b/elasticsearch/_async/client/ingest.py @@ -23,6 +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 @@ -38,6 +39,7 @@ class IngestClient(NamespacedClient): async def put_pipeline(self, id, body, params=None, headers=None): """ Creates or updates a pipeline. + ``_ :arg id: Pipeline ID @@ -62,6 +64,7 @@ class IngestClient(NamespacedClient): async def delete_pipeline(self, id, params=None, headers=None): """ Deletes a pipeline. + ``_ :arg id: Pipeline ID @@ -83,6 +86,7 @@ class IngestClient(NamespacedClient): async def simulate(self, body, id=None, params=None, headers=None): """ Allows to simulate a pipeline with example documents. + ``_ :arg body: The simulate definition @@ -105,6 +109,7 @@ class IngestClient(NamespacedClient): async def processor_grok(self, params=None, headers=None): """ Returns a list of the built-in patterns. + ``_ """ return await self.transport.perform_request( diff --git a/elasticsearch/_async/client/ingest.pyi b/elasticsearch/_async/client/ingest.pyi index a123db5c..49b5e6f9 100644 --- a/elasticsearch/_async/client/ingest.pyi +++ b/elasticsearch/_async/client/ingest.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class IngestClient(NamespacedClient): async def get_pipeline( self, + *, id: Optional[Any] = ..., master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -32,11 +33,12 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_pipeline( self, id: Any, + *, body: Any, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -49,11 +51,12 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_pipeline( self, id: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -65,10 +68,11 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def simulate( self, + *, body: Any, id: Optional[Any] = ..., verbose: Optional[Any] = ..., @@ -81,10 +85,11 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def processor_grok( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -94,5 +99,5 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/license.py b/elasticsearch/_async/client/license.py index 6754004f..79c978f3 100644 --- a/elasticsearch/_async/client/license.py +++ b/elasticsearch/_async/client/license.py @@ -23,6 +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( @@ -33,6 +34,7 @@ class LicenseClient(NamespacedClient): async def get(self, params=None, headers=None): """ Retrieves licensing information for the cluster + ``_ :arg accept_enterprise: If the active license is an enterprise @@ -48,6 +50,7 @@ class LicenseClient(NamespacedClient): 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( @@ -58,6 +61,7 @@ class LicenseClient(NamespacedClient): 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( @@ -68,6 +72,7 @@ class LicenseClient(NamespacedClient): async def post(self, body=None, params=None, headers=None): """ Updates the license for the cluster. + ``_ :arg body: licenses to be installed @@ -82,6 +87,7 @@ class LicenseClient(NamespacedClient): async def post_start_basic(self, params=None, headers=None): """ Starts an indefinite basic license. + ``_ :arg acknowledge: whether the user has acknowledged acknowledge @@ -95,6 +101,7 @@ class LicenseClient(NamespacedClient): async def post_start_trial(self, params=None, headers=None): """ starts a limited time trial license. + ``_ :arg acknowledge: whether the user has acknowledged acknowledge diff --git a/elasticsearch/_async/client/license.pyi b/elasticsearch/_async/client/license.pyi index 6f720cfa..c2306607 100644 --- a/elasticsearch/_async/client/license.pyi +++ b/elasticsearch/_async/client/license.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class LicenseClient(NamespacedClient): async def delete( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,10 +31,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get( self, + *, accept_enterprise: Optional[Any] = ..., local: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -45,10 +47,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_basic_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -58,10 +61,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_trial_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -71,10 +75,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def post( self, + *, body: Optional[Any] = ..., acknowledge: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -86,10 +91,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def post_start_basic( self, + *, acknowledge: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -100,10 +106,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def post_start_trial( self, + *, acknowledge: Optional[Any] = ..., doc_type: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -115,5 +122,5 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/migration.py b/elasticsearch/_async/client/migration.py index f4cc5eff..50cfc243 100644 --- a/elasticsearch/_async/client/migration.py +++ b/elasticsearch/_async/client/migration.py @@ -25,6 +25,7 @@ class MigrationClient(NamespacedClient): 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/migration.pyi b/elasticsearch/_async/client/migration.pyi index bed3058c..230d345a 100644 --- a/elasticsearch/_async/client/migration.pyi +++ b/elasticsearch/_async/client/migration.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class MigrationClient(NamespacedClient): async def deprecations( self, + *, index: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -31,5 +32,5 @@ class MigrationClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/ml.py b/elasticsearch/_async/client/ml.py index c9add184..d8f0ab56 100644 --- a/elasticsearch/_async/client/ml.py +++ b/elasticsearch/_async/client/ml.py @@ -24,6 +24,7 @@ class MlClient(NamespacedClient): """ 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 @@ -53,6 +54,7 @@ class MlClient(NamespacedClient): async def delete_calendar(self, calendar_id, params=None, headers=None): """ Deletes a calendar. + ``_ :arg calendar_id: The ID of the calendar to delete @@ -75,6 +77,7 @@ class MlClient(NamespacedClient): ): """ Deletes scheduled events from a calendar. + ``_ :arg calendar_id: The ID of the calendar to modify @@ -95,6 +98,7 @@ class MlClient(NamespacedClient): 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 @@ -115,6 +119,7 @@ class MlClient(NamespacedClient): 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 @@ -138,6 +143,7 @@ class MlClient(NamespacedClient): ): """ Deletes expired and unused machine learning data. + ``_ :arg body: deleting expired data parameters @@ -160,6 +166,7 @@ class MlClient(NamespacedClient): async def delete_filter(self, filter_id, params=None, headers=None): """ Deletes a filter. + ``_ :arg filter_id: The ID of the filter to delete @@ -180,6 +187,7 @@ class MlClient(NamespacedClient): ): """ Deletes forecasts from a machine learning job. + ``_ :arg job_id: The ID of the job from which to delete forecasts @@ -204,6 +212,7 @@ class MlClient(NamespacedClient): 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 @@ -227,6 +236,7 @@ class MlClient(NamespacedClient): ): """ Deletes an existing model snapshot. + ``_ :arg job_id: The ID of the job to fetch @@ -265,6 +275,7 @@ class MlClient(NamespacedClient): """ 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 @@ -316,6 +327,7 @@ class MlClient(NamespacedClient): 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 @@ -346,6 +358,7 @@ class MlClient(NamespacedClient): 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 @@ -381,6 +394,7 @@ class MlClient(NamespacedClient): ): """ Retrieves anomaly detection job results for one or more buckets. + ``_ :arg job_id: ID of the job to get bucket results from @@ -418,6 +432,7 @@ class MlClient(NamespacedClient): 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 @@ -450,6 +465,7 @@ class MlClient(NamespacedClient): ): """ Retrieves configuration information for calendars. + ``_ :arg body: The from and size parameters optionally sent in the @@ -476,6 +492,7 @@ class MlClient(NamespacedClient): ): """ Retrieves anomaly detection job results for one or more categories. + ``_ :arg job_id: The name of the job @@ -509,6 +526,7 @@ class MlClient(NamespacedClient): 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 @@ -526,10 +544,11 @@ class MlClient(NamespacedClient): headers=headers, ) - @query_params("allow_no_datafeeds", "allow_no_match") + @query_params("allow_no_datafeeds", "allow_no_match", "exclude_generated") 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 @@ -539,6 +558,8 @@ class MlClient(NamespacedClient): :arg allow_no_match: Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + :arg exclude_generated: Omits fields that are illegal to set on + datafeed PUT """ return await self.transport.perform_request( "GET", @@ -551,6 +572,7 @@ class MlClient(NamespacedClient): async def get_filters(self, filter_id=None, params=None, headers=None): """ Retrieves filters. + ``_ :arg filter_id: The ID of the filter to fetch @@ -581,6 +603,7 @@ class MlClient(NamespacedClient): 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 @@ -615,6 +638,7 @@ class MlClient(NamespacedClient): 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 @@ -632,10 +656,11 @@ class MlClient(NamespacedClient): headers=headers, ) - @query_params("allow_no_jobs", "allow_no_match") + @query_params("allow_no_jobs", "allow_no_match", "exclude_generated") 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 @@ -645,6 +670,8 @@ class MlClient(NamespacedClient): :arg allow_no_match: Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + :arg exclude_generated: Omits fields that are illegal to set on + job PUT """ return await self.transport.perform_request( "GET", @@ -659,6 +686,7 @@ class MlClient(NamespacedClient): ): """ Retrieves information about model snapshots. + ``_ :arg job_id: The ID of the job to fetch @@ -704,6 +732,7 @@ class MlClient(NamespacedClient): """ 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 @@ -755,6 +784,7 @@ class MlClient(NamespacedClient): 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 @@ -788,6 +818,7 @@ class MlClient(NamespacedClient): async def info(self, params=None, headers=None): """ Returns defaults and limits used by machine learning. + ``_ """ return await self.transport.perform_request( @@ -798,6 +829,7 @@ class MlClient(NamespacedClient): 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 @@ -816,6 +848,7 @@ class MlClient(NamespacedClient): 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 @@ -837,6 +870,7 @@ class MlClient(NamespacedClient): 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 @@ -863,6 +897,7 @@ class MlClient(NamespacedClient): async def preview_datafeed(self, datafeed_id, params=None, headers=None): """ Previews a datafeed. + ``_ :arg datafeed_id: The ID of the datafeed to preview @@ -883,6 +918,7 @@ class MlClient(NamespacedClient): 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 @@ -905,6 +941,7 @@ class MlClient(NamespacedClient): 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 @@ -927,6 +964,7 @@ class MlClient(NamespacedClient): 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 @@ -957,6 +995,7 @@ class MlClient(NamespacedClient): 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 @@ -978,6 +1017,7 @@ class MlClient(NamespacedClient): 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 @@ -1001,6 +1041,7 @@ class MlClient(NamespacedClient): ): """ Reverts to a specific snapshot. + ``_ :arg job_id: The ID of the job to fetch @@ -1033,6 +1074,7 @@ class MlClient(NamespacedClient): """ 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. @@ -1048,6 +1090,7 @@ class MlClient(NamespacedClient): 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 @@ -1075,6 +1118,7 @@ class MlClient(NamespacedClient): async def stop_datafeed(self, datafeed_id, body=None, params=None, headers=None): """ Stops one or more datafeeds. + ``_ :arg datafeed_id: The ID of the datafeed to stop @@ -1108,6 +1152,7 @@ class MlClient(NamespacedClient): 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 @@ -1138,6 +1183,7 @@ class MlClient(NamespacedClient): 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 @@ -1159,6 +1205,7 @@ class MlClient(NamespacedClient): 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 @@ -1182,6 +1229,7 @@ class MlClient(NamespacedClient): ): """ Updates certain properties of a snapshot. + ``_ :arg job_id: The ID of the job to fetch @@ -1211,6 +1259,7 @@ class MlClient(NamespacedClient): async def validate(self, body, params=None, headers=None): """ Validates an anomaly detection job. + ``_ :arg body: The job config @@ -1230,6 +1279,7 @@ class MlClient(NamespacedClient): async def validate_detector(self, body, params=None, headers=None): """ Validates an anomaly detection detector. + ``_ :arg body: The detector @@ -1249,6 +1299,7 @@ class MlClient(NamespacedClient): 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 @@ -1270,6 +1321,7 @@ class MlClient(NamespacedClient): 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 @@ -1285,16 +1337,19 @@ class MlClient(NamespacedClient): body=body, ) - @query_params("allow_no_match", "from_", "size") + @query_params("allow_no_match", "exclude_generated", "from_", "size") 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 matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) Default: True + :arg exclude_generated: Omits fields that are illegal to set on + data frame analytics PUT :arg from_: skips a number of analytics :arg size: specifies a max number of analytics to get Default: 100 @@ -1314,6 +1369,7 @@ class MlClient(NamespacedClient): 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 @@ -1340,6 +1396,7 @@ class MlClient(NamespacedClient): 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 @@ -1363,6 +1420,7 @@ class MlClient(NamespacedClient): ): """ Starts a data frame analytics job. + ``_ :arg id: The ID of the data frame analytics to start @@ -1385,6 +1443,7 @@ class MlClient(NamespacedClient): 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 @@ -1413,6 +1472,7 @@ class MlClient(NamespacedClient): """ 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 @@ -1433,6 +1493,7 @@ class MlClient(NamespacedClient): ): """ Explains a data frame analytics config. + ``_ :arg body: The data frame analytics config to explain @@ -1449,7 +1510,7 @@ class MlClient(NamespacedClient): @query_params( "allow_no_match", "decompress_definition", - "for_export", + "exclude_generated", "from_", "include", "include_model_definition", @@ -1459,6 +1520,7 @@ class MlClient(NamespacedClient): 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 @@ -1468,8 +1530,8 @@ class MlClient(NamespacedClient): :arg decompress_definition: Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true. Default: True - :arg for_export: Omits fields that are illegal to set on model - PUT + :arg exclude_generated: Omits fields that are illegal to set on + model PUT :arg from_: skips a number of trained models :arg include: A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. @@ -1497,6 +1559,7 @@ class MlClient(NamespacedClient): 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 @@ -1522,6 +1585,7 @@ class MlClient(NamespacedClient): 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 @@ -1543,6 +1607,7 @@ class MlClient(NamespacedClient): async def estimate_model_memory(self, body, params=None, headers=None): """ Estimates the model memory + ``_ :arg body: The analysis config, plus cardinality estimates for @@ -1563,6 +1628,7 @@ class MlClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/ml.pyi b/elasticsearch/_async/client/ml.pyi index 482d6bb3..2bc04d52 100644 --- a/elasticsearch/_async/client/ml.pyi +++ b/elasticsearch/_async/client/ml.pyi @@ -22,6 +22,7 @@ class MlClient(NamespacedClient): async def close_job( self, job_id: Any, + *, body: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -36,11 +37,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_calendar( self, calendar_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -50,12 +52,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_calendar_event( self, calendar_id: Any, event_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -65,12 +68,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_calendar_job( self, calendar_id: Any, job_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -80,11 +84,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_datafeed( self, datafeed_id: Any, + *, force: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -95,10 +100,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_expired_data( self, + *, body: Optional[Any] = ..., job_id: Optional[Any] = ..., requests_per_second: Optional[Any] = ..., @@ -112,11 +118,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_filter( self, filter_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -126,11 +133,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_forecast( self, job_id: Any, + *, forecast_id: Optional[Any] = ..., allow_no_forecasts: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -143,11 +151,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_job( self, job_id: Any, + *, force: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -159,12 +168,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_model_snapshot( self, job_id: Any, snapshot_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -174,10 +184,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def find_file_structure( self, + *, body: Any, charset: Optional[Any] = ..., column_names: Optional[Any] = ..., @@ -201,11 +212,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def flush_job( self, job_id: Any, + *, body: Optional[Any] = ..., advance_time: Optional[Any] = ..., calc_interim: Optional[Any] = ..., @@ -221,11 +233,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def forecast( self, job_id: Any, + *, duration: Optional[Any] = ..., expires_in: Optional[Any] = ..., max_model_memory: Optional[Any] = ..., @@ -238,11 +251,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_buckets( self, job_id: Any, + *, body: Optional[Any] = ..., timestamp: Optional[Any] = ..., anomaly_score: Optional[Any] = ..., @@ -263,11 +277,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_calendar_events( self, calendar_id: Any, + *, end: Optional[Any] = ..., from_: Optional[Any] = ..., job_id: Optional[Any] = ..., @@ -282,10 +297,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_calendars( self, + *, body: Optional[Any] = ..., calendar_id: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -299,11 +315,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_categories( self, job_id: Any, + *, body: Optional[Any] = ..., category_id: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -318,10 +335,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_datafeed_stats( self, + *, datafeed_id: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -334,13 +352,15 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_datafeeds( self, + *, datafeed_id: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -350,10 +370,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_filters( self, + *, filter_id: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., @@ -366,11 +387,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_influencers( self, job_id: Any, + *, body: Optional[Any] = ..., desc: Optional[Any] = ..., end: Optional[Any] = ..., @@ -389,10 +411,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_job_stats( self, + *, job_id: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -405,13 +428,15 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_jobs( self, + *, job_id: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -421,11 +446,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_model_snapshots( self, job_id: Any, + *, body: Optional[Any] = ..., snapshot_id: Optional[Any] = ..., desc: Optional[Any] = ..., @@ -443,11 +469,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_overall_buckets( self, job_id: Any, + *, body: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -466,11 +493,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_records( self, job_id: Any, + *, body: Optional[Any] = ..., desc: Optional[Any] = ..., end: Optional[Any] = ..., @@ -489,10 +517,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def info( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -502,11 +531,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def open_job( self, job_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -516,11 +546,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def post_calendar_events( self, calendar_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -531,11 +562,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def post_data( self, job_id: Any, + *, body: Any, reset_end: Optional[Any] = ..., reset_start: Optional[Any] = ..., @@ -548,11 +580,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def preview_datafeed( self, datafeed_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -562,11 +595,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_calendar( self, calendar_id: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -577,12 +611,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_calendar_job( self, calendar_id: Any, job_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -592,11 +627,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_datafeed( self, datafeed_id: Any, + *, body: Any, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -611,11 +647,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_filter( self, filter_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -626,11 +663,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_job( self, job_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -641,12 +679,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def revert_model_snapshot( self, job_id: Any, snapshot_id: Any, + *, body: Optional[Any] = ..., delete_intervening_results: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -658,10 +697,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def set_upgrade_mode( self, + *, enabled: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -673,11 +713,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def start_datafeed( self, datafeed_id: Any, + *, body: Optional[Any] = ..., end: Optional[Any] = ..., start: Optional[Any] = ..., @@ -691,11 +732,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stop_datafeed( self, datafeed_id: Any, + *, body: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -710,11 +752,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_datafeed( self, datafeed_id: Any, + *, body: Any, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -729,11 +772,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_filter( self, filter_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -744,11 +788,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_job( self, job_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -759,12 +804,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_model_snapshot( self, job_id: Any, snapshot_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -775,10 +821,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def validate( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -789,10 +836,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def validate_detector( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -803,11 +851,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_data_frame_analytics( self, id: Any, + *, force: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -819,10 +868,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def evaluate_data_frame( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -833,12 +883,14 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_data_frame_analytics( self, + *, id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -850,10 +902,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_data_frame_analytics_stats( self, + *, id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -868,11 +921,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_data_frame_analytics( self, id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -883,11 +937,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def start_data_frame_analytics( self, id: Any, + *, body: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -899,11 +954,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stop_data_frame_analytics( self, id: Any, + *, body: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., force: Optional[Any] = ..., @@ -917,11 +973,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_trained_model( self, model_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -931,10 +988,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def explain_data_frame_analytics( self, + *, body: Optional[Any] = ..., id: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -946,14 +1004,15 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_trained_models( self, + *, model_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., decompress_definition: Optional[Any] = ..., - for_export: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., from_: Optional[Any] = ..., include: Optional[Any] = ..., include_model_definition: Optional[Any] = ..., @@ -968,10 +1027,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_trained_models_stats( self, + *, model_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -985,11 +1045,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_trained_model( self, model_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1000,10 +1061,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def estimate_model_memory( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1014,11 +1076,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_data_frame_analytics( self, id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1029,5 +1092,5 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/monitoring.py b/elasticsearch/_async/client/monitoring.py index 93c46f2c..15bbf5e5 100644 --- a/elasticsearch/_async/client/monitoring.py +++ b/elasticsearch/_async/client/monitoring.py @@ -23,6 +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 diff --git a/elasticsearch/_async/client/monitoring.pyi b/elasticsearch/_async/client/monitoring.pyi index 2952568d..3e2fdfa1 100644 --- a/elasticsearch/_async/client/monitoring.pyi +++ b/elasticsearch/_async/client/monitoring.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class MonitoringClient(NamespacedClient): async def bulk( self, + *, body: Any, doc_type: Optional[Any] = ..., interval: Optional[Any] = ..., @@ -35,5 +36,5 @@ class MonitoringClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/nodes.py b/elasticsearch/_async/client/nodes.py index d84217a8..b587faa5 100644 --- a/elasticsearch/_async/client/nodes.py +++ b/elasticsearch/_async/client/nodes.py @@ -25,6 +25,7 @@ class NodesClient(NamespacedClient): ): """ Reloads secure settings. + ``_ :arg body: An object containing the password for the @@ -46,6 +47,7 @@ class NodesClient(NamespacedClient): 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 @@ -78,6 +80,7 @@ class NodesClient(NamespacedClient): ): """ Returns statistical information about nodes in the cluster. + ``_ :arg node_id: A comma-separated list of node IDs or names to @@ -122,6 +125,7 @@ class NodesClient(NamespacedClient): 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 @@ -155,6 +159,7 @@ class NodesClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/nodes.pyi b/elasticsearch/_async/client/nodes.pyi index 4a810e39..8785e53e 100644 --- a/elasticsearch/_async/client/nodes.pyi +++ b/elasticsearch/_async/client/nodes.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class NodesClient(NamespacedClient): async def reload_secure_settings( self, + *, body: Optional[Any] = ..., node_id: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -33,10 +34,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def info( self, + *, node_id: Optional[Any] = ..., metric: Optional[Any] = ..., flat_settings: Optional[Any] = ..., @@ -50,10 +52,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stats( self, + *, node_id: Optional[Any] = ..., metric: Optional[Any] = ..., index_metric: Optional[Any] = ..., @@ -74,10 +77,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def hot_threads( self, + *, node_id: Optional[Any] = ..., doc_type: Optional[Any] = ..., ignore_idle_threads: Optional[Any] = ..., @@ -94,10 +98,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def usage( self, + *, node_id: Optional[Any] = ..., metric: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -110,5 +115,5 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/remote.pyi b/elasticsearch/_async/client/remote.pyi index a06fcf10..599b9c04 100644 --- a/elasticsearch/_async/client/remote.pyi +++ b/elasticsearch/_async/client/remote.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class RemoteClient(NamespacedClient): async def info( self, + *, timeout: Optional[Any] = None, pretty: Optional[bool] = None, human: Optional[bool] = None, diff --git a/elasticsearch/_async/client/rollup.py b/elasticsearch/_async/client/rollup.py index d5fb8fa0..539f70f7 100644 --- a/elasticsearch/_async/client/rollup.py +++ b/elasticsearch/_async/client/rollup.py @@ -23,6 +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,6 +39,7 @@ class RollupClient(NamespacedClient): 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, @@ -52,6 +54,7 @@ class RollupClient(NamespacedClient): """ 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 @@ -66,6 +69,7 @@ class RollupClient(NamespacedClient): """ 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 @@ -82,6 +86,7 @@ class RollupClient(NamespacedClient): async def put_job(self, id, body, params=None, headers=None): """ Creates a rollup job. + ``_ :arg id: The ID of the job to create @@ -105,6 +110,7 @@ class RollupClient(NamespacedClient): ): """ Enables searching rolled-up data using the standard query DSL. + ``_ :arg index: The indices or index-pattern(s) (containing rollup @@ -132,6 +138,7 @@ class RollupClient(NamespacedClient): 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,6 +157,7 @@ class RollupClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/rollup.pyi b/elasticsearch/_async/client/rollup.pyi index bac2a193..9150d59f 100644 --- a/elasticsearch/_async/client/rollup.pyi +++ b/elasticsearch/_async/client/rollup.pyi @@ -22,6 +22,7 @@ class RollupClient(NamespacedClient): async def delete_job( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,10 +32,11 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_jobs( self, + *, id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -45,10 +47,11 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_rollup_caps( self, + *, id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -59,11 +62,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_rollup_index_caps( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -73,11 +77,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_job( self, id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -88,11 +93,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def rollup_search( self, index: Any, + *, body: Any, doc_type: Optional[Any] = ..., rest_total_hits_as_int: Optional[Any] = ..., @@ -106,11 +112,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def start_job( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -120,11 +127,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stop_job( self, id: Any, + *, timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -136,5 +144,5 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/searchable_snapshots.py b/elasticsearch/_async/client/searchable_snapshots.py index c7df9b34..7e5cb92f 100644 --- a/elasticsearch/_async/client/searchable_snapshots.py +++ b/elasticsearch/_async/client/searchable_snapshots.py @@ -23,6 +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 @@ -47,6 +48,7 @@ class SearchableSnapshotsClient(NamespacedClient): 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 @@ -75,6 +77,7 @@ class SearchableSnapshotsClient(NamespacedClient): async def repository_stats(self, repository, params=None, headers=None): """ DEPRECATED: This API is replaced by the Repositories Metering API. + ``_ :arg repository: The repository for which to get the stats for @@ -93,6 +96,7 @@ class SearchableSnapshotsClient(NamespacedClient): 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/searchable_snapshots.pyi b/elasticsearch/_async/client/searchable_snapshots.pyi index 42d5a65b..94ea4331 100644 --- a/elasticsearch/_async/client/searchable_snapshots.pyi +++ b/elasticsearch/_async/client/searchable_snapshots.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SearchableSnapshotsClient(NamespacedClient): async def clear_cache( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -34,12 +35,13 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def mount( self, repository: Any, snapshot: Any, + *, body: Any, master_timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -52,11 +54,12 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def repository_stats( self, repository: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -66,10 +69,11 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stats( self, + *, index: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -80,5 +84,5 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/security.py b/elasticsearch/_async/client/security.py index 552e390f..0cbda9e5 100644 --- a/elasticsearch/_async/client/security.py +++ b/elasticsearch/_async/client/security.py @@ -24,6 +24,7 @@ class SecurityClient(NamespacedClient): """ Enables authentication as a user and retrieve information about the authenticated user. + ``_ """ return await self.transport.perform_request( @@ -34,6 +35,7 @@ class SecurityClient(NamespacedClient): 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 @@ -60,6 +62,7 @@ class SecurityClient(NamespacedClient): """ Evicts users from the user cache. Can completely clear the cache or evict specific users. + ``_ :arg realms: Comma-separated list of realms to clear @@ -80,6 +83,7 @@ class SecurityClient(NamespacedClient): async def clear_cached_roles(self, name, params=None, headers=None): """ Evicts roles from the native role cache. + ``_ :arg name: Role name @@ -98,6 +102,7 @@ class SecurityClient(NamespacedClient): 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 @@ -117,6 +122,7 @@ class SecurityClient(NamespacedClient): async def delete_privileges(self, application, name, params=None, headers=None): """ Removes application privileges. + ``_ :arg application: Application name @@ -141,6 +147,7 @@ class SecurityClient(NamespacedClient): async def delete_role(self, name, params=None, headers=None): """ Removes roles in the native realm. + ``_ :arg name: Role name @@ -163,6 +170,7 @@ class SecurityClient(NamespacedClient): async def delete_role_mapping(self, name, params=None, headers=None): """ Removes role mappings. + ``_ :arg name: Role-mapping name @@ -185,6 +193,7 @@ class SecurityClient(NamespacedClient): async def delete_user(self, username, params=None, headers=None): """ Deletes users from the native realm. + ``_ :arg username: username @@ -207,6 +216,7 @@ class SecurityClient(NamespacedClient): 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 @@ -229,6 +239,7 @@ class SecurityClient(NamespacedClient): 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 @@ -251,6 +262,7 @@ class SecurityClient(NamespacedClient): 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 @@ -272,6 +284,7 @@ class SecurityClient(NamespacedClient): ): """ Retrieves application privileges. + ``_ :arg application: Application name @@ -288,9 +301,10 @@ class SecurityClient(NamespacedClient): async def get_role(self, name=None, params=None, headers=None): """ Retrieves roles in the native realm. + ``_ - :arg name: Role name + :arg name: A comma-separated list of role names """ return await self.transport.perform_request( "GET", _make_path("_security", "role", name), params=params, headers=headers @@ -300,9 +314,10 @@ class SecurityClient(NamespacedClient): async def get_role_mapping(self, name=None, params=None, headers=None): """ Retrieves role mappings. + ``_ - :arg name: Role-Mapping name + :arg name: A comma-separated list of role-mapping names """ return await self.transport.perform_request( "GET", @@ -315,6 +330,7 @@ class SecurityClient(NamespacedClient): 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,6 +346,7 @@ class SecurityClient(NamespacedClient): 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,6 +362,7 @@ class SecurityClient(NamespacedClient): async def get_user_privileges(self, params=None, headers=None): """ Retrieves application privileges. + ``_ """ return await self.transport.perform_request( @@ -355,6 +373,7 @@ class SecurityClient(NamespacedClient): 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 @@ -375,6 +394,7 @@ class SecurityClient(NamespacedClient): 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,6 +410,7 @@ class SecurityClient(NamespacedClient): 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,6 +430,7 @@ class SecurityClient(NamespacedClient): async def put_privileges(self, body, params=None, headers=None): """ Adds or updates application privileges. + ``_ :arg body: The privilege(s) to add @@ -428,6 +450,7 @@ class SecurityClient(NamespacedClient): async def put_role(self, name, body, params=None, headers=None): """ Adds and updates roles in the native realm. + ``_ :arg name: Role name @@ -453,6 +476,7 @@ class SecurityClient(NamespacedClient): async def put_role_mapping(self, name, body, params=None, headers=None): """ Creates and updates role mappings. + ``_ :arg name: Role-mapping name @@ -479,6 +503,7 @@ class SecurityClient(NamespacedClient): """ Adds and updates users in the native realm. These users are commonly referred to as native users. + ``_ :arg username: The username of the User @@ -505,6 +530,7 @@ class SecurityClient(NamespacedClient): """ Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + ``_ """ return await self.transport.perform_request( @@ -515,6 +541,7 @@ class SecurityClient(NamespacedClient): 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 @@ -535,6 +562,7 @@ class SecurityClient(NamespacedClient): async def clear_api_key_cache(self, ids, params=None, headers=None): """ Clear a subset or all entries from the API key cache. + ``_ :arg ids: A comma-separated list of IDs of API keys to clear @@ -549,3 +577,27 @@ class SecurityClient(NamespacedClient): params=params, headers=headers, ) + + @query_params("refresh") + async def grant_api_key(self, body, params=None, headers=None): + """ + Creates an API key on behalf of another user. + + ``_ + + :arg body: The api key request to create an API key + :arg refresh: If `true` (the default) then refresh the affected + shards to make this operation visible to search, if `wait_for` then wait + for a refresh to make this operation visible to search, if `false` then + do nothing with refreshes. Valid choices: true, false, wait_for + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + return await self.transport.perform_request( + "POST", + "/_security/api_key/grant", + params=params, + headers=headers, + body=body, + ) diff --git a/elasticsearch/_async/client/security.pyi b/elasticsearch/_async/client/security.pyi index 35a29fdc..05943ba5 100644 --- a/elasticsearch/_async/client/security.pyi +++ b/elasticsearch/_async/client/security.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SecurityClient(NamespacedClient): async def authenticate( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,10 +31,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def change_password( self, + *, body: Any, username: Optional[Any] = ..., refresh: Optional[Any] = ..., @@ -46,11 +48,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def clear_cached_realms( self, realms: Any, + *, usernames: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -61,11 +64,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def clear_cached_roles( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -75,10 +79,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def create_api_key( self, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -90,12 +95,13 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_privileges( self, application: Any, name: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -106,11 +112,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_role( self, name: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -121,11 +128,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_role_mapping( self, name: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -136,11 +144,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_user( self, username: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -151,11 +160,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def disable_user( self, username: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -166,11 +176,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def enable_user( self, username: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -181,10 +192,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_api_key( self, + *, id: Optional[Any] = ..., name: Optional[Any] = ..., owner: Optional[Any] = ..., @@ -199,10 +211,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_privileges( self, + *, application: Optional[Any] = ..., name: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -214,10 +227,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_role( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -228,10 +242,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_role_mapping( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -242,10 +257,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_token( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -256,10 +272,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_user( self, + *, username: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -270,10 +287,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_user_privileges( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -283,10 +301,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def has_privileges( self, + *, body: Any, user: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -298,10 +317,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def invalidate_api_key( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -312,10 +332,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def invalidate_token( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -326,10 +347,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_privileges( self, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -341,11 +363,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_role( self, name: Any, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -357,11 +380,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_role_mapping( self, name: Any, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -373,11 +397,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_user( self, username: Any, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -389,10 +414,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_builtin_privileges( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -402,11 +428,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def clear_cached_privileges( self, application: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -416,11 +443,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def clear_api_key_cache( self, ids: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -430,5 +458,21 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... + ) -> Any: ... + async def grant_api_key( + self, + *, + body: Any, + refresh: Optional[Any] = ..., + pretty: Optional[bool] = ..., + human: Optional[bool] = ..., + error_trace: Optional[bool] = ..., + format: Optional[str] = ..., + filter_path: Optional[Union[str, Collection[str]]] = ..., + request_timeout: Optional[Union[int, float]] = ..., + ignore: Optional[Union[int, Collection[int]]] = ..., + opaque_id: Optional[str] = ..., + params: Optional[MutableMapping[str, Any]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/slm.py b/elasticsearch/_async/client/slm.py index fb67a85b..ade3140f 100644 --- a/elasticsearch/_async/client/slm.py +++ b/elasticsearch/_async/client/slm.py @@ -23,6 +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 @@ -43,6 +44,7 @@ class SlmClient(NamespacedClient): """ 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 @@ -63,6 +65,7 @@ class SlmClient(NamespacedClient): """ Deletes any snapshots that are expired according to the policy's retention rules. + ``_ """ return await self.transport.perform_request( @@ -74,6 +77,7 @@ class SlmClient(NamespacedClient): """ Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + ``_ :arg policy_id: Comma-separated list of snapshot lifecycle @@ -91,6 +95,7 @@ class SlmClient(NamespacedClient): """ Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + ``_ """ return await self.transport.perform_request( @@ -101,6 +106,7 @@ class SlmClient(NamespacedClient): 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 @@ -121,6 +127,7 @@ class SlmClient(NamespacedClient): async def get_status(self, params=None, headers=None): """ Retrieves the status of snapshot lifecycle management (SLM). + ``_ """ return await self.transport.perform_request( @@ -131,6 +138,7 @@ class SlmClient(NamespacedClient): async def start(self, params=None, headers=None): """ Turns on snapshot lifecycle management (SLM). + ``_ """ return await self.transport.perform_request( @@ -141,6 +149,7 @@ class SlmClient(NamespacedClient): async def stop(self, params=None, headers=None): """ Turns off snapshot lifecycle management (SLM). + ``_ """ return await self.transport.perform_request( diff --git a/elasticsearch/_async/client/slm.pyi b/elasticsearch/_async/client/slm.pyi index df3e41ac..1bf0d1ef 100644 --- a/elasticsearch/_async/client/slm.pyi +++ b/elasticsearch/_async/client/slm.pyi @@ -22,6 +22,7 @@ class SlmClient(NamespacedClient): async def delete_lifecycle( self, policy_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def execute_lifecycle( self, policy_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -45,10 +47,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def execute_retention( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -58,10 +61,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_lifecycle( self, + *, policy_id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -72,10 +76,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_stats( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -85,11 +90,12 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_lifecycle( self, policy_id: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -100,10 +106,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -113,10 +120,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def start( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -126,10 +134,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stop( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -139,5 +148,5 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/snapshot.py b/elasticsearch/_async/client/snapshot.py index e6b8fb50..07451f2f 100644 --- a/elasticsearch/_async/client/snapshot.py +++ b/elasticsearch/_async/client/snapshot.py @@ -23,6 +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 @@ -49,6 +50,7 @@ class SnapshotClient(NamespacedClient): async def delete(self, repository, snapshot, params=None, headers=None): """ Deletes a snapshot. + ``_ :arg repository: A repository name @@ -71,6 +73,7 @@ class SnapshotClient(NamespacedClient): async def get(self, repository, snapshot, params=None, headers=None): """ Returns information about a snapshot. + ``_ :arg repository: A repository name @@ -98,6 +101,7 @@ class SnapshotClient(NamespacedClient): async def delete_repository(self, repository, params=None, headers=None): """ Deletes a repository. + ``_ :arg repository: Name of the snapshot repository to unregister. @@ -120,6 +124,7 @@ class SnapshotClient(NamespacedClient): 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 @@ -136,6 +141,7 @@ class SnapshotClient(NamespacedClient): async def create_repository(self, repository, body, params=None, headers=None): """ Creates a repository. + ``_ :arg repository: A repository name @@ -161,6 +167,7 @@ class SnapshotClient(NamespacedClient): async def restore(self, repository, snapshot, body=None, params=None, headers=None): """ Restores a snapshot. + ``_ :arg repository: A repository name @@ -187,6 +194,7 @@ class SnapshotClient(NamespacedClient): 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 @@ -208,6 +216,7 @@ class SnapshotClient(NamespacedClient): async def verify_repository(self, repository, params=None, headers=None): """ Verifies a repository. + ``_ :arg repository: A repository name @@ -229,6 +238,7 @@ class SnapshotClient(NamespacedClient): async def cleanup_repository(self, repository, params=None, headers=None): """ Removes stale data from repository. + ``_ :arg repository: A repository name @@ -245,3 +255,31 @@ class SnapshotClient(NamespacedClient): params=params, headers=headers, ) + + @query_params("master_timeout") + async def clone( + self, repository, snapshot, target_snapshot, body, params=None, headers=None + ): + """ + Clones indices from one snapshot into another snapshot in the same repository. + + ``_ + + :arg repository: A repository name + :arg snapshot: The name of the snapshot to clone from + :arg target_snapshot: The name of the cloned snapshot to create + :arg body: The snapshot clone definition + :arg master_timeout: Explicit operation timeout for connection + to master node + """ + for param in (repository, snapshot, target_snapshot, body): + if param in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument.") + + return await self.transport.perform_request( + "PUT", + _make_path("_snapshot", repository, snapshot, "_clone", target_snapshot), + params=params, + headers=headers, + body=body, + ) diff --git a/elasticsearch/_async/client/snapshot.pyi b/elasticsearch/_async/client/snapshot.pyi index f5394fb8..ca80bac4 100644 --- a/elasticsearch/_async/client/snapshot.pyi +++ b/elasticsearch/_async/client/snapshot.pyi @@ -23,6 +23,7 @@ class SnapshotClient(NamespacedClient): self, repository: Any, snapshot: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -35,12 +36,13 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete( self, repository: Any, snapshot: Any, + *, master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -51,12 +53,13 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get( self, repository: Any, snapshot: Any, + *, ignore_unavailable: Optional[Any] = ..., master_timeout: Optional[Any] = ..., verbose: Optional[Any] = ..., @@ -69,11 +72,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_repository( self, repository: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -85,10 +89,11 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_repository( self, + *, repository: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -101,11 +106,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def create_repository( self, repository: Any, + *, body: Any, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -119,12 +125,13 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def restore( self, repository: Any, snapshot: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -137,10 +144,11 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def status( self, + *, repository: Optional[Any] = ..., snapshot: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -154,11 +162,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def verify_repository( self, repository: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -170,11 +179,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def cleanup_repository( self, repository: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -186,5 +196,24 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... + ) -> Any: ... + async def clone( + self, + repository: Any, + snapshot: Any, + target_snapshot: Any, + *, + body: Any, + master_timeout: Optional[Any] = ..., + pretty: Optional[bool] = ..., + human: Optional[bool] = ..., + error_trace: Optional[bool] = ..., + format: Optional[str] = ..., + filter_path: Optional[Union[str, Collection[str]]] = ..., + request_timeout: Optional[Union[int, float]] = ..., + ignore: Optional[Union[int, Collection[int]]] = ..., + opaque_id: Optional[str] = ..., + params: Optional[MutableMapping[str, Any]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/sql.py b/elasticsearch/_async/client/sql.py index f9e34e0a..09dba7cd 100644 --- a/elasticsearch/_async/client/sql.py +++ b/elasticsearch/_async/client/sql.py @@ -23,6 +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 @@ -39,6 +40,7 @@ class SqlClient(NamespacedClient): 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 @@ -57,6 +59,7 @@ class SqlClient(NamespacedClient): 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/sql.pyi b/elasticsearch/_async/client/sql.pyi index 503579ce..cfb8a04f 100644 --- a/elasticsearch/_async/client/sql.pyi +++ b/elasticsearch/_async/client/sql.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SqlClient(NamespacedClient): async def clear_cursor( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -31,10 +32,11 @@ class SqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def query( self, + *, body: Any, format: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -45,10 +47,11 @@ class SqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def translate( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -59,5 +62,5 @@ class SqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/ssl.py b/elasticsearch/_async/client/ssl.py index 1cf90f6a..8de69d12 100644 --- a/elasticsearch/_async/client/ssl.py +++ b/elasticsearch/_async/client/ssl.py @@ -24,6 +24,7 @@ class SslClient(NamespacedClient): """ Retrieves information about the X.509 certificates used to encrypt communications in the cluster. + ``_ """ return await self.transport.perform_request( diff --git a/elasticsearch/_async/client/ssl.pyi b/elasticsearch/_async/client/ssl.pyi index 4bafe546..c21e689d 100644 --- a/elasticsearch/_async/client/ssl.pyi +++ b/elasticsearch/_async/client/ssl.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SslClient(NamespacedClient): async def certificates( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,5 +31,5 @@ class SslClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/tasks.py b/elasticsearch/_async/client/tasks.py index 2a2b6ed0..ef53dedd 100644 --- a/elasticsearch/_async/client/tasks.py +++ b/elasticsearch/_async/client/tasks.py @@ -32,6 +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 @@ -56,6 +57,7 @@ class TasksClient(NamespacedClient): 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 @@ -82,6 +84,7 @@ class TasksClient(NamespacedClient): 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 diff --git a/elasticsearch/_async/client/tasks.pyi b/elasticsearch/_async/client/tasks.pyi index bc6f11d5..757e6096 100644 --- a/elasticsearch/_async/client/tasks.pyi +++ b/elasticsearch/_async/client/tasks.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class TasksClient(NamespacedClient): async def list( self, + *, actions: Optional[Any] = ..., detailed: Optional[Any] = ..., group_by: Optional[Any] = ..., @@ -37,10 +38,11 @@ class TasksClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def cancel( self, + *, task_id: Optional[Any] = ..., actions: Optional[Any] = ..., nodes: Optional[Any] = ..., @@ -55,10 +57,11 @@ class TasksClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get( self, + *, task_id: Optional[Any] = ..., timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -71,5 +74,5 @@ class TasksClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/transform.py b/elasticsearch/_async/client/transform.py index 9734d7ba..6f4e70d4 100644 --- a/elasticsearch/_async/client/transform.py +++ b/elasticsearch/_async/client/transform.py @@ -23,6 +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 @@ -42,10 +43,11 @@ class TransformClient(NamespacedClient): headers=headers, ) - @query_params("allow_no_match", "from_", "size") + @query_params("allow_no_match", "exclude_generated", "from_", "size") 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 @@ -54,6 +56,8 @@ class TransformClient(NamespacedClient): :arg allow_no_match: Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) + :arg exclude_generated: Omits fields that are illegal to set on + transform PUT :arg from_: skips a number of transform configs, defaults to 0 :arg size: specifies a max number of transforms to get, defaults to 100 @@ -73,6 +77,7 @@ class TransformClient(NamespacedClient): 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 @@ -104,6 +109,7 @@ class TransformClient(NamespacedClient): async def preview_transform(self, body, params=None, headers=None): """ Previews a transform. + ``_ :arg body: The definition for the transform to preview @@ -119,6 +125,7 @@ class TransformClient(NamespacedClient): async def put_transform(self, transform_id, body, params=None, headers=None): """ Instantiates a transform. + ``_ :arg transform_id: The id of the new transform. @@ -142,6 +149,7 @@ class TransformClient(NamespacedClient): 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 @@ -170,6 +178,7 @@ class TransformClient(NamespacedClient): 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 @@ -201,6 +210,7 @@ class TransformClient(NamespacedClient): 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. diff --git a/elasticsearch/_async/client/transform.pyi b/elasticsearch/_async/client/transform.pyi index 9aca91a6..7726577a 100644 --- a/elasticsearch/_async/client/transform.pyi +++ b/elasticsearch/_async/client/transform.pyi @@ -22,6 +22,7 @@ class TransformClient(NamespacedClient): async def delete_transform( self, transform_id: Any, + *, force: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -32,12 +33,14 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_transform( self, + *, transform_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -49,11 +52,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_transform_stats( self, transform_id: Any, + *, allow_no_match: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., @@ -66,10 +70,11 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def preview_transform( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -80,11 +85,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_transform( self, transform_id: Any, + *, body: Any, defer_validation: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -96,11 +102,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def start_transform( self, transform_id: Any, + *, timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -111,11 +118,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stop_transform( self, transform_id: Any, + *, allow_no_match: Optional[Any] = ..., force: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -130,11 +138,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def update_transform( self, transform_id: Any, + *, body: Any, defer_validation: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -146,5 +155,5 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/watcher.py b/elasticsearch/_async/client/watcher.py index 5c03fd87..143da49d 100644 --- a/elasticsearch/_async/client/watcher.py +++ b/elasticsearch/_async/client/watcher.py @@ -23,6 +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 @@ -43,6 +44,7 @@ class WatcherClient(NamespacedClient): async def activate_watch(self, watch_id, params=None, headers=None): """ Activates a currently inactive watch. + ``_ :arg watch_id: Watch ID @@ -61,6 +63,7 @@ class WatcherClient(NamespacedClient): async def deactivate_watch(self, watch_id, params=None, headers=None): """ Deactivates a currently active watch. + ``_ :arg watch_id: Watch ID @@ -79,6 +82,7 @@ class WatcherClient(NamespacedClient): async def delete_watch(self, id, params=None, headers=None): """ Removes a watch from Watcher. + ``_ :arg id: Watch ID @@ -97,6 +101,7 @@ class WatcherClient(NamespacedClient): async def execute_watch(self, body=None, id=None, params=None, headers=None): """ Forces the execution of a stored watch. + ``_ :arg body: Execution control @@ -116,6 +121,7 @@ class WatcherClient(NamespacedClient): async def get_watch(self, id, params=None, headers=None): """ Retrieves a watch by its ID. + ``_ :arg id: Watch ID @@ -131,6 +137,7 @@ class WatcherClient(NamespacedClient): 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 @@ -157,6 +164,7 @@ class WatcherClient(NamespacedClient): async def start(self, params=None, headers=None): """ Starts Watcher if it is not already running. + ``_ """ return await self.transport.perform_request( @@ -167,6 +175,7 @@ class WatcherClient(NamespacedClient): async def stats(self, metric=None, params=None, headers=None): """ Retrieves the current Watcher metrics. + ``_ :arg metric: Controls what additional stat metrics should be @@ -186,6 +195,7 @@ class WatcherClient(NamespacedClient): async def stop(self, params=None, headers=None): """ Stops Watcher if it is running. + ``_ """ return await self.transport.perform_request( diff --git a/elasticsearch/_async/client/watcher.pyi b/elasticsearch/_async/client/watcher.pyi index 2769d006..eeb576aa 100644 --- a/elasticsearch/_async/client/watcher.pyi +++ b/elasticsearch/_async/client/watcher.pyi @@ -22,6 +22,7 @@ class WatcherClient(NamespacedClient): async def ack_watch( self, watch_id: Any, + *, action_id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -32,11 +33,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def activate_watch( self, watch_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -46,11 +48,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def deactivate_watch( self, watch_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -60,11 +63,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def delete_watch( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -74,10 +78,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def execute_watch( self, + *, body: Optional[Any] = ..., id: Optional[Any] = ..., debug: Optional[Any] = ..., @@ -90,11 +95,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def get_watch( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -104,11 +110,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def put_watch( self, id: Any, + *, body: Optional[Any] = ..., active: Optional[Any] = ..., if_primary_term: Optional[Any] = ..., @@ -123,10 +130,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def start( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -136,10 +144,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stats( self, + *, metric: Optional[Any] = ..., emit_stacktraces: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -151,10 +160,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def stop( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -164,5 +174,5 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/_async/client/xpack.py b/elasticsearch/_async/client/xpack.py index 9cb68bd6..a48b63a6 100644 --- a/elasticsearch/_async/client/xpack.py +++ b/elasticsearch/_async/client/xpack.py @@ -27,6 +27,7 @@ class XPackClient(NamespacedClient): 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, @@ -42,6 +43,7 @@ class XPackClient(NamespacedClient): 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/_async/client/xpack.pyi b/elasticsearch/_async/client/xpack.pyi index 9d713d0d..103456fe 100644 --- a/elasticsearch/_async/client/xpack.pyi +++ b/elasticsearch/_async/client/xpack.pyi @@ -24,6 +24,7 @@ class XPackClient(NamespacedClient): # AUTO-GENERATED-API-DEFINITIONS # async def info( self, + *, accept_enterprise: Optional[Any] = ..., categories: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -35,10 +36,11 @@ class XPackClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... async def usage( self, + *, master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -49,5 +51,5 @@ class XPackClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/__init__.py b/elasticsearch/client/__init__.py index a886dddb..155e9a2c 100644 --- a/elasticsearch/client/__init__.py +++ b/elasticsearch/client/__init__.py @@ -266,6 +266,7 @@ class Elasticsearch(object): def ping(self, params=None, headers=None): """ Returns whether the cluster is running. + ``_ """ try: @@ -279,6 +280,7 @@ class Elasticsearch(object): def info(self, params=None, headers=None): """ Returns basic information about the cluster. + ``_ """ return self.transport.perform_request( @@ -298,6 +300,7 @@ class Elasticsearch(object): """ 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 @@ -350,6 +353,7 @@ class Elasticsearch(object): 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 @@ -413,6 +417,7 @@ class Elasticsearch(object): 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 @@ -459,6 +464,7 @@ class Elasticsearch(object): 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 @@ -495,6 +501,7 @@ class Elasticsearch(object): 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 @@ -552,6 +559,7 @@ class Elasticsearch(object): 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 @@ -627,6 +635,7 @@ class Elasticsearch(object): 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 @@ -723,6 +732,7 @@ class Elasticsearch(object): """ Changes the number of requests per second for a particular Delete By Query operation. + ``_ :arg task_id: The task id to rethrottle @@ -743,6 +753,7 @@ class Elasticsearch(object): def delete_script(self, id, params=None, headers=None): """ Deletes a script. + ``_ :arg id: Script ID @@ -771,6 +782,7 @@ class Elasticsearch(object): 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 @@ -821,6 +833,7 @@ class Elasticsearch(object): 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 @@ -874,6 +887,7 @@ class Elasticsearch(object): 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 @@ -926,6 +940,7 @@ class Elasticsearch(object): """ Returns the information about the capabilities of fields among multiple indices. + ``_ :arg body: An index filter specified with the Query DSL @@ -966,6 +981,7 @@ class Elasticsearch(object): def get(self, index, id, doc_type=None, params=None, headers=None): """ Returns a document. + ``_ :arg index: The name of the index @@ -1006,6 +1022,7 @@ class Elasticsearch(object): def get_script(self, id, params=None, headers=None): """ Returns a script. + ``_ :arg id: Script ID @@ -1032,6 +1049,7 @@ class Elasticsearch(object): 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 @@ -1081,6 +1099,7 @@ class Elasticsearch(object): 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` @@ -1127,6 +1146,7 @@ class Elasticsearch(object): 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 @@ -1183,6 +1203,7 @@ class Elasticsearch(object): ): """ Allows to execute several search template operations in one request. + ``_ :arg body: The request definitions (metadata-search request @@ -1235,6 +1256,7 @@ class Elasticsearch(object): ): """ Returns multiple termvectors in one request. + ``_ :arg body: Define ids, documents, parameters or a list of @@ -1287,6 +1309,7 @@ class Elasticsearch(object): def put_script(self, id, body, context=None, params=None, headers=None): """ Creates or updates a script. + ``_ :arg id: Script ID @@ -1314,6 +1337,7 @@ class Elasticsearch(object): """ Allows to evaluate the quality of ranked search results over a set of typical search queries + ``_ :arg body: The ranking evaluation search definition, including @@ -1357,6 +1381,7 @@ class Elasticsearch(object): 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 @@ -1392,6 +1417,7 @@ class Elasticsearch(object): 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 @@ -1412,6 +1438,7 @@ class Elasticsearch(object): 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 @@ -1429,6 +1456,7 @@ class Elasticsearch(object): def scripts_painless_execute(self, body=None, params=None, headers=None): """ Allows an arbitrary script to be executed and a result to be returned + ``_ :arg body: The script to execute @@ -1445,6 +1473,7 @@ class Elasticsearch(object): 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 @@ -1513,6 +1542,7 @@ class Elasticsearch(object): 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 @@ -1635,6 +1665,7 @@ class Elasticsearch(object): """ 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 @@ -1677,6 +1708,7 @@ class Elasticsearch(object): ): """ Allows to use the Mustache language to pre-render a search definition. + ``_ :arg body: The search definition template and its params @@ -1743,6 +1775,7 @@ class Elasticsearch(object): """ Returns information and statistics about terms in the fields of a particular document. + ``_ :arg index: The index in which the document resides. @@ -1801,6 +1834,7 @@ class Elasticsearch(object): 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 @@ -1893,6 +1927,7 @@ class Elasticsearch(object): """ 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 @@ -1992,6 +2027,7 @@ class Elasticsearch(object): """ Changes the number of requests per second for a particular Update By Query operation. + ``_ :arg task_id: The task id to rethrottle @@ -2012,6 +2048,7 @@ class Elasticsearch(object): def get_script_context(self, params=None, headers=None): """ Returns all script contexts. + ``_ """ return self.transport.perform_request( @@ -2022,6 +2059,7 @@ class Elasticsearch(object): def get_script_languages(self, params=None, headers=None): """ Returns available script types, languages and contexts + ``_ """ return self.transport.perform_request( @@ -2032,6 +2070,7 @@ class Elasticsearch(object): def close_point_in_time(self, body=None, params=None, headers=None): """ Close a point in time + ``_ :arg body: a point-in-time id to close @@ -2046,6 +2085,7 @@ class Elasticsearch(object): def open_point_in_time(self, index=None, params=None, headers=None): """ Open a point in time that can be used in subsequent searches + ``_ :arg index: A comma-separated list of index names to open point diff --git a/elasticsearch/client/__init__.pyi b/elasticsearch/client/__init__.pyi index 81bcd6d7..c96ad33a 100644 --- a/elasticsearch/client/__init__.pyi +++ b/elasticsearch/client/__init__.pyi @@ -99,6 +99,7 @@ class Elasticsearch(object): # AUTO-GENERATED-API-DEFINITIONS # def ping( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -108,10 +109,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def info( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -121,12 +123,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def create( self, index: Any, id: Any, + *, body: Any, doc_type: Optional[Any] = ..., pipeline: Optional[Any] = ..., @@ -145,11 +148,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def index( self, index: Any, + *, body: Any, doc_type: Optional[Any] = ..., id: Optional[Any] = ..., @@ -173,10 +177,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def bulk( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -198,10 +203,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def clear_scroll( self, + *, body: Optional[Any] = ..., scroll_id: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -213,10 +219,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def count( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -243,12 +250,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., if_primary_term: Optional[Any] = ..., if_seq_no: Optional[Any] = ..., @@ -267,11 +275,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_by_query( self, index: Any, + *, body: Any, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -316,11 +325,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_by_query_rethrottle( self, task_id: Any, + *, requests_per_second: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -331,11 +341,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_script( self, id: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -347,12 +358,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def exists( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -373,12 +385,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def exists_source( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -398,12 +411,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def explain( self, index: Any, id: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -427,10 +441,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def field_caps( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -447,12 +462,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -473,11 +489,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_script( self, id: Any, + *, master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -488,12 +505,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_source( self, index: Any, id: Any, + *, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., _source_excludes: Optional[Any] = ..., @@ -513,10 +531,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def mget( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -537,10 +556,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def msearch( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -560,10 +580,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def msearch_template( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -581,10 +602,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def mtermvectors( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -609,11 +631,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_script( self, id: Any, + *, body: Any, context: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -627,10 +650,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def rank_eval( self, + *, body: Any, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -646,10 +670,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def reindex( self, + *, body: Any, max_docs: Optional[Any] = ..., refresh: Optional[Any] = ..., @@ -668,11 +693,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def reindex_rethrottle( self, task_id: Any, + *, requests_per_second: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -683,10 +709,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def render_search_template( self, + *, body: Optional[Any] = ..., id: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -698,10 +725,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def scripts_painless_execute( self, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -712,10 +740,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def scroll( self, + *, body: Optional[Any] = ..., scroll_id: Optional[Any] = ..., rest_total_hits_as_int: Optional[Any] = ..., @@ -729,10 +758,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def search( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -787,10 +817,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def search_shards( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -807,10 +838,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def search_template( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -836,11 +868,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def termvectors( self, index: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., id: Optional[Any] = ..., @@ -864,12 +897,13 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update( self, index: Any, id: Any, + *, body: Any, doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -893,11 +927,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_by_query( self, index: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -944,11 +979,12 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_by_query_rethrottle( self, task_id: Any, + *, requests_per_second: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -959,10 +995,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_script_context( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -972,10 +1009,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_script_languages( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -985,10 +1023,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def close_point_in_time( self, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -999,10 +1038,11 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def open_point_in_time( self, + *, index: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -1018,5 +1058,5 @@ class Elasticsearch(object): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/async_search.py b/elasticsearch/client/async_search.py index 30ba8e8f..5738ba67 100644 --- a/elasticsearch/client/async_search.py +++ b/elasticsearch/client/async_search.py @@ -24,6 +24,7 @@ class AsyncSearchClient(NamespacedClient): """ 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,6 +41,7 @@ class AsyncSearchClient(NamespacedClient): """ Retrieves the results of a previously submitted async search request given its ID. + ``_ :arg id: The async search ID @@ -103,6 +105,7 @@ class AsyncSearchClient(NamespacedClient): 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 diff --git a/elasticsearch/client/async_search.pyi b/elasticsearch/client/async_search.pyi index 0f656e6a..1c67eb10 100644 --- a/elasticsearch/client/async_search.pyi +++ b/elasticsearch/client/async_search.pyi @@ -22,6 +22,7 @@ class AsyncSearchClient(NamespacedClient): def delete( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class AsyncSearchClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get( self, id: Any, + *, keep_alive: Optional[Any] = ..., typed_keys: Optional[Any] = ..., wait_for_completion_timeout: Optional[Any] = ..., @@ -48,10 +50,11 @@ class AsyncSearchClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def submit( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., _source: Optional[Any] = ..., @@ -104,5 +107,5 @@ class AsyncSearchClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/autoscaling.py b/elasticsearch/client/autoscaling.py index 751754ff..d2dc7ed0 100644 --- a/elasticsearch/client/autoscaling.py +++ b/elasticsearch/client/autoscaling.py @@ -24,6 +24,7 @@ class AutoscalingClient(NamespacedClient): """ Gets the current autoscaling decision based on the configured autoscaling policy, indicating whether or not autoscaling is needed. + ``_ """ return self.transport.perform_request( @@ -34,6 +35,7 @@ class AutoscalingClient(NamespacedClient): def delete_autoscaling_policy(self, name, params=None, headers=None): """ Deletes an autoscaling policy. + ``_ :arg name: the name of the autoscaling policy @@ -52,6 +54,7 @@ class AutoscalingClient(NamespacedClient): def get_autoscaling_policy(self, name, params=None, headers=None): """ Retrieves an autoscaling policy. + ``_ :arg name: the name of the autoscaling policy @@ -70,6 +73,7 @@ class AutoscalingClient(NamespacedClient): def put_autoscaling_policy(self, name, body, params=None, headers=None): """ Creates a new autoscaling policy. + ``_ :arg name: the name of the autoscaling policy diff --git a/elasticsearch/client/autoscaling.pyi b/elasticsearch/client/autoscaling.pyi index 3a5c29be..d9e786d6 100644 --- a/elasticsearch/client/autoscaling.pyi +++ b/elasticsearch/client/autoscaling.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class AutoscalingClient(NamespacedClient): def get_autoscaling_decision( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,11 +31,12 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_autoscaling_policy( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -44,11 +46,12 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_autoscaling_policy( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -58,11 +61,12 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_autoscaling_policy( self, name: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -73,5 +77,5 @@ class AutoscalingClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/cat.py b/elasticsearch/client/cat.py index be424be5..9a1b68a2 100644 --- a/elasticsearch/client/cat.py +++ b/elasticsearch/client/cat.py @@ -24,6 +24,7 @@ class CatClient(NamespacedClient): """ Shows information about currently configured aliases to indices including filter and routing infos. + ``_ :arg name: A comma-separated list of alias names to return @@ -49,6 +50,7 @@ class CatClient(NamespacedClient): """ 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 @@ -79,6 +81,7 @@ class CatClient(NamespacedClient): """ 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 @@ -99,6 +102,7 @@ class CatClient(NamespacedClient): 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, @@ -120,6 +124,7 @@ class CatClient(NamespacedClient): def help(self, params=None, headers=None): """ Returns help for the Cat APIs. + ``_ :arg help: Return help information @@ -149,6 +154,7 @@ class CatClient(NamespacedClient): """ 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 @@ -187,6 +193,7 @@ class CatClient(NamespacedClient): 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, @@ -220,6 +227,7 @@ class CatClient(NamespacedClient): 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 @@ -250,6 +258,7 @@ class CatClient(NamespacedClient): 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 @@ -280,6 +289,7 @@ class CatClient(NamespacedClient): 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 @@ -308,6 +318,7 @@ class CatClient(NamespacedClient): 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 @@ -330,6 +341,7 @@ class CatClient(NamespacedClient): 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, @@ -355,6 +367,7 @@ class CatClient(NamespacedClient): """ 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- @@ -385,6 +398,7 @@ class CatClient(NamespacedClient): """ 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 @@ -410,6 +424,7 @@ class CatClient(NamespacedClient): 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, @@ -432,6 +447,7 @@ class CatClient(NamespacedClient): 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, @@ -454,6 +470,7 @@ class CatClient(NamespacedClient): 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, @@ -478,6 +495,7 @@ class CatClient(NamespacedClient): 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 @@ -519,6 +537,7 @@ class CatClient(NamespacedClient): """ 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 @@ -548,6 +567,7 @@ class CatClient(NamespacedClient): def templates(self, name=None, params=None, headers=None): """ Returns information about existing templates. + ``_ :arg name: A pattern that returned template names must match @@ -571,6 +591,7 @@ class CatClient(NamespacedClient): 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 @@ -602,6 +623,7 @@ class CatClient(NamespacedClient): 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 @@ -642,6 +664,7 @@ class CatClient(NamespacedClient): 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 @@ -685,6 +708,7 @@ class CatClient(NamespacedClient): 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 @@ -723,6 +747,7 @@ class CatClient(NamespacedClient): 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 diff --git a/elasticsearch/client/cat.pyi b/elasticsearch/client/cat.pyi index 091fd083..bf2317e5 100644 --- a/elasticsearch/client/cat.pyi +++ b/elasticsearch/client/cat.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class CatClient(NamespacedClient): def aliases( self, + *, name: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., format: Optional[Any] = ..., @@ -37,10 +38,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def allocation( self, + *, node_id: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -58,10 +60,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def count( self, + *, index: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -76,10 +79,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def health( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -95,10 +99,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def help( self, + *, help: Optional[Any] = ..., s: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -110,10 +115,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def indices( self, + *, index: Optional[Any] = ..., bytes: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -136,10 +142,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def master( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -155,10 +162,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def nodes( self, + *, bytes: Optional[Any] = ..., format: Optional[Any] = ..., full_id: Optional[Any] = ..., @@ -177,10 +185,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def recovery( self, + *, index: Optional[Any] = ..., active_only: Optional[Any] = ..., bytes: Optional[Any] = ..., @@ -199,10 +208,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def shards( self, + *, index: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -221,10 +231,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def segments( self, + *, index: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -240,10 +251,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def pending_tasks( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -260,10 +272,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def thread_pool( self, + *, thread_pool_patterns: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -281,10 +294,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def fielddata( self, + *, fields: Optional[Any] = ..., bytes: Optional[Any] = ..., format: Optional[Any] = ..., @@ -300,10 +314,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def plugins( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -319,10 +334,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def nodeattrs( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -338,10 +354,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def repositories( self, + *, format: Optional[Any] = ..., h: Optional[Any] = ..., help: Optional[Any] = ..., @@ -357,10 +374,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def snapshots( self, + *, repository: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -378,10 +396,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def tasks( self, + *, actions: Optional[Any] = ..., detailed: Optional[Any] = ..., format: Optional[Any] = ..., @@ -400,10 +419,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def templates( self, + *, name: Optional[Any] = ..., format: Optional[Any] = ..., h: Optional[Any] = ..., @@ -420,10 +440,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def ml_data_frame_analytics( self, + *, id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., bytes: Optional[Any] = ..., @@ -441,10 +462,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def ml_datafeeds( self, + *, datafeed_id: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -462,10 +484,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def ml_jobs( self, + *, job_id: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -484,10 +507,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def ml_trained_models( self, + *, model_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., bytes: Optional[Any] = ..., @@ -507,10 +531,11 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def transforms( self, + *, transform_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., format: Optional[Any] = ..., @@ -529,5 +554,5 @@ class CatClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/ccr.py b/elasticsearch/client/ccr.py index 02d82057..b7e2046c 100644 --- a/elasticsearch/client/ccr.py +++ b/elasticsearch/client/ccr.py @@ -23,6 +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,6 +42,7 @@ class CcrClient(NamespacedClient): 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 @@ -69,6 +71,7 @@ class CcrClient(NamespacedClient): """ 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` @@ -86,6 +89,7 @@ class CcrClient(NamespacedClient): """ 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` @@ -102,6 +106,7 @@ class CcrClient(NamespacedClient): 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 @@ -128,6 +133,7 @@ class CcrClient(NamespacedClient): """ Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + ``_ :arg name: The name of the auto follow pattern. @@ -144,6 +150,7 @@ class CcrClient(NamespacedClient): """ 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 @@ -165,6 +172,7 @@ class CcrClient(NamespacedClient): 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. @@ -186,6 +194,7 @@ class CcrClient(NamespacedClient): 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. @@ -207,6 +216,7 @@ class CcrClient(NamespacedClient): def stats(self, params=None, headers=None): """ Gets all stats related to cross-cluster replication. + ``_ """ return self.transport.perform_request( @@ -218,6 +228,7 @@ class CcrClient(NamespacedClient): """ 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 @@ -237,6 +248,7 @@ class CcrClient(NamespacedClient): 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 @@ -256,6 +268,7 @@ class CcrClient(NamespacedClient): 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 diff --git a/elasticsearch/client/ccr.pyi b/elasticsearch/client/ccr.pyi index d76515e3..0d59b77d 100644 --- a/elasticsearch/client/ccr.pyi +++ b/elasticsearch/client/ccr.pyi @@ -22,6 +22,7 @@ class CcrClient(NamespacedClient): def delete_auto_follow_pattern( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def follow( self, index: Any, + *, body: Any, wait_for_active_shards: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -47,11 +49,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def follow_info( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -61,11 +64,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def follow_stats( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -75,11 +79,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def forget_follower( self, index: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -90,10 +95,11 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_auto_follow_pattern( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -104,11 +110,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def pause_follow( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -118,11 +125,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_auto_follow_pattern( self, name: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -133,11 +141,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def resume_follow( self, index: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -148,10 +157,11 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stats( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -161,11 +171,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def unfollow( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -175,11 +186,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def pause_auto_follow_pattern( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -189,11 +201,12 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def resume_auto_follow_pattern( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -203,5 +216,5 @@ class CcrClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/cluster.py b/elasticsearch/client/cluster.py index e8b036b5..539e4fc5 100644 --- a/elasticsearch/client/cluster.py +++ b/elasticsearch/client/cluster.py @@ -35,6 +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 @@ -74,6 +75,7 @@ class ClusterClient(NamespacedClient): """ 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 @@ -97,6 +99,7 @@ class ClusterClient(NamespacedClient): 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 @@ -136,6 +139,7 @@ class ClusterClient(NamespacedClient): 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 @@ -161,6 +165,7 @@ class ClusterClient(NamespacedClient): 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`, @@ -186,6 +191,7 @@ class ClusterClient(NamespacedClient): def get_settings(self, params=None, headers=None): """ Returns cluster settings. + ``_ :arg flat_settings: Return settings in flat format (default: @@ -204,6 +210,7 @@ class ClusterClient(NamespacedClient): def put_settings(self, body, params=None, headers=None): """ Updates the cluster settings. + ``_ :arg body: The settings to be updated. Can be either `transient` @@ -225,6 +232,7 @@ class ClusterClient(NamespacedClient): def remote_info(self, params=None, headers=None): """ Returns the information about configured remote clusters. + ``_ """ return self.transport.perform_request( @@ -235,6 +243,7 @@ class ClusterClient(NamespacedClient): 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 @@ -256,6 +265,7 @@ class ClusterClient(NamespacedClient): def delete_component_template(self, name, params=None, headers=None): """ Deletes a component template + ``_ :arg name: The name of the template @@ -276,6 +286,7 @@ class ClusterClient(NamespacedClient): 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 @@ -295,6 +306,7 @@ class ClusterClient(NamespacedClient): def put_component_template(self, name, body, params=None, headers=None): """ Creates or updates a component template + ``_ :arg name: The name of the template @@ -320,6 +332,7 @@ class ClusterClient(NamespacedClient): 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 @@ -342,6 +355,7 @@ class ClusterClient(NamespacedClient): 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 @@ -359,6 +373,7 @@ class ClusterClient(NamespacedClient): 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 diff --git a/elasticsearch/client/cluster.pyi b/elasticsearch/client/cluster.pyi index db9b84ae..7d2c87d6 100644 --- a/elasticsearch/client/cluster.pyi +++ b/elasticsearch/client/cluster.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class ClusterClient(NamespacedClient): def health( self, + *, index: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., level: Optional[Any] = ..., @@ -42,10 +43,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def pending_tasks( self, + *, local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -57,10 +59,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def state( self, + *, metric: Optional[Any] = ..., index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -80,10 +83,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stats( self, + *, node_id: Optional[Any] = ..., flat_settings: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -96,10 +100,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def reroute( self, + *, body: Optional[Any] = ..., dry_run: Optional[Any] = ..., explain: Optional[Any] = ..., @@ -116,10 +121,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_settings( self, + *, flat_settings: Optional[Any] = ..., include_defaults: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -133,10 +139,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_settings( self, + *, body: Any, flat_settings: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -150,10 +157,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def remote_info( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -163,10 +171,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def allocation_explain( self, + *, body: Optional[Any] = ..., include_disk_info: Optional[Any] = ..., include_yes_decisions: Optional[Any] = ..., @@ -179,11 +188,12 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_component_template( self, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -195,10 +205,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_component_template( self, + *, name: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -211,11 +222,12 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_component_template( self, name: Any, + *, body: Any, create: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -229,11 +241,12 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def exists_component_template( self, name: Any, + *, local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -245,10 +258,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def delete_voting_config_exclusions( self, + *, wait_for_removal: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -259,10 +273,11 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def post_voting_config_exclusions( self, + *, node_ids: Optional[Any] = ..., node_names: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -275,5 +290,5 @@ class ClusterClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/dangling_indices.py b/elasticsearch/client/dangling_indices.py index 048845b6..86c56c50 100644 --- a/elasticsearch/client/dangling_indices.py +++ b/elasticsearch/client/dangling_indices.py @@ -23,6 +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 @@ -45,6 +46,7 @@ class DanglingIndicesClient(NamespacedClient): 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 @@ -64,6 +66,7 @@ class DanglingIndicesClient(NamespacedClient): def list_dangling_indices(self, params=None, headers=None): """ Returns all dangling indices. + ``_ """ return self.transport.perform_request( diff --git a/elasticsearch/client/dangling_indices.pyi b/elasticsearch/client/dangling_indices.pyi index 6e373c5f..c186bf72 100644 --- a/elasticsearch/client/dangling_indices.pyi +++ b/elasticsearch/client/dangling_indices.pyi @@ -22,6 +22,7 @@ class DanglingIndicesClient(NamespacedClient): def delete_dangling_index( self, index_uuid: Any, + *, accept_data_loss: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -34,11 +35,12 @@ class DanglingIndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def import_dangling_index( self, index_uuid: Any, + *, accept_data_loss: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -51,10 +53,11 @@ class DanglingIndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def list_dangling_indices( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -64,5 +67,5 @@ class DanglingIndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/data_frame.py b/elasticsearch/client/data_frame.py index 61eb4fb0..5d5c2da0 100644 --- a/elasticsearch/client/data_frame.py +++ b/elasticsearch/client/data_frame.py @@ -68,6 +68,7 @@ class Data_FrameClient(NamespacedClient): "GET", _make_path("_data_frame", "transforms", transform_id, "_stats"), params=params, + headers=headers, ) @query_params() diff --git a/elasticsearch/client/data_frame.pyi b/elasticsearch/client/data_frame.pyi index 13e3ce3c..759746c0 100644 --- a/elasticsearch/client/data_frame.pyi +++ b/elasticsearch/client/data_frame.pyi @@ -22,6 +22,7 @@ class Data_FrameClient(NamespacedClient): def delete_data_frame_transform( self, transform_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -35,6 +36,7 @@ class Data_FrameClient(NamespacedClient): ) -> Any: ... def get_data_frame_transform( self, + *, transform_id: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., @@ -52,6 +54,7 @@ class Data_FrameClient(NamespacedClient): def get_data_frame_transform_stats( self, transform_id: Optional[Any], + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -65,6 +68,7 @@ class Data_FrameClient(NamespacedClient): ) -> Any: ... def preview_data_frame_transform( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -80,6 +84,7 @@ class Data_FrameClient(NamespacedClient): def put_data_frame_transform( self, transform_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -95,6 +100,7 @@ class Data_FrameClient(NamespacedClient): def start_data_frame_transform( self, transform_id: Any, + *, timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -110,6 +116,7 @@ class Data_FrameClient(NamespacedClient): def stop_data_frame_transform( self, transform_id: Any, + *, timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., diff --git a/elasticsearch/client/deprecation.pyi b/elasticsearch/client/deprecation.pyi index f4f9761e..f983ad01 100644 --- a/elasticsearch/client/deprecation.pyi +++ b/elasticsearch/client/deprecation.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class DeprecationClient(NamespacedClient): def info( self, + *, index: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., diff --git a/elasticsearch/client/enrich.py b/elasticsearch/client/enrich.py index 7ad6dc1b..6edd2ea6 100644 --- a/elasticsearch/client/enrich.py +++ b/elasticsearch/client/enrich.py @@ -23,6 +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,6 +42,7 @@ class EnrichClient(NamespacedClient): 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 @@ -61,6 +63,7 @@ class EnrichClient(NamespacedClient): 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,6 +76,7 @@ class EnrichClient(NamespacedClient): def put_policy(self, name, body, params=None, headers=None): """ Creates a new enrich policy. + ``_ :arg name: The name of the enrich policy @@ -95,6 +99,7 @@ class EnrichClient(NamespacedClient): """ Gets enrich coordinator statistics and information about enrich policies that are currently executing. + ``_ """ return self.transport.perform_request( diff --git a/elasticsearch/client/enrich.pyi b/elasticsearch/client/enrich.pyi index eff70982..288c3417 100644 --- a/elasticsearch/client/enrich.pyi +++ b/elasticsearch/client/enrich.pyi @@ -22,6 +22,7 @@ class EnrichClient(NamespacedClient): def delete_policy( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def execute_policy( self, name: Any, + *, wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -46,10 +48,11 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_policy( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -60,11 +63,12 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_policy( self, name: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -75,10 +79,11 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stats( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -88,5 +93,5 @@ class EnrichClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/eql.py b/elasticsearch/client/eql.py index e954f20f..499febef 100644 --- a/elasticsearch/client/eql.py +++ b/elasticsearch/client/eql.py @@ -23,6 +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 @@ -53,6 +54,7 @@ class EqlClient(NamespacedClient): """ 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,6 +71,7 @@ class EqlClient(NamespacedClient): """ Returns async results from previously executed Event Query Language (EQL) search + ``_ :arg id: The async search ID diff --git a/elasticsearch/client/eql.pyi b/elasticsearch/client/eql.pyi index 4a32b245..88bbb089 100644 --- a/elasticsearch/client/eql.pyi +++ b/elasticsearch/client/eql.pyi @@ -22,6 +22,7 @@ class EqlClient(NamespacedClient): def search( self, index: Any, + *, body: Any, keep_alive: Optional[Any] = ..., keep_on_completion: Optional[Any] = ..., @@ -35,11 +36,12 @@ class EqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -49,11 +51,12 @@ class EqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get( self, id: Any, + *, keep_alive: Optional[Any] = ..., wait_for_completion_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -65,5 +68,5 @@ class EqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/graph.py b/elasticsearch/client/graph.py index 22be9443..4203cbd3 100644 --- a/elasticsearch/client/graph.py +++ b/elasticsearch/client/graph.py @@ -24,6 +24,7 @@ class GraphClient(NamespacedClient): """ 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 diff --git a/elasticsearch/client/graph.pyi b/elasticsearch/client/graph.pyi index dba1b8ac..a00b25fe 100644 --- a/elasticsearch/client/graph.pyi +++ b/elasticsearch/client/graph.pyi @@ -22,6 +22,7 @@ class GraphClient(NamespacedClient): def explore( self, index: Any, + *, body: Optional[Any] = ..., doc_type: Optional[Any] = ..., routing: Optional[Any] = ..., @@ -35,5 +36,5 @@ class GraphClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/ilm.py b/elasticsearch/client/ilm.py index b88e729f..677a3a4a 100644 --- a/elasticsearch/client/ilm.py +++ b/elasticsearch/client/ilm.py @@ -24,6 +24,7 @@ class IlmClient(NamespacedClient): """ Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. + ``_ :arg policy: The name of the index lifecycle policy @@ -43,6 +44,7 @@ class IlmClient(NamespacedClient): """ 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 @@ -63,6 +65,7 @@ class IlmClient(NamespacedClient): """ Returns the specified policy definition. Includes the policy version and last modified date. + ``_ :arg policy: The name of the index lifecycle policy @@ -75,6 +78,7 @@ class IlmClient(NamespacedClient): def get_status(self, params=None, headers=None): """ Retrieves the current index lifecycle management (ILM) status. + ``_ """ return self.transport.perform_request( @@ -85,6 +89,7 @@ class IlmClient(NamespacedClient): 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 @@ -106,6 +111,7 @@ class IlmClient(NamespacedClient): def put_lifecycle(self, policy, body=None, params=None, headers=None): """ Creates a lifecycle policy + ``_ :arg policy: The name of the index lifecycle policy @@ -126,6 +132,7 @@ class IlmClient(NamespacedClient): 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,6 +148,7 @@ class IlmClient(NamespacedClient): 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 @@ -157,6 +165,7 @@ class IlmClient(NamespacedClient): def start(self, params=None, headers=None): """ Start the index lifecycle management (ILM) plugin. + ``_ """ return self.transport.perform_request( @@ -168,6 +177,7 @@ class IlmClient(NamespacedClient): """ Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + ``_ """ return self.transport.perform_request( diff --git a/elasticsearch/client/ilm.pyi b/elasticsearch/client/ilm.pyi index 531f891d..1a3b473d 100644 --- a/elasticsearch/client/ilm.pyi +++ b/elasticsearch/client/ilm.pyi @@ -22,6 +22,7 @@ class IlmClient(NamespacedClient): def delete_lifecycle( self, policy: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def explain_lifecycle( self, index: Any, + *, only_errors: Optional[Any] = ..., only_managed: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -47,10 +49,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_lifecycle( self, + *, policy: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -61,10 +64,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -74,11 +78,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def move_to_step( self, index: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -89,11 +94,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_lifecycle( self, policy: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -104,11 +110,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def remove_policy( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -118,11 +125,12 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def retry( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -132,10 +140,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def start( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -145,10 +154,11 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stop( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -158,5 +168,5 @@ class IlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/indices.py b/elasticsearch/client/indices.py index 3a8d8284..ec4e9b7e 100644 --- a/elasticsearch/client/indices.py +++ b/elasticsearch/client/indices.py @@ -24,6 +24,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -42,6 +43,7 @@ class IndicesClient(NamespacedClient): 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 @@ -69,6 +71,7 @@ class IndicesClient(NamespacedClient): 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 @@ -101,6 +104,7 @@ class IndicesClient(NamespacedClient): 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 @@ -124,6 +128,7 @@ class IndicesClient(NamespacedClient): def clone(self, index, target, body=None, params=None, headers=None): """ Clones an index + ``_ :arg index: The name of the source index to clone @@ -160,6 +165,7 @@ class IndicesClient(NamespacedClient): def get(self, index, params=None, headers=None): """ Returns information about one or more indices. + ``_ :arg index: A comma-separated list of index names @@ -198,6 +204,7 @@ class IndicesClient(NamespacedClient): def open(self, index, params=None, headers=None): """ Opens an index. + ``_ :arg index: A comma separated list of indices to open @@ -232,6 +239,7 @@ class IndicesClient(NamespacedClient): def close(self, index, params=None, headers=None): """ Closes an index. + ``_ :arg index: A comma separated list of indices to close @@ -265,6 +273,7 @@ class IndicesClient(NamespacedClient): def delete(self, index, params=None, headers=None): """ Deletes an index. + ``_ :arg index: A comma-separated list of indices to delete; use @@ -297,6 +306,7 @@ class IndicesClient(NamespacedClient): 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 @@ -326,6 +336,7 @@ class IndicesClient(NamespacedClient): """ Returns information about whether a particular document type exists. (DEPRECATED) + ``_ :arg index: A comma-separated list of index names; use `_all` to @@ -365,6 +376,7 @@ class IndicesClient(NamespacedClient): def put_mapping(self, body, index=None, doc_type=None, params=None, headers=None): """ Updates the index mappings. + ``_ :arg body: The mapping definition @@ -412,6 +424,7 @@ class IndicesClient(NamespacedClient): 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 @@ -450,6 +463,7 @@ class IndicesClient(NamespacedClient): ): """ Returns mapping for one or more fields. + ``_ :arg fields: A comma-separated list of fields @@ -484,6 +498,7 @@ class IndicesClient(NamespacedClient): 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 @@ -511,6 +526,7 @@ class IndicesClient(NamespacedClient): 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 @@ -538,6 +554,7 @@ class IndicesClient(NamespacedClient): 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 @@ -562,6 +579,7 @@ class IndicesClient(NamespacedClient): def update_aliases(self, body, params=None, headers=None): """ Updates index aliases. + ``_ :arg body: The definition of `actions` to perform @@ -579,6 +597,7 @@ class IndicesClient(NamespacedClient): def delete_alias(self, index, name, params=None, headers=None): """ Deletes an alias. + ``_ :arg index: A comma-separated list of index names (supports @@ -600,6 +619,7 @@ class IndicesClient(NamespacedClient): def put_template(self, name, body, params=None, headers=None): """ Creates or updates an index template. + ``_ :arg name: The name of the template @@ -629,6 +649,7 @@ class IndicesClient(NamespacedClient): 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 @@ -650,6 +671,7 @@ class IndicesClient(NamespacedClient): def get_template(self, name=None, params=None, headers=None): """ Returns an index template. + ``_ :arg name: The comma separated names of the index templates @@ -670,6 +692,7 @@ class IndicesClient(NamespacedClient): def delete_template(self, name, params=None, headers=None): """ Deletes an index template. + ``_ :arg name: The name of the template @@ -695,6 +718,7 @@ class IndicesClient(NamespacedClient): 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 @@ -732,6 +756,7 @@ class IndicesClient(NamespacedClient): def put_settings(self, body, index=None, params=None, headers=None): """ Updates the index settings. + ``_ :arg body: The index settings to be updated @@ -779,6 +804,7 @@ class IndicesClient(NamespacedClient): 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 @@ -822,6 +848,7 @@ class IndicesClient(NamespacedClient): 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 @@ -859,6 +886,7 @@ class IndicesClient(NamespacedClient): ): """ Allows a user to validate a potentially expensive query without executing it. + ``_ :arg body: The query definition specified with the Query DSL @@ -912,6 +940,7 @@ class IndicesClient(NamespacedClient): 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 @@ -938,6 +967,7 @@ class IndicesClient(NamespacedClient): 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 @@ -961,6 +991,7 @@ class IndicesClient(NamespacedClient): 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 @@ -986,6 +1017,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1008,6 +1040,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1034,6 +1067,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1065,6 +1099,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1094,6 +1129,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1126,6 +1162,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1162,6 +1199,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1202,6 +1240,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1237,6 +1276,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1264,6 +1304,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1291,6 +1332,7 @@ class IndicesClient(NamespacedClient): def create_data_stream(self, name, params=None, headers=None): """ Creates a data stream + ``_ :arg name: The name of the data stream @@ -1306,6 +1348,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1322,6 +1365,7 @@ class IndicesClient(NamespacedClient): def delete_index_template(self, name, params=None, headers=None): """ Deletes an index template. + ``_ :arg name: The name of the template @@ -1342,6 +1386,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1363,6 +1408,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1381,6 +1427,7 @@ class IndicesClient(NamespacedClient): def put_index_template(self, name, body, params=None, headers=None): """ Creates or updates an index template. + ``_ :arg name: The name of the template @@ -1408,6 +1455,7 @@ class IndicesClient(NamespacedClient): """ 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 @@ -1436,6 +1484,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1449,6 +1498,7 @@ class IndicesClient(NamespacedClient): 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 @@ -1473,6 +1523,7 @@ class IndicesClient(NamespacedClient): def resolve_index(self, name, params=None, headers=None): """ Returns information about any matching indices, aliases, and data streams + ``_ :arg name: A comma-separated list of names or wildcard @@ -1498,6 +1549,7 @@ class IndicesClient(NamespacedClient): def add_block(self, index, block, params=None, headers=None): """ Adds a block to an index. + ``_ :arg index: A comma separated list of indices to add a block to @@ -1526,6 +1578,7 @@ class IndicesClient(NamespacedClient): 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 diff --git a/elasticsearch/client/indices.pyi b/elasticsearch/client/indices.pyi index 42002316..ce768a95 100644 --- a/elasticsearch/client/indices.pyi +++ b/elasticsearch/client/indices.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class IndicesClient(NamespacedClient): def analyze( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -32,10 +33,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def refresh( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -49,10 +51,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def flush( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -68,11 +71,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def create( self, index: Any, + *, body: Optional[Any] = ..., include_type_name: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -87,12 +91,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def clone( self, index: Any, target: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -106,11 +111,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., flat_settings: Optional[Any] = ..., @@ -128,11 +134,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def open( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -148,11 +155,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def close( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -168,11 +176,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -187,11 +196,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def exists( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., flat_settings: Optional[Any] = ..., @@ -207,12 +217,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def exists_type( self, index: Any, doc_type: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -226,10 +237,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def put_mapping( self, + *, body: Any, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -249,10 +261,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_mapping( self, + *, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -270,11 +283,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_field_mapping( self, fields: Any, + *, index: Optional[Any] = ..., doc_type: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -292,12 +306,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_alias( self, index: Any, name: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -310,11 +325,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def exists_alias( self, name: Any, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -329,10 +345,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def get_alias( self, + *, index: Optional[Any] = ..., name: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -348,10 +365,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_aliases( self, + *, body: Any, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -364,12 +382,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_alias( self, index: Any, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -381,11 +400,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_template( self, name: Any, + *, body: Any, create: Optional[Any] = ..., include_type_name: Optional[Any] = ..., @@ -400,11 +420,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def exists_template( self, name: Any, + *, flat_settings: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -417,10 +438,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def get_template( self, + *, name: Optional[Any] = ..., flat_settings: Optional[Any] = ..., include_type_name: Optional[Any] = ..., @@ -435,11 +457,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_template( self, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -451,10 +474,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_settings( self, + *, index: Optional[Any] = ..., name: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -473,10 +497,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_settings( self, + *, body: Any, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., @@ -495,10 +520,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stats( self, + *, index: Optional[Any] = ..., metric: Optional[Any] = ..., completion_fields: Optional[Any] = ..., @@ -520,10 +546,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def segments( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -538,10 +565,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def validate_query( self, + *, body: Optional[Any] = ..., index: Optional[Any] = ..., doc_type: Optional[Any] = ..., @@ -566,10 +594,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def clear_cache( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -587,10 +616,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def recovery( self, + *, index: Optional[Any] = ..., active_only: Optional[Any] = ..., detailed: Optional[Any] = ..., @@ -603,10 +633,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def upgrade( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -622,10 +653,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_upgrade( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -639,10 +671,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def flush_synced( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -656,10 +689,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def shard_stores( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -674,10 +708,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def forcemerge( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -694,12 +729,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def shrink( self, index: Any, target: Any, + *, body: Optional[Any] = ..., copy_settings: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -714,12 +750,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def split( self, index: Any, target: Any, + *, body: Optional[Any] = ..., copy_settings: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -734,11 +771,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def rollover( self, alias: Any, + *, body: Optional[Any] = ..., new_index: Optional[Any] = ..., dry_run: Optional[Any] = ..., @@ -755,11 +793,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def freeze( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -775,11 +814,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def unfreeze( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -795,11 +835,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def reload_search_analyzers( self, index: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -812,11 +853,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def create_data_stream( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -826,11 +868,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_data_stream( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -840,11 +883,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_index_template( self, name: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -856,11 +900,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def exists_index_template( self, name: Any, + *, flat_settings: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -873,10 +918,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> bool: ... def get_index_template( self, + *, name: Optional[Any] = ..., flat_settings: Optional[Any] = ..., local: Optional[Any] = ..., @@ -890,11 +936,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_index_template( self, name: Any, + *, body: Any, cause: Optional[Any] = ..., create: Optional[Any] = ..., @@ -908,11 +955,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def simulate_index_template( self, name: Any, + *, body: Optional[Any] = ..., cause: Optional[Any] = ..., create: Optional[Any] = ..., @@ -926,10 +974,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_data_stream( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -940,10 +989,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def simulate_template( self, + *, body: Optional[Any] = ..., name: Optional[Any] = ..., cause: Optional[Any] = ..., @@ -958,11 +1008,12 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def resolve_index( self, name: Any, + *, expand_wildcards: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -973,12 +1024,13 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def add_block( self, index: Any, block: Any, + *, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -993,10 +1045,11 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def data_streams_stats( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1007,5 +1060,5 @@ class IndicesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/ingest.py b/elasticsearch/client/ingest.py index 879983db..854aced6 100644 --- a/elasticsearch/client/ingest.py +++ b/elasticsearch/client/ingest.py @@ -23,6 +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 @@ -38,6 +39,7 @@ class IngestClient(NamespacedClient): def put_pipeline(self, id, body, params=None, headers=None): """ Creates or updates a pipeline. + ``_ :arg id: Pipeline ID @@ -62,6 +64,7 @@ class IngestClient(NamespacedClient): def delete_pipeline(self, id, params=None, headers=None): """ Deletes a pipeline. + ``_ :arg id: Pipeline ID @@ -83,6 +86,7 @@ class IngestClient(NamespacedClient): def simulate(self, body, id=None, params=None, headers=None): """ Allows to simulate a pipeline with example documents. + ``_ :arg body: The simulate definition @@ -105,6 +109,7 @@ class IngestClient(NamespacedClient): def processor_grok(self, params=None, headers=None): """ Returns a list of the built-in patterns. + ``_ """ return self.transport.perform_request( diff --git a/elasticsearch/client/ingest.pyi b/elasticsearch/client/ingest.pyi index 20c8072e..7a9cf610 100644 --- a/elasticsearch/client/ingest.pyi +++ b/elasticsearch/client/ingest.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class IngestClient(NamespacedClient): def get_pipeline( self, + *, id: Optional[Any] = ..., master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -32,11 +33,12 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_pipeline( self, id: Any, + *, body: Any, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -49,11 +51,12 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_pipeline( self, id: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -65,10 +68,11 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def simulate( self, + *, body: Any, id: Optional[Any] = ..., verbose: Optional[Any] = ..., @@ -81,10 +85,11 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def processor_grok( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -94,5 +99,5 @@ class IngestClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/license.py b/elasticsearch/client/license.py index 71481e26..198ff51a 100644 --- a/elasticsearch/client/license.py +++ b/elasticsearch/client/license.py @@ -23,6 +23,7 @@ class LicenseClient(NamespacedClient): def delete(self, params=None, headers=None): """ Deletes licensing information for the cluster + ``_ """ return self.transport.perform_request( @@ -33,6 +34,7 @@ class LicenseClient(NamespacedClient): def get(self, params=None, headers=None): """ Retrieves licensing information for the cluster + ``_ :arg accept_enterprise: If the active license is an enterprise @@ -48,6 +50,7 @@ class LicenseClient(NamespacedClient): def get_basic_status(self, params=None, headers=None): """ Retrieves information about the status of the basic license. + ``_ """ return self.transport.perform_request( @@ -58,6 +61,7 @@ class LicenseClient(NamespacedClient): def get_trial_status(self, params=None, headers=None): """ Retrieves information about the status of the trial license. + ``_ """ return self.transport.perform_request( @@ -68,6 +72,7 @@ class LicenseClient(NamespacedClient): def post(self, body=None, params=None, headers=None): """ Updates the license for the cluster. + ``_ :arg body: licenses to be installed @@ -82,6 +87,7 @@ class LicenseClient(NamespacedClient): def post_start_basic(self, params=None, headers=None): """ Starts an indefinite basic license. + ``_ :arg acknowledge: whether the user has acknowledged acknowledge @@ -95,6 +101,7 @@ class LicenseClient(NamespacedClient): def post_start_trial(self, params=None, headers=None): """ starts a limited time trial license. + ``_ :arg acknowledge: whether the user has acknowledged acknowledge diff --git a/elasticsearch/client/license.pyi b/elasticsearch/client/license.pyi index 0032a694..a37a6df2 100644 --- a/elasticsearch/client/license.pyi +++ b/elasticsearch/client/license.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class LicenseClient(NamespacedClient): def delete( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,10 +31,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get( self, + *, accept_enterprise: Optional[Any] = ..., local: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -45,10 +47,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_basic_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -58,10 +61,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_trial_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -71,10 +75,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def post( self, + *, body: Optional[Any] = ..., acknowledge: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -86,10 +91,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def post_start_basic( self, + *, acknowledge: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -100,10 +106,11 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def post_start_trial( self, + *, acknowledge: Optional[Any] = ..., doc_type: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -115,5 +122,5 @@ class LicenseClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/migration.py b/elasticsearch/client/migration.py index 9af859a5..60edfe8a 100644 --- a/elasticsearch/client/migration.py +++ b/elasticsearch/client/migration.py @@ -25,6 +25,7 @@ class MigrationClient(NamespacedClient): 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/migration.pyi b/elasticsearch/client/migration.pyi index 8f561236..fd628b2d 100644 --- a/elasticsearch/client/migration.pyi +++ b/elasticsearch/client/migration.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class MigrationClient(NamespacedClient): def deprecations( self, + *, index: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -31,5 +32,5 @@ class MigrationClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/ml.py b/elasticsearch/client/ml.py index bea50a20..1f556f28 100644 --- a/elasticsearch/client/ml.py +++ b/elasticsearch/client/ml.py @@ -24,6 +24,7 @@ class MlClient(NamespacedClient): """ 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 @@ -53,6 +54,7 @@ class MlClient(NamespacedClient): def delete_calendar(self, calendar_id, params=None, headers=None): """ Deletes a calendar. + ``_ :arg calendar_id: The ID of the calendar to delete @@ -73,6 +75,7 @@ class MlClient(NamespacedClient): 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 @@ -93,6 +96,7 @@ class MlClient(NamespacedClient): 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 @@ -113,6 +117,7 @@ class MlClient(NamespacedClient): def delete_datafeed(self, datafeed_id, params=None, headers=None): """ Deletes an existing datafeed. + ``_ :arg datafeed_id: The ID of the datafeed to delete @@ -134,6 +139,7 @@ class MlClient(NamespacedClient): 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 @@ -156,6 +162,7 @@ class MlClient(NamespacedClient): def delete_filter(self, filter_id, params=None, headers=None): """ Deletes a filter. + ``_ :arg filter_id: The ID of the filter to delete @@ -174,6 +181,7 @@ class MlClient(NamespacedClient): 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 @@ -198,6 +206,7 @@ class MlClient(NamespacedClient): 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 @@ -219,6 +228,7 @@ class MlClient(NamespacedClient): 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 @@ -257,6 +267,7 @@ class MlClient(NamespacedClient): """ 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 @@ -308,6 +319,7 @@ class MlClient(NamespacedClient): 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 @@ -338,6 +350,7 @@ class MlClient(NamespacedClient): 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 @@ -371,6 +384,7 @@ class MlClient(NamespacedClient): 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 @@ -408,6 +422,7 @@ class MlClient(NamespacedClient): 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 @@ -438,6 +453,7 @@ class MlClient(NamespacedClient): 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 @@ -464,6 +480,7 @@ class MlClient(NamespacedClient): ): """ Retrieves anomaly detection job results for one or more categories. + ``_ :arg job_id: The name of the job @@ -497,6 +514,7 @@ class MlClient(NamespacedClient): 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 @@ -514,10 +532,11 @@ class MlClient(NamespacedClient): headers=headers, ) - @query_params("allow_no_datafeeds", "allow_no_match") + @query_params("allow_no_datafeeds", "allow_no_match", "exclude_generated") 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 @@ -527,6 +546,8 @@ class MlClient(NamespacedClient): :arg allow_no_match: Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + :arg exclude_generated: Omits fields that are illegal to set on + datafeed PUT """ return self.transport.perform_request( "GET", @@ -539,6 +560,7 @@ class MlClient(NamespacedClient): def get_filters(self, filter_id=None, params=None, headers=None): """ Retrieves filters. + ``_ :arg filter_id: The ID of the filter to fetch @@ -569,6 +591,7 @@ class MlClient(NamespacedClient): 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 @@ -603,6 +626,7 @@ class MlClient(NamespacedClient): 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 @@ -620,10 +644,11 @@ class MlClient(NamespacedClient): headers=headers, ) - @query_params("allow_no_jobs", "allow_no_match") + @query_params("allow_no_jobs", "allow_no_match", "exclude_generated") 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 @@ -633,6 +658,8 @@ class MlClient(NamespacedClient): :arg allow_no_match: Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + :arg exclude_generated: Omits fields that are illegal to set on + job PUT """ return self.transport.perform_request( "GET", @@ -647,6 +674,7 @@ class MlClient(NamespacedClient): ): """ Retrieves information about model snapshots. + ``_ :arg job_id: The ID of the job to fetch @@ -692,6 +720,7 @@ class MlClient(NamespacedClient): """ 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 @@ -743,6 +772,7 @@ class MlClient(NamespacedClient): 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 @@ -776,6 +806,7 @@ class MlClient(NamespacedClient): def info(self, params=None, headers=None): """ Returns defaults and limits used by machine learning. + ``_ """ return self.transport.perform_request( @@ -786,6 +817,7 @@ class MlClient(NamespacedClient): 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 @@ -804,6 +836,7 @@ class MlClient(NamespacedClient): 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 @@ -825,6 +858,7 @@ class MlClient(NamespacedClient): 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 @@ -851,6 +885,7 @@ class MlClient(NamespacedClient): def preview_datafeed(self, datafeed_id, params=None, headers=None): """ Previews a datafeed. + ``_ :arg datafeed_id: The ID of the datafeed to preview @@ -871,6 +906,7 @@ class MlClient(NamespacedClient): 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 @@ -893,6 +929,7 @@ class MlClient(NamespacedClient): 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 @@ -915,6 +952,7 @@ class MlClient(NamespacedClient): def put_datafeed(self, datafeed_id, body, params=None, headers=None): """ Instantiates a datafeed. + ``_ :arg datafeed_id: The ID of the datafeed to create @@ -945,6 +983,7 @@ class MlClient(NamespacedClient): def put_filter(self, filter_id, body, params=None, headers=None): """ Instantiates a filter. + ``_ :arg filter_id: The ID of the filter to create @@ -966,6 +1005,7 @@ class MlClient(NamespacedClient): 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 @@ -989,6 +1029,7 @@ class MlClient(NamespacedClient): ): """ Reverts to a specific snapshot. + ``_ :arg job_id: The ID of the job to fetch @@ -1021,6 +1062,7 @@ class MlClient(NamespacedClient): """ 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. @@ -1036,6 +1078,7 @@ class MlClient(NamespacedClient): 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 @@ -1063,6 +1106,7 @@ class MlClient(NamespacedClient): def stop_datafeed(self, datafeed_id, body=None, params=None, headers=None): """ Stops one or more datafeeds. + ``_ :arg datafeed_id: The ID of the datafeed to stop @@ -1096,6 +1140,7 @@ class MlClient(NamespacedClient): 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 @@ -1126,6 +1171,7 @@ class MlClient(NamespacedClient): 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 @@ -1147,6 +1193,7 @@ class MlClient(NamespacedClient): 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 @@ -1170,6 +1217,7 @@ class MlClient(NamespacedClient): ): """ Updates certain properties of a snapshot. + ``_ :arg job_id: The ID of the job to fetch @@ -1199,6 +1247,7 @@ class MlClient(NamespacedClient): def validate(self, body, params=None, headers=None): """ Validates an anomaly detection job. + ``_ :arg body: The job config @@ -1218,6 +1267,7 @@ class MlClient(NamespacedClient): def validate_detector(self, body, params=None, headers=None): """ Validates an anomaly detection detector. + ``_ :arg body: The detector @@ -1237,6 +1287,7 @@ class MlClient(NamespacedClient): 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 @@ -1258,6 +1309,7 @@ class MlClient(NamespacedClient): def evaluate_data_frame(self, body, params=None, headers=None): """ Evaluates the data frame analytics for an annotated index. + ``_ :arg body: The evaluation definition @@ -1273,16 +1325,19 @@ class MlClient(NamespacedClient): body=body, ) - @query_params("allow_no_match", "from_", "size") + @query_params("allow_no_match", "exclude_generated", "from_", "size") 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 matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) Default: True + :arg exclude_generated: Omits fields that are illegal to set on + data frame analytics PUT :arg from_: skips a number of analytics :arg size: specifies a max number of analytics to get Default: 100 @@ -1302,6 +1357,7 @@ class MlClient(NamespacedClient): 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 @@ -1328,6 +1384,7 @@ class MlClient(NamespacedClient): 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 @@ -1349,6 +1406,7 @@ class MlClient(NamespacedClient): 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 @@ -1371,6 +1429,7 @@ class MlClient(NamespacedClient): 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 @@ -1399,6 +1458,7 @@ class MlClient(NamespacedClient): """ 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 @@ -1419,6 +1479,7 @@ class MlClient(NamespacedClient): ): """ Explains a data frame analytics config. + ``_ :arg body: The data frame analytics config to explain @@ -1435,7 +1496,7 @@ class MlClient(NamespacedClient): @query_params( "allow_no_match", "decompress_definition", - "for_export", + "exclude_generated", "from_", "include", "include_model_definition", @@ -1445,6 +1506,7 @@ class MlClient(NamespacedClient): 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 @@ -1454,8 +1516,8 @@ class MlClient(NamespacedClient): :arg decompress_definition: Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true. Default: True - :arg for_export: Omits fields that are illegal to set on model - PUT + :arg exclude_generated: Omits fields that are illegal to set on + model PUT :arg from_: skips a number of trained models :arg include: A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. @@ -1483,6 +1545,7 @@ class MlClient(NamespacedClient): 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 @@ -1508,6 +1571,7 @@ class MlClient(NamespacedClient): 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 @@ -1529,6 +1593,7 @@ class MlClient(NamespacedClient): def estimate_model_memory(self, body, params=None, headers=None): """ Estimates the model memory + ``_ :arg body: The analysis config, plus cardinality estimates for @@ -1549,6 +1614,7 @@ class MlClient(NamespacedClient): 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 diff --git a/elasticsearch/client/ml.pyi b/elasticsearch/client/ml.pyi index e958a81d..160ff618 100644 --- a/elasticsearch/client/ml.pyi +++ b/elasticsearch/client/ml.pyi @@ -22,6 +22,7 @@ class MlClient(NamespacedClient): def close_job( self, job_id: Any, + *, body: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -36,11 +37,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_calendar( self, calendar_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -50,12 +52,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_calendar_event( self, calendar_id: Any, event_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -65,12 +68,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_calendar_job( self, calendar_id: Any, job_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -80,11 +84,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_datafeed( self, datafeed_id: Any, + *, force: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -95,10 +100,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_expired_data( self, + *, body: Optional[Any] = ..., job_id: Optional[Any] = ..., requests_per_second: Optional[Any] = ..., @@ -112,11 +118,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_filter( self, filter_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -126,11 +133,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_forecast( self, job_id: Any, + *, forecast_id: Optional[Any] = ..., allow_no_forecasts: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -143,11 +151,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_job( self, job_id: Any, + *, force: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -159,12 +168,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_model_snapshot( self, job_id: Any, snapshot_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -174,10 +184,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def find_file_structure( self, + *, body: Any, charset: Optional[Any] = ..., column_names: Optional[Any] = ..., @@ -201,11 +212,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def flush_job( self, job_id: Any, + *, body: Optional[Any] = ..., advance_time: Optional[Any] = ..., calc_interim: Optional[Any] = ..., @@ -221,11 +233,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def forecast( self, job_id: Any, + *, duration: Optional[Any] = ..., expires_in: Optional[Any] = ..., max_model_memory: Optional[Any] = ..., @@ -238,11 +251,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_buckets( self, job_id: Any, + *, body: Optional[Any] = ..., timestamp: Optional[Any] = ..., anomaly_score: Optional[Any] = ..., @@ -263,11 +277,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_calendar_events( self, calendar_id: Any, + *, end: Optional[Any] = ..., from_: Optional[Any] = ..., job_id: Optional[Any] = ..., @@ -282,10 +297,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_calendars( self, + *, body: Optional[Any] = ..., calendar_id: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -299,11 +315,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_categories( self, job_id: Any, + *, body: Optional[Any] = ..., category_id: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -318,10 +335,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_datafeed_stats( self, + *, datafeed_id: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -334,13 +352,15 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_datafeeds( self, + *, datafeed_id: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -350,10 +370,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_filters( self, + *, filter_id: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., @@ -366,11 +387,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_influencers( self, job_id: Any, + *, body: Optional[Any] = ..., desc: Optional[Any] = ..., end: Optional[Any] = ..., @@ -389,10 +411,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_job_stats( self, + *, job_id: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -405,13 +428,15 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_jobs( self, + *, job_id: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -421,11 +446,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_model_snapshots( self, job_id: Any, + *, body: Optional[Any] = ..., snapshot_id: Optional[Any] = ..., desc: Optional[Any] = ..., @@ -443,11 +469,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_overall_buckets( self, job_id: Any, + *, body: Optional[Any] = ..., allow_no_jobs: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -466,11 +493,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_records( self, job_id: Any, + *, body: Optional[Any] = ..., desc: Optional[Any] = ..., end: Optional[Any] = ..., @@ -489,10 +517,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def info( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -502,11 +531,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def open_job( self, job_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -516,11 +546,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def post_calendar_events( self, calendar_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -531,11 +562,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def post_data( self, job_id: Any, + *, body: Any, reset_end: Optional[Any] = ..., reset_start: Optional[Any] = ..., @@ -548,11 +580,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def preview_datafeed( self, datafeed_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -562,11 +595,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_calendar( self, calendar_id: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -577,12 +611,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_calendar_job( self, calendar_id: Any, job_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -592,11 +627,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_datafeed( self, datafeed_id: Any, + *, body: Any, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -611,11 +647,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_filter( self, filter_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -626,11 +663,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_job( self, job_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -641,12 +679,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def revert_model_snapshot( self, job_id: Any, snapshot_id: Any, + *, body: Optional[Any] = ..., delete_intervening_results: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -658,10 +697,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def set_upgrade_mode( self, + *, enabled: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -673,11 +713,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def start_datafeed( self, datafeed_id: Any, + *, body: Optional[Any] = ..., end: Optional[Any] = ..., start: Optional[Any] = ..., @@ -691,11 +732,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stop_datafeed( self, datafeed_id: Any, + *, body: Optional[Any] = ..., allow_no_datafeeds: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., @@ -710,11 +752,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_datafeed( self, datafeed_id: Any, + *, body: Any, allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -729,11 +772,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_filter( self, filter_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -744,11 +788,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_job( self, job_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -759,12 +804,13 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_model_snapshot( self, job_id: Any, snapshot_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -775,10 +821,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def validate( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -789,10 +836,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def validate_detector( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -803,11 +851,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_data_frame_analytics( self, id: Any, + *, force: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -819,10 +868,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def evaluate_data_frame( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -833,12 +883,14 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_data_frame_analytics( self, + *, id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -850,10 +902,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_data_frame_analytics_stats( self, + *, id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -868,11 +921,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_data_frame_analytics( self, id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -883,11 +937,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def start_data_frame_analytics( self, id: Any, + *, body: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -899,11 +954,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stop_data_frame_analytics( self, id: Any, + *, body: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., force: Optional[Any] = ..., @@ -917,11 +973,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_trained_model( self, model_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -931,10 +988,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def explain_data_frame_analytics( self, + *, body: Optional[Any] = ..., id: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -946,14 +1004,15 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_trained_models( self, + *, model_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., decompress_definition: Optional[Any] = ..., - for_export: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., from_: Optional[Any] = ..., include: Optional[Any] = ..., include_model_definition: Optional[Any] = ..., @@ -968,10 +1027,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_trained_models_stats( self, + *, model_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., from_: Optional[Any] = ..., @@ -985,11 +1045,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_trained_model( self, model_id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1000,10 +1061,11 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def estimate_model_memory( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1014,11 +1076,12 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_data_frame_analytics( self, id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -1029,5 +1092,5 @@ class MlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/monitoring.py b/elasticsearch/client/monitoring.py index 7afb5a58..665041cc 100644 --- a/elasticsearch/client/monitoring.py +++ b/elasticsearch/client/monitoring.py @@ -23,6 +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 diff --git a/elasticsearch/client/monitoring.pyi b/elasticsearch/client/monitoring.pyi index 88880b2d..3a9fdbed 100644 --- a/elasticsearch/client/monitoring.pyi +++ b/elasticsearch/client/monitoring.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class MonitoringClient(NamespacedClient): def bulk( self, + *, body: Any, doc_type: Optional[Any] = ..., interval: Optional[Any] = ..., @@ -35,5 +36,5 @@ class MonitoringClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/nodes.py b/elasticsearch/client/nodes.py index 0ee89620..a670e143 100644 --- a/elasticsearch/client/nodes.py +++ b/elasticsearch/client/nodes.py @@ -25,6 +25,7 @@ class NodesClient(NamespacedClient): ): """ Reloads secure settings. + ``_ :arg body: An object containing the password for the @@ -46,6 +47,7 @@ class NodesClient(NamespacedClient): 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 @@ -78,6 +80,7 @@ class NodesClient(NamespacedClient): ): """ Returns statistical information about nodes in the cluster. + ``_ :arg node_id: A comma-separated list of node IDs or names to @@ -122,6 +125,7 @@ class NodesClient(NamespacedClient): 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 @@ -155,6 +159,7 @@ class NodesClient(NamespacedClient): 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 diff --git a/elasticsearch/client/nodes.pyi b/elasticsearch/client/nodes.pyi index bb6b4f50..021e816c 100644 --- a/elasticsearch/client/nodes.pyi +++ b/elasticsearch/client/nodes.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class NodesClient(NamespacedClient): def reload_secure_settings( self, + *, body: Optional[Any] = ..., node_id: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -33,10 +34,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def info( self, + *, node_id: Optional[Any] = ..., metric: Optional[Any] = ..., flat_settings: Optional[Any] = ..., @@ -50,10 +52,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stats( self, + *, node_id: Optional[Any] = ..., metric: Optional[Any] = ..., index_metric: Optional[Any] = ..., @@ -74,10 +77,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def hot_threads( self, + *, node_id: Optional[Any] = ..., doc_type: Optional[Any] = ..., ignore_idle_threads: Optional[Any] = ..., @@ -94,10 +98,11 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def usage( self, + *, node_id: Optional[Any] = ..., metric: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -110,5 +115,5 @@ class NodesClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/remote.pyi b/elasticsearch/client/remote.pyi index 5703f4d2..a624d84e 100644 --- a/elasticsearch/client/remote.pyi +++ b/elasticsearch/client/remote.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class RemoteClient(NamespacedClient): def info( self, + *, timeout: Optional[Any] = None, pretty: Optional[bool] = None, human: Optional[bool] = None, diff --git a/elasticsearch/client/rollup.py b/elasticsearch/client/rollup.py index a2886fb2..7c81b3e9 100644 --- a/elasticsearch/client/rollup.py +++ b/elasticsearch/client/rollup.py @@ -23,6 +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,6 +39,7 @@ class RollupClient(NamespacedClient): 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, @@ -52,6 +54,7 @@ class RollupClient(NamespacedClient): """ 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 @@ -66,6 +69,7 @@ class RollupClient(NamespacedClient): """ 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 @@ -82,6 +86,7 @@ class RollupClient(NamespacedClient): def put_job(self, id, body, params=None, headers=None): """ Creates a rollup job. + ``_ :arg id: The ID of the job to create @@ -103,6 +108,7 @@ class RollupClient(NamespacedClient): 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 @@ -130,6 +136,7 @@ class RollupClient(NamespacedClient): 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,6 +155,7 @@ class RollupClient(NamespacedClient): def stop_job(self, id, params=None, headers=None): """ Stops an existing, started rollup job. + ``_ :arg id: The ID of the job to stop diff --git a/elasticsearch/client/rollup.pyi b/elasticsearch/client/rollup.pyi index 5ba68ea2..447df7b0 100644 --- a/elasticsearch/client/rollup.pyi +++ b/elasticsearch/client/rollup.pyi @@ -22,6 +22,7 @@ class RollupClient(NamespacedClient): def delete_job( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,10 +32,11 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_jobs( self, + *, id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -45,10 +47,11 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_rollup_caps( self, + *, id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -59,11 +62,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_rollup_index_caps( self, index: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -73,11 +77,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_job( self, id: Any, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -88,11 +93,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def rollup_search( self, index: Any, + *, body: Any, doc_type: Optional[Any] = ..., rest_total_hits_as_int: Optional[Any] = ..., @@ -106,11 +112,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def start_job( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -120,11 +127,12 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stop_job( self, id: Any, + *, timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -136,5 +144,5 @@ class RollupClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/searchable_snapshots.py b/elasticsearch/client/searchable_snapshots.py index b139a41d..061eda0d 100644 --- a/elasticsearch/client/searchable_snapshots.py +++ b/elasticsearch/client/searchable_snapshots.py @@ -23,6 +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 @@ -47,6 +48,7 @@ class SearchableSnapshotsClient(NamespacedClient): 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 @@ -75,6 +77,7 @@ class SearchableSnapshotsClient(NamespacedClient): def repository_stats(self, repository, params=None, headers=None): """ DEPRECATED: This API is replaced by the Repositories Metering API. + ``_ :arg repository: The repository for which to get the stats for @@ -93,6 +96,7 @@ class SearchableSnapshotsClient(NamespacedClient): 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/searchable_snapshots.pyi b/elasticsearch/client/searchable_snapshots.pyi index f5404991..e488b660 100644 --- a/elasticsearch/client/searchable_snapshots.pyi +++ b/elasticsearch/client/searchable_snapshots.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SearchableSnapshotsClient(NamespacedClient): def clear_cache( self, + *, index: Optional[Any] = ..., allow_no_indices: Optional[Any] = ..., expand_wildcards: Optional[Any] = ..., @@ -34,12 +35,13 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def mount( self, repository: Any, snapshot: Any, + *, body: Any, master_timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -52,11 +54,12 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def repository_stats( self, repository: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -66,10 +69,11 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stats( self, + *, index: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -80,5 +84,5 @@ class SearchableSnapshotsClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/security.py b/elasticsearch/client/security.py index 7274aa9d..91eb1c29 100644 --- a/elasticsearch/client/security.py +++ b/elasticsearch/client/security.py @@ -24,6 +24,7 @@ class SecurityClient(NamespacedClient): """ Enables authentication as a user and retrieve information about the authenticated user. + ``_ """ return self.transport.perform_request( @@ -34,6 +35,7 @@ class SecurityClient(NamespacedClient): 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 @@ -60,6 +62,7 @@ class SecurityClient(NamespacedClient): """ Evicts users from the user cache. Can completely clear the cache or evict specific users. + ``_ :arg realms: Comma-separated list of realms to clear @@ -80,6 +83,7 @@ class SecurityClient(NamespacedClient): def clear_cached_roles(self, name, params=None, headers=None): """ Evicts roles from the native role cache. + ``_ :arg name: Role name @@ -98,6 +102,7 @@ class SecurityClient(NamespacedClient): 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 @@ -117,6 +122,7 @@ class SecurityClient(NamespacedClient): def delete_privileges(self, application, name, params=None, headers=None): """ Removes application privileges. + ``_ :arg application: Application name @@ -141,6 +147,7 @@ class SecurityClient(NamespacedClient): def delete_role(self, name, params=None, headers=None): """ Removes roles in the native realm. + ``_ :arg name: Role name @@ -163,6 +170,7 @@ class SecurityClient(NamespacedClient): def delete_role_mapping(self, name, params=None, headers=None): """ Removes role mappings. + ``_ :arg name: Role-mapping name @@ -185,6 +193,7 @@ class SecurityClient(NamespacedClient): def delete_user(self, username, params=None, headers=None): """ Deletes users from the native realm. + ``_ :arg username: username @@ -207,6 +216,7 @@ class SecurityClient(NamespacedClient): def disable_user(self, username, params=None, headers=None): """ Disables users in the native realm. + ``_ :arg username: The username of the user to disable @@ -229,6 +239,7 @@ class SecurityClient(NamespacedClient): def enable_user(self, username, params=None, headers=None): """ Enables users in the native realm. + ``_ :arg username: The username of the user to enable @@ -251,6 +262,7 @@ class SecurityClient(NamespacedClient): 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 @@ -270,6 +282,7 @@ class SecurityClient(NamespacedClient): def get_privileges(self, application=None, name=None, params=None, headers=None): """ Retrieves application privileges. + ``_ :arg application: Application name @@ -286,9 +299,10 @@ class SecurityClient(NamespacedClient): def get_role(self, name=None, params=None, headers=None): """ Retrieves roles in the native realm. + ``_ - :arg name: Role name + :arg name: A comma-separated list of role names """ return self.transport.perform_request( "GET", _make_path("_security", "role", name), params=params, headers=headers @@ -298,9 +312,10 @@ class SecurityClient(NamespacedClient): def get_role_mapping(self, name=None, params=None, headers=None): """ Retrieves role mappings. + ``_ - :arg name: Role-Mapping name + :arg name: A comma-separated list of role-mapping names """ return self.transport.perform_request( "GET", @@ -313,6 +328,7 @@ class SecurityClient(NamespacedClient): 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,6 +344,7 @@ class SecurityClient(NamespacedClient): 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,6 +360,7 @@ class SecurityClient(NamespacedClient): def get_user_privileges(self, params=None, headers=None): """ Retrieves application privileges. + ``_ """ return self.transport.perform_request( @@ -353,6 +371,7 @@ class SecurityClient(NamespacedClient): 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 @@ -373,6 +392,7 @@ class SecurityClient(NamespacedClient): 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,6 +408,7 @@ class SecurityClient(NamespacedClient): 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,6 +428,7 @@ class SecurityClient(NamespacedClient): def put_privileges(self, body, params=None, headers=None): """ Adds or updates application privileges. + ``_ :arg body: The privilege(s) to add @@ -426,6 +448,7 @@ class SecurityClient(NamespacedClient): def put_role(self, name, body, params=None, headers=None): """ Adds and updates roles in the native realm. + ``_ :arg name: Role name @@ -451,6 +474,7 @@ class SecurityClient(NamespacedClient): def put_role_mapping(self, name, body, params=None, headers=None): """ Creates and updates role mappings. + ``_ :arg name: Role-mapping name @@ -477,6 +501,7 @@ class SecurityClient(NamespacedClient): """ Adds and updates users in the native realm. These users are commonly referred to as native users. + ``_ :arg username: The username of the User @@ -503,6 +528,7 @@ class SecurityClient(NamespacedClient): """ Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + ``_ """ return self.transport.perform_request( @@ -513,6 +539,7 @@ class SecurityClient(NamespacedClient): 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 @@ -533,6 +560,7 @@ class SecurityClient(NamespacedClient): def clear_api_key_cache(self, ids, params=None, headers=None): """ Clear a subset or all entries from the API key cache. + ``_ :arg ids: A comma-separated list of IDs of API keys to clear @@ -547,3 +575,27 @@ class SecurityClient(NamespacedClient): params=params, headers=headers, ) + + @query_params("refresh") + def grant_api_key(self, body, params=None, headers=None): + """ + Creates an API key on behalf of another user. + + ``_ + + :arg body: The api key request to create an API key + :arg refresh: If `true` (the default) then refresh the affected + shards to make this operation visible to search, if `wait_for` then wait + for a refresh to make this operation visible to search, if `false` then + do nothing with refreshes. Valid choices: true, false, wait_for + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + return self.transport.perform_request( + "POST", + "/_security/api_key/grant", + params=params, + headers=headers, + body=body, + ) diff --git a/elasticsearch/client/security.pyi b/elasticsearch/client/security.pyi index 7d34f7ac..b1f7cf2a 100644 --- a/elasticsearch/client/security.pyi +++ b/elasticsearch/client/security.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SecurityClient(NamespacedClient): def authenticate( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,10 +31,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def change_password( self, + *, body: Any, username: Optional[Any] = ..., refresh: Optional[Any] = ..., @@ -46,11 +48,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def clear_cached_realms( self, realms: Any, + *, usernames: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -61,11 +64,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def clear_cached_roles( self, name: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -75,10 +79,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def create_api_key( self, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -90,12 +95,13 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_privileges( self, application: Any, name: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -106,11 +112,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_role( self, name: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -121,11 +128,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_role_mapping( self, name: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -136,11 +144,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_user( self, username: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -151,11 +160,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def disable_user( self, username: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -166,11 +176,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def enable_user( self, username: Any, + *, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -181,10 +192,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_api_key( self, + *, id: Optional[Any] = ..., name: Optional[Any] = ..., owner: Optional[Any] = ..., @@ -199,10 +211,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_privileges( self, + *, application: Optional[Any] = ..., name: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -214,10 +227,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_role( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -228,10 +242,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_role_mapping( self, + *, name: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -242,10 +257,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_token( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -256,10 +272,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_user( self, + *, username: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -270,10 +287,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_user_privileges( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -283,10 +301,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def has_privileges( self, + *, body: Any, user: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -298,10 +317,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def invalidate_api_key( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -312,10 +332,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def invalidate_token( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -326,10 +347,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_privileges( self, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -341,11 +363,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_role( self, name: Any, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -357,11 +380,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_role_mapping( self, name: Any, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -373,11 +397,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_user( self, username: Any, + *, body: Any, refresh: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -389,10 +414,11 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_builtin_privileges( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -402,11 +428,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def clear_cached_privileges( self, application: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -416,11 +443,12 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def clear_api_key_cache( self, ids: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -430,5 +458,21 @@ class SecurityClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... + ) -> Any: ... + def grant_api_key( + self, + *, + body: Any, + refresh: Optional[Any] = ..., + pretty: Optional[bool] = ..., + human: Optional[bool] = ..., + error_trace: Optional[bool] = ..., + format: Optional[str] = ..., + filter_path: Optional[Union[str, Collection[str]]] = ..., + request_timeout: Optional[Union[int, float]] = ..., + ignore: Optional[Union[int, Collection[int]]] = ..., + opaque_id: Optional[str] = ..., + params: Optional[MutableMapping[str, Any]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/slm.py b/elasticsearch/client/slm.py index aec30a51..4e5690c9 100644 --- a/elasticsearch/client/slm.py +++ b/elasticsearch/client/slm.py @@ -23,6 +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 @@ -43,6 +44,7 @@ class SlmClient(NamespacedClient): """ 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 @@ -63,6 +65,7 @@ class SlmClient(NamespacedClient): """ Deletes any snapshots that are expired according to the policy's retention rules. + ``_ """ return self.transport.perform_request( @@ -74,6 +77,7 @@ class SlmClient(NamespacedClient): """ Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + ``_ :arg policy_id: Comma-separated list of snapshot lifecycle @@ -91,6 +95,7 @@ class SlmClient(NamespacedClient): """ Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + ``_ """ return self.transport.perform_request( @@ -101,6 +106,7 @@ class SlmClient(NamespacedClient): 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 @@ -121,6 +127,7 @@ class SlmClient(NamespacedClient): def get_status(self, params=None, headers=None): """ Retrieves the status of snapshot lifecycle management (SLM). + ``_ """ return self.transport.perform_request( @@ -131,6 +138,7 @@ class SlmClient(NamespacedClient): def start(self, params=None, headers=None): """ Turns on snapshot lifecycle management (SLM). + ``_ """ return self.transport.perform_request( @@ -141,6 +149,7 @@ class SlmClient(NamespacedClient): def stop(self, params=None, headers=None): """ Turns off snapshot lifecycle management (SLM). + ``_ """ return self.transport.perform_request( diff --git a/elasticsearch/client/slm.pyi b/elasticsearch/client/slm.pyi index 01f56f16..fb0dbe56 100644 --- a/elasticsearch/client/slm.pyi +++ b/elasticsearch/client/slm.pyi @@ -22,6 +22,7 @@ class SlmClient(NamespacedClient): def delete_lifecycle( self, policy_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -31,11 +32,12 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def execute_lifecycle( self, policy_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -45,10 +47,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def execute_retention( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -58,10 +61,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_lifecycle( self, + *, policy_id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -72,10 +76,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_stats( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -85,11 +90,12 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_lifecycle( self, policy_id: Any, + *, body: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -100,10 +106,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_status( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -113,10 +120,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def start( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -126,10 +134,11 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stop( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -139,5 +148,5 @@ class SlmClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/snapshot.py b/elasticsearch/client/snapshot.py index a9a4ef6b..0964e7d8 100644 --- a/elasticsearch/client/snapshot.py +++ b/elasticsearch/client/snapshot.py @@ -23,6 +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 @@ -49,6 +50,7 @@ class SnapshotClient(NamespacedClient): def delete(self, repository, snapshot, params=None, headers=None): """ Deletes a snapshot. + ``_ :arg repository: A repository name @@ -71,6 +73,7 @@ class SnapshotClient(NamespacedClient): def get(self, repository, snapshot, params=None, headers=None): """ Returns information about a snapshot. + ``_ :arg repository: A repository name @@ -98,6 +101,7 @@ class SnapshotClient(NamespacedClient): def delete_repository(self, repository, params=None, headers=None): """ Deletes a repository. + ``_ :arg repository: Name of the snapshot repository to unregister. @@ -120,6 +124,7 @@ class SnapshotClient(NamespacedClient): def get_repository(self, repository=None, params=None, headers=None): """ Returns information about a repository. + ``_ :arg repository: A comma-separated list of repository names @@ -136,6 +141,7 @@ class SnapshotClient(NamespacedClient): def create_repository(self, repository, body, params=None, headers=None): """ Creates a repository. + ``_ :arg repository: A repository name @@ -161,6 +167,7 @@ class SnapshotClient(NamespacedClient): def restore(self, repository, snapshot, body=None, params=None, headers=None): """ Restores a snapshot. + ``_ :arg repository: A repository name @@ -187,6 +194,7 @@ class SnapshotClient(NamespacedClient): def status(self, repository=None, snapshot=None, params=None, headers=None): """ Returns information about the status of a snapshot. + ``_ :arg repository: A repository name @@ -208,6 +216,7 @@ class SnapshotClient(NamespacedClient): def verify_repository(self, repository, params=None, headers=None): """ Verifies a repository. + ``_ :arg repository: A repository name @@ -229,6 +238,7 @@ class SnapshotClient(NamespacedClient): def cleanup_repository(self, repository, params=None, headers=None): """ Removes stale data from repository. + ``_ :arg repository: A repository name @@ -245,3 +255,31 @@ class SnapshotClient(NamespacedClient): params=params, headers=headers, ) + + @query_params("master_timeout") + def clone( + self, repository, snapshot, target_snapshot, body, params=None, headers=None + ): + """ + Clones indices from one snapshot into another snapshot in the same repository. + + ``_ + + :arg repository: A repository name + :arg snapshot: The name of the snapshot to clone from + :arg target_snapshot: The name of the cloned snapshot to create + :arg body: The snapshot clone definition + :arg master_timeout: Explicit operation timeout for connection + to master node + """ + for param in (repository, snapshot, target_snapshot, body): + if param in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument.") + + return self.transport.perform_request( + "PUT", + _make_path("_snapshot", repository, snapshot, "_clone", target_snapshot), + params=params, + headers=headers, + body=body, + ) diff --git a/elasticsearch/client/snapshot.pyi b/elasticsearch/client/snapshot.pyi index 8bae756f..605689da 100644 --- a/elasticsearch/client/snapshot.pyi +++ b/elasticsearch/client/snapshot.pyi @@ -23,6 +23,7 @@ class SnapshotClient(NamespacedClient): self, repository: Any, snapshot: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -35,12 +36,13 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete( self, repository: Any, snapshot: Any, + *, master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -51,12 +53,13 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get( self, repository: Any, snapshot: Any, + *, ignore_unavailable: Optional[Any] = ..., master_timeout: Optional[Any] = ..., verbose: Optional[Any] = ..., @@ -69,11 +72,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_repository( self, repository: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -85,10 +89,11 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_repository( self, + *, repository: Optional[Any] = ..., local: Optional[Any] = ..., master_timeout: Optional[Any] = ..., @@ -101,11 +106,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def create_repository( self, repository: Any, + *, body: Any, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -119,12 +125,13 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def restore( self, repository: Any, snapshot: Any, + *, body: Optional[Any] = ..., master_timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -137,10 +144,11 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def status( self, + *, repository: Optional[Any] = ..., snapshot: Optional[Any] = ..., ignore_unavailable: Optional[Any] = ..., @@ -154,11 +162,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def verify_repository( self, repository: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -170,11 +179,12 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def cleanup_repository( self, repository: Any, + *, master_timeout: Optional[Any] = ..., timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -186,5 +196,24 @@ class SnapshotClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... + ) -> Any: ... + def clone( + self, + repository: Any, + snapshot: Any, + target_snapshot: Any, + *, + body: Any, + master_timeout: Optional[Any] = ..., + pretty: Optional[bool] = ..., + human: Optional[bool] = ..., + error_trace: Optional[bool] = ..., + format: Optional[str] = ..., + filter_path: Optional[Union[str, Collection[str]]] = ..., + request_timeout: Optional[Union[int, float]] = ..., + ignore: Optional[Union[int, Collection[int]]] = ..., + opaque_id: Optional[str] = ..., + params: Optional[MutableMapping[str, Any]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/sql.py b/elasticsearch/client/sql.py index a4179ff0..85d8b7c7 100644 --- a/elasticsearch/client/sql.py +++ b/elasticsearch/client/sql.py @@ -23,6 +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 @@ -39,6 +40,7 @@ class SqlClient(NamespacedClient): def query(self, body, params=None, headers=None): """ Executes a SQL request + ``_ :arg body: Use the `query` element to start a query. Use the @@ -57,6 +59,7 @@ class SqlClient(NamespacedClient): 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/sql.pyi b/elasticsearch/client/sql.pyi index 5ad2e6d2..4fa012c1 100644 --- a/elasticsearch/client/sql.pyi +++ b/elasticsearch/client/sql.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SqlClient(NamespacedClient): def clear_cursor( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -31,10 +32,11 @@ class SqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def query( self, + *, body: Any, format: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -45,10 +47,11 @@ class SqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def translate( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -59,5 +62,5 @@ class SqlClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/ssl.py b/elasticsearch/client/ssl.py index 743aecff..aebe39ed 100644 --- a/elasticsearch/client/ssl.py +++ b/elasticsearch/client/ssl.py @@ -24,6 +24,7 @@ class SslClient(NamespacedClient): """ Retrieves information about the X.509 certificates used to encrypt communications in the cluster. + ``_ """ return self.transport.perform_request( diff --git a/elasticsearch/client/ssl.pyi b/elasticsearch/client/ssl.pyi index aff31427..0835b175 100644 --- a/elasticsearch/client/ssl.pyi +++ b/elasticsearch/client/ssl.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class SslClient(NamespacedClient): def certificates( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -30,5 +31,5 @@ class SslClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/tasks.py b/elasticsearch/client/tasks.py index 45e0b865..1a4c46a5 100644 --- a/elasticsearch/client/tasks.py +++ b/elasticsearch/client/tasks.py @@ -32,6 +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 @@ -56,6 +57,7 @@ class TasksClient(NamespacedClient): 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 @@ -82,6 +84,7 @@ class TasksClient(NamespacedClient): def get(self, task_id=None, params=None, headers=None): """ Returns information about a task. + ``_ :arg task_id: Return the task with specified id diff --git a/elasticsearch/client/tasks.pyi b/elasticsearch/client/tasks.pyi index a67b946c..f1a68dae 100644 --- a/elasticsearch/client/tasks.pyi +++ b/elasticsearch/client/tasks.pyi @@ -21,6 +21,7 @@ from .utils import NamespacedClient class TasksClient(NamespacedClient): def list( self, + *, actions: Optional[Any] = ..., detailed: Optional[Any] = ..., group_by: Optional[Any] = ..., @@ -37,10 +38,11 @@ class TasksClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def cancel( self, + *, task_id: Optional[Any] = ..., actions: Optional[Any] = ..., nodes: Optional[Any] = ..., @@ -55,10 +57,11 @@ class TasksClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get( self, + *, task_id: Optional[Any] = ..., timeout: Optional[Any] = ..., wait_for_completion: Optional[Any] = ..., @@ -71,5 +74,5 @@ class TasksClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/transform.py b/elasticsearch/client/transform.py index a2c6c6f5..2ecc8f88 100644 --- a/elasticsearch/client/transform.py +++ b/elasticsearch/client/transform.py @@ -23,6 +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 @@ -42,10 +43,11 @@ class TransformClient(NamespacedClient): headers=headers, ) - @query_params("allow_no_match", "from_", "size") + @query_params("allow_no_match", "exclude_generated", "from_", "size") 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 @@ -54,6 +56,8 @@ class TransformClient(NamespacedClient): :arg allow_no_match: Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) + :arg exclude_generated: Omits fields that are illegal to set on + transform PUT :arg from_: skips a number of transform configs, defaults to 0 :arg size: specifies a max number of transforms to get, defaults to 100 @@ -73,6 +77,7 @@ class TransformClient(NamespacedClient): 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 @@ -104,6 +109,7 @@ class TransformClient(NamespacedClient): def preview_transform(self, body, params=None, headers=None): """ Previews a transform. + ``_ :arg body: The definition for the transform to preview @@ -119,6 +125,7 @@ class TransformClient(NamespacedClient): def put_transform(self, transform_id, body, params=None, headers=None): """ Instantiates a transform. + ``_ :arg transform_id: The id of the new transform. @@ -142,6 +149,7 @@ class TransformClient(NamespacedClient): 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 @@ -170,6 +178,7 @@ class TransformClient(NamespacedClient): 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 @@ -201,6 +210,7 @@ class TransformClient(NamespacedClient): 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. diff --git a/elasticsearch/client/transform.pyi b/elasticsearch/client/transform.pyi index 5a188968..5450af0d 100644 --- a/elasticsearch/client/transform.pyi +++ b/elasticsearch/client/transform.pyi @@ -22,6 +22,7 @@ class TransformClient(NamespacedClient): def delete_transform( self, transform_id: Any, + *, force: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -32,12 +33,14 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_transform( self, + *, transform_id: Optional[Any] = ..., allow_no_match: Optional[Any] = ..., + exclude_generated: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -49,11 +52,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_transform_stats( self, transform_id: Any, + *, allow_no_match: Optional[Any] = ..., from_: Optional[Any] = ..., size: Optional[Any] = ..., @@ -66,10 +70,11 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def preview_transform( self, + *, body: Any, pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -80,11 +85,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_transform( self, transform_id: Any, + *, body: Any, defer_validation: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -96,11 +102,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def start_transform( self, transform_id: Any, + *, timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -111,11 +118,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stop_transform( self, transform_id: Any, + *, allow_no_match: Optional[Any] = ..., force: Optional[Any] = ..., timeout: Optional[Any] = ..., @@ -130,11 +138,12 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def update_transform( self, transform_id: Any, + *, body: Any, defer_validation: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -146,5 +155,5 @@ class TransformClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/watcher.py b/elasticsearch/client/watcher.py index 7b7636c5..cd2d07be 100644 --- a/elasticsearch/client/watcher.py +++ b/elasticsearch/client/watcher.py @@ -23,6 +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 @@ -43,6 +44,7 @@ class WatcherClient(NamespacedClient): def activate_watch(self, watch_id, params=None, headers=None): """ Activates a currently inactive watch. + ``_ :arg watch_id: Watch ID @@ -61,6 +63,7 @@ class WatcherClient(NamespacedClient): def deactivate_watch(self, watch_id, params=None, headers=None): """ Deactivates a currently active watch. + ``_ :arg watch_id: Watch ID @@ -79,6 +82,7 @@ class WatcherClient(NamespacedClient): def delete_watch(self, id, params=None, headers=None): """ Removes a watch from Watcher. + ``_ :arg id: Watch ID @@ -97,6 +101,7 @@ class WatcherClient(NamespacedClient): def execute_watch(self, body=None, id=None, params=None, headers=None): """ Forces the execution of a stored watch. + ``_ :arg body: Execution control @@ -116,6 +121,7 @@ class WatcherClient(NamespacedClient): def get_watch(self, id, params=None, headers=None): """ Retrieves a watch by its ID. + ``_ :arg id: Watch ID @@ -131,6 +137,7 @@ class WatcherClient(NamespacedClient): def put_watch(self, id, body=None, params=None, headers=None): """ Creates a new watch, or updates an existing one. + ``_ :arg id: Watch ID @@ -157,6 +164,7 @@ class WatcherClient(NamespacedClient): def start(self, params=None, headers=None): """ Starts Watcher if it is not already running. + ``_ """ return self.transport.perform_request( @@ -167,6 +175,7 @@ class WatcherClient(NamespacedClient): def stats(self, metric=None, params=None, headers=None): """ Retrieves the current Watcher metrics. + ``_ :arg metric: Controls what additional stat metrics should be @@ -186,6 +195,7 @@ class WatcherClient(NamespacedClient): def stop(self, params=None, headers=None): """ Stops Watcher if it is running. + ``_ """ return self.transport.perform_request( diff --git a/elasticsearch/client/watcher.pyi b/elasticsearch/client/watcher.pyi index 68a3552b..00e4ca58 100644 --- a/elasticsearch/client/watcher.pyi +++ b/elasticsearch/client/watcher.pyi @@ -22,6 +22,7 @@ class WatcherClient(NamespacedClient): def ack_watch( self, watch_id: Any, + *, action_id: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -32,11 +33,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def activate_watch( self, watch_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -46,11 +48,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def deactivate_watch( self, watch_id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -60,11 +63,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def delete_watch( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -74,10 +78,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def execute_watch( self, + *, body: Optional[Any] = ..., id: Optional[Any] = ..., debug: Optional[Any] = ..., @@ -90,11 +95,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def get_watch( self, id: Any, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -104,11 +110,12 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def put_watch( self, id: Any, + *, body: Optional[Any] = ..., active: Optional[Any] = ..., if_primary_term: Optional[Any] = ..., @@ -123,10 +130,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def start( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -136,10 +144,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stats( self, + *, metric: Optional[Any] = ..., emit_stacktraces: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -151,10 +160,11 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def stop( self, + *, pretty: Optional[bool] = ..., human: Optional[bool] = ..., error_trace: Optional[bool] = ..., @@ -164,5 +174,5 @@ class WatcherClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... diff --git a/elasticsearch/client/xpack.py b/elasticsearch/client/xpack.py index 76f857fe..037d6b68 100644 --- a/elasticsearch/client/xpack.py +++ b/elasticsearch/client/xpack.py @@ -27,6 +27,7 @@ class XPackClient(NamespacedClient): def info(self, params=None, headers=None): """ Retrieves information about the installed X-Pack features. + ``_ :arg accept_enterprise: If an enterprise license is installed, @@ -42,6 +43,7 @@ class XPackClient(NamespacedClient): 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/xpack.pyi b/elasticsearch/client/xpack.pyi index 0f18aee9..c50e56ab 100644 --- a/elasticsearch/client/xpack.pyi +++ b/elasticsearch/client/xpack.pyi @@ -24,6 +24,7 @@ class XPackClient(NamespacedClient): # AUTO-GENERATED-API-DEFINITIONS # def info( self, + *, accept_enterprise: Optional[Any] = ..., categories: Optional[Any] = ..., pretty: Optional[bool] = ..., @@ -35,10 +36,11 @@ class XPackClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ... def usage( self, + *, master_timeout: Optional[Any] = ..., pretty: Optional[bool] = ..., human: Optional[bool] = ..., @@ -49,5 +51,5 @@ class XPackClient(NamespacedClient): ignore: Optional[Union[int, Collection[int]]] = ..., opaque_id: Optional[str] = ..., params: Optional[MutableMapping[str, Any]] = ..., - headers: Optional[MutableMapping[str, str]] = ..., + headers: Optional[MutableMapping[str, str]] = ... ) -> Any: ...