From 6d71623b8c732cc49a5be3a3ca348e31592d8fa7 Mon Sep 17 00:00:00 2001 From: saimedhi <117196660+saimedhi@users.noreply.github.com> Date: Sat, 26 Oct 2024 03:37:11 +0000 Subject: [PATCH] Updated opensearch-py to reflect the latest OpenSearch API spec (2024-10-26) Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> --- CHANGELOG.md | 1 + opensearchpy/_async/client/__init__.py | 362 ++++++++++---- opensearchpy/_async/client/cat.py | 152 ++++-- opensearchpy/_async/client/cluster.py | 136 ++++-- .../_async/client/dangling_indices.py | 18 +- opensearchpy/_async/client/indices.py | 315 +++++++----- opensearchpy/_async/client/ingest.py | 30 +- opensearchpy/_async/client/insights.py | 51 ++ opensearchpy/_async/client/nodes.py | 30 +- opensearchpy/_async/client/plugins.py | 7 + opensearchpy/_async/client/remote_store.py | 6 +- opensearchpy/_async/client/search_pipeline.py | 18 +- opensearchpy/_async/client/security.py | 462 ++++++++++++------ opensearchpy/_async/client/snapshot.py | 66 ++- opensearchpy/_async/client/tasks.py | 18 +- .../_async/plugins/asynchronous_search.py | 171 +++++++ opensearchpy/_async/plugins/flow_framework.py | 417 ++++++++++++++++ opensearchpy/_async/plugins/knn.py | 39 +- opensearchpy/_async/plugins/ml.py | 222 ++++++++- opensearchpy/_async/plugins/notifications.py | 58 ++- opensearchpy/_async/plugins/observability.py | 42 +- opensearchpy/_async/plugins/ppl.py | 24 +- opensearchpy/_async/plugins/query.py | 30 +- opensearchpy/_async/plugins/rollups.py | 36 +- opensearchpy/_async/plugins/sql.py | 36 +- opensearchpy/_async/plugins/transforms.py | 55 ++- opensearchpy/client/__init__.py | 362 ++++++++++---- opensearchpy/client/cat.py | 152 ++++-- opensearchpy/client/cluster.py | 136 ++++-- opensearchpy/client/dangling_indices.py | 18 +- opensearchpy/client/indices.py | 315 +++++++----- opensearchpy/client/ingest.py | 30 +- opensearchpy/client/insights.py | 51 ++ opensearchpy/client/nodes.py | 30 +- opensearchpy/client/plugins.py | 30 +- opensearchpy/client/remote_store.py | 6 +- opensearchpy/client/search_pipeline.py | 18 +- opensearchpy/client/security.py | 462 ++++++++++++------ opensearchpy/client/snapshot.py | 66 ++- opensearchpy/client/tasks.py | 18 +- opensearchpy/plugins/asynchronous_search.py | 171 +++++++ opensearchpy/plugins/flow_framework.py | 417 ++++++++++++++++ opensearchpy/plugins/knn.py | 39 +- opensearchpy/plugins/ml.py | 222 ++++++++- opensearchpy/plugins/notifications.py | 58 ++- opensearchpy/plugins/observability.py | 42 +- opensearchpy/plugins/ppl.py | 24 +- opensearchpy/plugins/query.py | 30 +- opensearchpy/plugins/rollups.py | 36 +- opensearchpy/plugins/sql.py | 36 +- opensearchpy/plugins/transforms.py | 55 ++- 51 files changed, 4327 insertions(+), 1299 deletions(-) create mode 100644 opensearchpy/_async/client/insights.py create mode 100644 opensearchpy/_async/plugins/asynchronous_search.py create mode 100644 opensearchpy/_async/plugins/flow_framework.py create mode 100644 opensearchpy/client/insights.py create mode 100644 opensearchpy/plugins/asynchronous_search.py create mode 100644 opensearchpy/plugins/flow_framework.py diff --git a/CHANGELOG.md b/CHANGELOG.md index 5fccce1a..f69f69b4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -34,6 +34,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) - Fixed the use of `minimum_should_match` with `Bool` to allow the use of string-based value (percent string, combination). ([#780](https://github.com/opensearch-project/opensearch-py/pull/780)) - Fixed incorrect `retry_on_conflict` type ([#795](https://github.com/opensearch-project/opensearch-py/pull/795)) ### Updated APIs +- Updated opensearch-py APIs to reflect [opensearch-api-specification@931a61a](https://github.com/opensearch-project/opensearch-api-specification/commit/931a61ae023b453e3611f37a802ef27b9c4877a1) - Updated opensearch-py APIs to reflect [opensearch-api-specification@9d3bc34](https://github.com/opensearch-project/opensearch-api-specification/commit/9d3bc340ccd7d049e7d6e14a4aff2293780cb446) ### Dependencies - Bump `pytest-asyncio` from <=0.23.7 to <=0.23.8 ([#787](https://github.com/opensearch-project/opensearch-py/pull/787)) diff --git a/opensearchpy/_async/client/__init__.py b/opensearchpy/_async/client/__init__.py index 9cd54d38..99900c21 100644 --- a/opensearchpy/_async/client/__init__.py +++ b/opensearchpy/_async/client/__init__.py @@ -46,6 +46,7 @@ from .http import HttpClient from .indices import IndicesClient from .ingest import IngestClient +from .insights import InsightsClient from .nodes import NodesClient from .plugins import PluginsClient from .remote import RemoteClient @@ -214,6 +215,7 @@ class as kwargs, or a string in the format of ``host[:port]`` which will be super().__init__(hosts, transport_class, **kwargs) # namespaced clients for compatibility with API names + self.insights = InsightsClient(self) self.search_pipeline = SearchPipelineClient(self) self.cat = CatClient(self) self.cluster = ClusterClient(self) @@ -268,8 +270,10 @@ async def ping( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -296,8 +300,10 @@ async def info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -345,8 +351,10 @@ async def create( :arg body: The document :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pipeline: ID of the pipeline to use to preprocess incoming @@ -423,8 +431,10 @@ async def index( :arg id: Unique identifier for the document. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -519,8 +529,10 @@ async def bulk( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pipeline: ID of the pipeline to use to preprocess incoming @@ -578,8 +590,10 @@ async def clear_scroll( clear all scroll IDs, use `_all`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -656,10 +670,11 @@ async def count( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + separated values, such as `open,hidden`. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_throttled: If `true`, concrete, expanded or aliased @@ -721,8 +736,10 @@ async def delete( :arg id: Unique identifier for the document. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -842,8 +859,10 @@ async def delete_by_query( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting offset. Default is 0. :arg human: Whether to return human readable values for statistics. @@ -933,8 +952,10 @@ async def delete_by_query_rethrottle( :arg task_id: The ID for the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -979,8 +1000,10 @@ async def delete_script( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1041,8 +1064,10 @@ async def exists( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1113,8 +1138,10 @@ async def exists_source( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1197,8 +1224,10 @@ async def explain( in the query string. Default is _all. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg lenient: If `true`, format-based query failures (such as @@ -1264,12 +1293,13 @@ async def field_caps( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. + separated values, such as `open,hidden`. :arg fields: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `true`, missing or closed indices @@ -1327,8 +1357,10 @@ async def get( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1385,8 +1417,10 @@ async def get_script( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1441,8 +1475,10 @@ async def get_source( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1517,8 +1553,10 @@ async def mget( is `false`, this parameter is ignored. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1581,8 +1619,10 @@ async def msearch( cross-cluster search requests. Default is True. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg max_concurrent_searches: Maximum number of concurrent @@ -1654,8 +1694,10 @@ async def msearch_template( minimized for cross-cluster search requests. Default is True. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg max_concurrent_searches: Maximum number of concurrent @@ -1728,8 +1770,10 @@ async def mtermvectors( fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ids: A comma-separated list of documents ids. You must @@ -1795,8 +1839,10 @@ async def put_script( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1861,17 +1907,19 @@ async def rank_eval( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `true`, missing or closed indices are not included in the response. :arg pretty: Whether to pretty format the returned JSON response. - :arg search_type: Search operation type + :arg search_type: Search operation type Valid choices are + dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1917,8 +1965,10 @@ async def reindex( prototype for the index request. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg max_docs: Maximum number of documents to process. By @@ -1968,8 +2018,10 @@ async def reindex_rethrottle( :arg task_id: Identifier for the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2006,8 +2058,10 @@ async def render_search_template( specified, this or the `id` request body parameter is required. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2037,8 +2091,10 @@ async def scripts_painless_execute( :arg body: The script to execute :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2079,8 +2135,10 @@ async def scroll( :arg scroll_id: The scroll ID for scrolled search :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2226,12 +2284,13 @@ async def search( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. + separated values, such as `open,hidden`. :arg explain: If `true`, returns detailed information about score computation as part of a hit. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the @@ -2408,8 +2467,10 @@ async def search_shards( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -2480,8 +2541,10 @@ async def search_template( `open`, `closed`, `hidden`, `none`. :arg explain: If `true`, the response includes additional details about score computation as part of a hit. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_throttled: If `true`, specified concrete, expanded, @@ -2561,8 +2624,10 @@ async def termvectors( fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg offsets: If `true`, the response includes term offsets. @@ -2640,8 +2705,10 @@ async def update( retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -2768,8 +2835,10 @@ async def update_by_query( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting offset. Default is 0. :arg human: Whether to return human readable values for statistics. @@ -2862,8 +2931,10 @@ async def update_by_query_rethrottle( :arg task_id: The ID for the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2895,8 +2966,10 @@ async def get_script_context( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2920,8 +2993,10 @@ async def get_script_languages( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2962,10 +3037,11 @@ async def create_pit( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg keep_alive: Specify the keep alive for point in time. @@ -2999,8 +3075,10 @@ async def delete_all_pits( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -3026,8 +3104,10 @@ async def delete_pit( :arg body: The point-in-time ids to be deleted :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -3055,8 +3135,10 @@ async def get_all_pits( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -3067,3 +3149,93 @@ async def get_all_pits( return await self.transport.perform_request( "GET", "/_search/point_in_time/_all", params=params, headers=headers ) + + @query_params( + "_source", + "_source_excludes", + "_source_includes", + "batch_interval", + "batch_size", + "error_trace", + "filter_path", + "human", + "pipeline", + "pretty", + "refresh", + "require_alias", + "routing", + "source", + "timeout", + "wait_for_active_shards", + ) + async def bulk_stream( + self, + body: Any, + index: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Allows to perform multiple index/update/delete operations using request + response streaming. + + + :arg body: The operation definition and data (action-data + pairs), separated by newlines + :arg index: Name of the data stream, index, or index alias to + perform bulk actions on. + :arg _source: `true` or `false` to return the `_source` field or + not, or a list of fields to return. + :arg _source_excludes: A comma-separated list of source fields + to exclude from the response. + :arg _source_includes: A comma-separated list of source fields + to include in the response. + :arg batch_interval: Specifies for how long bulk operations + should be accumulated into a batch before sending the batch to data + nodes. + :arg batch_size: Specifies how many bulk operations should be + accumulated into a batch before sending the batch to data nodes. + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pipeline: ID of the pipeline to use to preprocess incoming + documents. If the index has a default ingest pipeline specified, then + setting the value to `_none` disables the default ingest pipeline for + this request. If a final pipeline is configured it will always run, + regardless of the value of this parameter. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg refresh: If `true`, OpenSearch refreshes 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` do + nothing with refreshes. Valid values: `true`, `false`, `wait_for`. + :arg require_alias: If `true`, the request's actions must target + an index alias. Default is false. + :arg routing: Custom value used to route operations to a + specific shard. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg timeout: Period each action waits for the following + operations: automatic index creation, dynamic mapping updates, waiting + for active shards. + :arg wait_for_active_shards: The number of shard copies that + must be active before proceeding with the operation. Set to all or any + positive integer up to the total number of shards in the index + (`number_of_replicas+1`). Valid choices are all, index-setting. + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + body = _bulk_body(self.transport.serializer, body) + return await self.transport.perform_request( + "PUT", + _make_path(index, "_bulk", "stream"), + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/_async/client/cat.py b/opensearchpy/_async/client/cat.py index 203af978..b79d7349 100644 --- a/opensearchpy/_async/client/cat.py +++ b/opensearchpy/_async/client/cat.py @@ -71,10 +71,11 @@ async def aliases( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -121,8 +122,10 @@ async def all_pit_segments( choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -176,8 +179,10 @@ async def allocation( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -232,8 +237,10 @@ async def cluster_manager( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -285,8 +292,10 @@ async def count( all data streams and indices, omit this parameter or use `*` or `_all`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -335,8 +344,10 @@ async def fielddata( are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -383,8 +394,10 @@ async def health( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -419,8 +432,10 @@ async def help( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -474,9 +489,11 @@ async def indices( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: The type of index that wildcard patterns - can match. Valid choices are all, closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + can match. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -538,8 +555,10 @@ async def master( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -596,8 +615,10 @@ async def nodeattrs( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -654,8 +675,10 @@ async def nodes( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg full_id: If `true`, return the full node ID. If `false`, @@ -713,8 +736,10 @@ async def pending_tasks( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -767,8 +792,10 @@ async def pit_segments( choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -815,8 +842,10 @@ async def plugins( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -876,8 +905,10 @@ async def recovery( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -926,8 +957,10 @@ async def repositories( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1001,10 +1034,11 @@ async def segment_replication( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1068,8 +1102,10 @@ async def segments( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1127,8 +1163,10 @@ async def shards( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1187,8 +1225,10 @@ async def thread_pool( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1250,8 +1290,10 @@ async def snapshots( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1313,8 +1355,10 @@ async def tasks( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1372,8 +1416,10 @@ async def templates( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. diff --git a/opensearchpy/_async/client/cluster.py b/opensearchpy/_async/client/cluster.py index 655025c4..9d55c899 100644 --- a/opensearchpy/_async/client/cluster.py +++ b/opensearchpy/_async/client/cluster.py @@ -81,10 +81,11 @@ async def health( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg level: Can be one of cluster, indices or shards. Controls @@ -159,8 +160,10 @@ async def pending_tasks( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: If `true`, the request retrieves information from @@ -218,10 +221,11 @@ async def state( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -275,8 +279,10 @@ async def stats( returned information. Defaults to all nodes in the cluster. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -335,8 +341,10 @@ async def reroute( errors. :arg explain: If true, then the response contains an explanation of why the commands can or cannot be executed. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -384,8 +392,10 @@ async def get_settings( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -435,8 +445,10 @@ async def put_settings( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -469,8 +481,10 @@ async def remote_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -505,8 +519,10 @@ async def allocation_explain( means 'explain the first unassigned shard' :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg include_disk_info: If true, returns information about disk @@ -552,8 +568,10 @@ async def delete_component_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -604,8 +622,10 @@ async def get_component_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: If `true`, the request retrieves information from @@ -666,8 +686,10 @@ async def put_component_template( existing component templates. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -718,8 +740,10 @@ async def exists_component_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: If true, the request retrieves information from the @@ -758,8 +782,10 @@ async def delete_voting_config_exclusions( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -802,8 +828,10 @@ async def post_voting_config_exclusions( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg node_ids: A comma-separated list of the persistent ids of @@ -838,8 +866,10 @@ async def delete_decommission_awareness( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -854,6 +884,7 @@ async def delete_decommission_awareness( @query_params("error_trace", "filter_path", "human", "pretty", "source") async def delete_weighted_routing( self, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -863,8 +894,10 @@ async def delete_weighted_routing( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -877,6 +910,7 @@ async def delete_weighted_routing( "/_cluster/routing/awareness/weights", params=params, headers=headers, + body=body, ) @query_params("error_trace", "filter_path", "human", "pretty", "source") @@ -893,8 +927,10 @@ async def get_decommission_awareness( :arg awareness_attribute_name: Awareness attribute name. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -934,8 +970,10 @@ async def get_weighted_routing( :arg attribute: Awareness attribute name. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -969,8 +1007,10 @@ async def put_decommission_awareness( :arg awareness_attribute_value: Awareness attribute value. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -999,6 +1039,7 @@ async def put_decommission_awareness( async def put_weighted_routing( self, attribute: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -1009,8 +1050,10 @@ async def put_weighted_routing( :arg attribute: Awareness attribute name. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1026,4 +1069,5 @@ async def put_weighted_routing( _make_path("_cluster", "routing", "awareness", attribute, "weights"), params=params, headers=headers, + body=body, ) diff --git a/opensearchpy/_async/client/dangling_indices.py b/opensearchpy/_async/client/dangling_indices.py index 75e64013..5b4d36cf 100644 --- a/opensearchpy/_async/client/dangling_indices.py +++ b/opensearchpy/_async/client/dangling_indices.py @@ -68,8 +68,10 @@ async def delete_dangling_index( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -119,8 +121,10 @@ async def import_dangling_index( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -151,8 +155,10 @@ async def list_dangling_indices( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/client/indices.py b/opensearchpy/_async/client/indices.py index 2c692fe8..cbd13d10 100644 --- a/opensearchpy/_async/client/indices.py +++ b/opensearchpy/_async/client/indices.py @@ -58,8 +58,10 @@ async def analyze( :arg index: The name of the index to scope the operation. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -109,8 +111,10 @@ async def refresh( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -160,8 +164,10 @@ async def flush( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg force: If `true`, the request forces a flush even if there are no changes to commit to the index. :arg human: Whether to return human readable values for @@ -210,8 +216,10 @@ async def create( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -270,8 +278,10 @@ async def clone( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -347,10 +357,11 @@ async def get( :arg expand_wildcards: Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - Supports comma-separated values, such as open,hidden. Valid choices are - all, closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + Supports comma-separated values, such as open,hidden. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If true, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -424,8 +435,10 @@ async def open( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -496,8 +509,10 @@ async def close( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -565,8 +580,10 @@ async def delete( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -629,8 +646,10 @@ async def exists( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -694,8 +713,10 @@ async def put_mapping( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -767,8 +788,10 @@ async def get_mapping( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -827,8 +850,10 @@ async def get_field_mapping( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -890,8 +915,10 @@ async def exists_alias( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, requests that include a @@ -950,8 +977,10 @@ async def get_alias( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -992,8 +1021,10 @@ async def update_aliases( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1044,8 +1075,10 @@ async def delete_alias( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1098,8 +1131,10 @@ async def put_template( existing index templates. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1153,8 +1188,10 @@ async def exists_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1205,8 +1242,10 @@ async def get_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1252,8 +1291,10 @@ async def delete_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1319,10 +1360,11 @@ async def get_settings( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + separated values, such as `open,hidden`. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1389,10 +1431,11 @@ async def put_settings( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + separated values, such as `open,hidden`. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1462,14 +1505,15 @@ async def stats( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. + separated values, such as `open,hidden`. :arg fielddata_fields: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. :arg fields: Comma-separated list or wildcard expressions of fields to include in the statistics. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg forbid_closed_indices: If true, statistics are not collected from closed indices. Default is True. :arg groups: Comma-separated list of search groups to include in @@ -1529,8 +1573,10 @@ async def segments( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -1605,8 +1651,10 @@ async def validate_query( `open`, `closed`, `hidden`, `none`. :arg explain: If `true`, the response returns detailed information if an error has occurred. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -1673,8 +1721,10 @@ async def clear_cache( the `fielddata` parameter. :arg file: If true, clears the unused entries from the file cache on nodes with the Search role. Default is false. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -1718,8 +1768,10 @@ async def recovery( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1761,10 +1813,11 @@ async def upgrade( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether specified concrete indices @@ -1810,10 +1863,11 @@ async def get_upgrade( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether specified concrete indices @@ -1858,10 +1912,11 @@ async def shard_stores( errors. :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines - whether wildcard expressions match hidden data streams. Valid choices - are all, closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + whether wildcard expressions match hidden data streams. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If true, missing or closed indices are @@ -1910,10 +1965,11 @@ async def forcemerge( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flush: Specify whether the index should be flushed after performing the operation. Default is True. :arg human: Whether to return human readable values for @@ -1975,8 +2031,10 @@ async def shrink( source index. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2048,8 +2106,10 @@ async def split( source index. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2121,8 +2181,10 @@ async def rollover( Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2173,8 +2235,10 @@ async def create_data_stream( :arg body: The data stream definition :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2208,8 +2272,10 @@ async def delete_data_stream( Wildcard (`*`) expressions are supported. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2250,8 +2316,10 @@ async def delete_index_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2303,8 +2371,10 @@ async def exists_index_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -2354,8 +2424,10 @@ async def get_index_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If true, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -2408,8 +2480,10 @@ async def put_index_template( existing index templates. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2469,8 +2543,10 @@ async def simulate_index_template( only used for the simulation. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2509,8 +2585,10 @@ async def get_data_stream( all data streams are returned. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2558,8 +2636,10 @@ async def simulate_template( only used for the simulation. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2602,8 +2682,10 @@ async def resolve_index( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2653,10 +2735,11 @@ async def add_block( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether specified concrete indices @@ -2694,8 +2777,10 @@ async def data_streams_stats( data streams in a cluster, omit this parameter or use `*`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2743,8 +2828,10 @@ async def put_alias( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, diff --git a/opensearchpy/_async/client/ingest.py b/opensearchpy/_async/client/ingest.py index db9e0bbc..cefc4e11 100644 --- a/opensearchpy/_async/client/ingest.py +++ b/opensearchpy/_async/client/ingest.py @@ -66,8 +66,10 @@ async def get_pipeline( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -110,8 +112,10 @@ async def put_pipeline( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -165,8 +169,10 @@ async def delete_pipeline( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -208,8 +214,10 @@ async def simulate( the request body, this parameter is required. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -242,8 +250,10 @@ async def processor_grok( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/client/insights.py b/opensearchpy/_async/client/insights.py new file mode 100644 index 00000000..4d584cee --- /dev/null +++ b/opensearchpy/_async/client/insights.py @@ -0,0 +1,51 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +# ------------------------------------------------------------------------------------------ +# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST +# +# To contribute, kindly make modifications in the opensearch-py client generator +# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md +# and https://github.com/opensearch-project/opensearch-api-specification for details. +# -----------------------------------------------------------------------------------------+ + + +from typing import Any + +from .utils import NamespacedClient, query_params + + +class InsightsClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def top_queries( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Retrieves the top queries based on the given metric type (latency, CPU, or + memory). + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return await self.transport.perform_request( + "GET", "/_insights/top_queries", params=params, headers=headers + ) diff --git a/opensearchpy/_async/client/nodes.py b/opensearchpy/_async/client/nodes.py index cd1dd7c6..4670f663 100644 --- a/opensearchpy/_async/client/nodes.py +++ b/opensearchpy/_async/client/nodes.py @@ -58,8 +58,10 @@ async def reload_secure_settings( target. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -104,8 +106,10 @@ async def info( metrics. Supports a comma-separated list, such as http,ingest. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If true, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -164,8 +168,10 @@ async def stats( expressions of fields to include in fielddata statistics. :arg fields: Comma-separated list or wildcard expressions of fields to include in the statistics. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg groups: Comma-separated list of search groups to include in the search statistics. :arg human: Whether to return human readable values for @@ -224,8 +230,10 @@ async def hot_threads( wait. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_idle_threads: Don't show threads that are in known- @@ -274,8 +282,10 @@ async def usage( `rest_actions`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/client/plugins.py b/opensearchpy/_async/client/plugins.py index acf1ec57..764cb2ca 100644 --- a/opensearchpy/_async/client/plugins.py +++ b/opensearchpy/_async/client/plugins.py @@ -11,6 +11,8 @@ from typing import Any from ..plugins.alerting import AlertingClient +from ..plugins.asynchronous_search import AsynchronousSearchClient +from ..plugins.flow_framework import FlowFrameworkClient from ..plugins.index_management import IndexManagementClient from ..plugins.knn import KnnClient from ..plugins.ml import MlClient @@ -26,6 +28,7 @@ class PluginsClient(NamespacedClient): + asynchronous_search: Any alerting: Any index_management: Any knn: Any @@ -41,6 +44,8 @@ class PluginsClient(NamespacedClient): def __init__(self, client: Client) -> None: super().__init__(client) + self.flow_framework = FlowFrameworkClient(client) + self.asynchronous_search = AsynchronousSearchClient(client) self.alerting = AlertingClient(client) self.index_management = IndexManagementClient(client) self.knn = KnnClient(client) @@ -59,6 +64,8 @@ def _dynamic_lookup(self, client: Any) -> None: # Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742 plugins = [ + "flow_framework", + "asynchronous_search", "alerting", "index_management", "knn", diff --git a/opensearchpy/_async/client/remote_store.py b/opensearchpy/_async/client/remote_store.py index 143ce0b3..7aa18a38 100644 --- a/opensearchpy/_async/client/remote_store.py +++ b/opensearchpy/_async/client/remote_store.py @@ -46,8 +46,10 @@ async def restore( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/client/search_pipeline.py b/opensearchpy/_async/client/search_pipeline.py index 9225085f..ed8c4863 100644 --- a/opensearchpy/_async/client/search_pipeline.py +++ b/opensearchpy/_async/client/search_pipeline.py @@ -46,8 +46,10 @@ async def get( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -83,8 +85,10 @@ async def delete( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -128,8 +132,10 @@ async def put( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/client/security.py b/opensearchpy/_async/client/security.py index 5d3f8171..a3355666 100644 --- a/opensearchpy/_async/client/security.py +++ b/opensearchpy/_async/client/security.py @@ -36,8 +36,10 @@ async def get_account_details( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -62,8 +64,10 @@ async def change_password( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -96,8 +100,10 @@ async def get_action_group( :arg action_group: The name of the action group to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -129,8 +135,10 @@ async def get_action_groups( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -159,8 +167,10 @@ async def delete_action_group( :arg action_group: The name of the action group to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -196,8 +206,10 @@ async def create_action_group( replace. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -232,8 +244,10 @@ async def patch_action_group( :arg action_group: The name of the action group to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -266,8 +280,10 @@ async def patch_action_groups( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -300,8 +316,10 @@ async def get_user( :arg username: The name of the user to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -331,8 +349,10 @@ async def get_users( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -361,8 +381,10 @@ async def delete_user( :arg username: The name of the user to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -395,8 +417,10 @@ async def create_user( :arg username: The name of the user to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -431,8 +455,10 @@ async def patch_user( :arg username: The name of the user to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -465,8 +491,10 @@ async def patch_users( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -498,8 +526,10 @@ async def get_role( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -529,8 +559,10 @@ async def get_roles( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -556,8 +588,10 @@ async def delete_role( :arg role: The name of the role to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -590,8 +624,10 @@ async def create_role( :arg role: The name of the role to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -626,8 +662,10 @@ async def patch_role( :arg role: The name of the role to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -660,8 +698,10 @@ async def patch_roles( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -693,8 +733,10 @@ async def get_role_mapping( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -724,8 +766,10 @@ async def get_role_mappings( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -754,8 +798,10 @@ async def delete_role_mapping( :arg role: The name of the role whose mapping needs to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -788,8 +834,10 @@ async def create_role_mapping( :arg role: The name of the role to create a role mapping for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -824,8 +872,10 @@ async def patch_role_mapping( :arg role: The name of the role to update role-mapping for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -858,8 +908,10 @@ async def patch_role_mappings( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -892,8 +944,10 @@ async def get_tenant( :arg tenant: The name of the tenant to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -923,8 +977,10 @@ async def get_tenants( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -950,8 +1006,10 @@ async def delete_tenant( :arg tenant: The name of the tenant to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -984,8 +1042,10 @@ async def create_tenant( :arg tenant: The name of the tenant to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1020,8 +1080,10 @@ async def patch_tenant( :arg tenant: The name of the tenant to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1054,8 +1116,10 @@ async def patch_tenants( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1086,8 +1150,10 @@ async def get_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1116,8 +1182,10 @@ async def update_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1151,8 +1219,10 @@ async def patch_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1184,8 +1254,10 @@ async def get_distinguished_names( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1211,8 +1283,10 @@ async def get_certificates( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1236,8 +1310,10 @@ async def reload_transport_certificates( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1264,8 +1340,10 @@ async def reload_http_certificates( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1292,8 +1370,10 @@ async def flush_cache( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1317,8 +1397,10 @@ async def health( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg mode: A flag to indicate whether service should consider @@ -1345,8 +1427,10 @@ async def get_audit_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1371,8 +1455,10 @@ async def update_audit_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1404,8 +1490,10 @@ async def patch_audit_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1438,8 +1526,10 @@ async def patch_distinguished_names( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1479,8 +1569,10 @@ async def authinfo( :arg auth_type: The type of current authentication request. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1506,8 +1598,10 @@ async def authtoken( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1531,8 +1625,10 @@ async def cache( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1557,8 +1653,10 @@ async def config_upgrade_check( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1586,8 +1684,10 @@ async def config_upgrade_perform( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1617,8 +1717,10 @@ async def create_allowlist( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1651,8 +1753,10 @@ async def create_update_tenancy_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1686,8 +1790,10 @@ async def create_user_legacy( :arg username: The name of the user to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1723,8 +1829,10 @@ async def delete_distinguished_name( distinguished names. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1758,8 +1866,10 @@ async def delete_user_legacy( :arg username: The name of the user to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1790,8 +1900,10 @@ async def generate_obo_token( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1825,8 +1937,10 @@ async def generate_user_token( be vended. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1861,8 +1975,10 @@ async def generate_user_token_legacy( be vended. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1892,8 +2008,10 @@ async def get_allowlist( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1917,8 +2035,10 @@ async def get_dashboards_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1946,8 +2066,10 @@ async def get_distinguished_name( for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1981,8 +2103,10 @@ async def get_permissions_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2009,8 +2133,10 @@ async def get_sslinfo( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2037,8 +2163,10 @@ async def get_tenancy_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2067,8 +2195,10 @@ async def get_user_legacy( :arg username: The name of the user to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2098,8 +2228,10 @@ async def get_users_legacy( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2123,8 +2255,10 @@ async def migrate( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2149,8 +2283,10 @@ async def patch_allowlist( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2185,8 +2321,10 @@ async def patch_distinguished_name( :arg cluster_name: The cluster-name to update nodesDn value. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2219,8 +2357,10 @@ async def post_dashboards_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2245,8 +2385,10 @@ async def tenant_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2276,8 +2418,10 @@ async def update_distinguished_name( value for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2315,8 +2459,10 @@ async def validate( v6 configuration should be allowed. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2340,8 +2486,10 @@ async def who_am_i( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2367,8 +2515,10 @@ async def who_am_i_protected( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2402,8 +2552,10 @@ async def get_all_certificates( to retrieve from all nodes. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2444,8 +2596,10 @@ async def get_node_certificates( to retrieve for a node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/client/snapshot.py b/opensearchpy/_async/client/snapshot.py index 5a2da968..0fc70be7 100644 --- a/opensearchpy/_async/client/snapshot.py +++ b/opensearchpy/_async/client/snapshot.py @@ -70,8 +70,10 @@ async def create( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -124,8 +126,10 @@ async def delete( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -180,8 +184,10 @@ async def get( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If false, the request returns an error @@ -236,8 +242,10 @@ async def delete_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -284,8 +292,10 @@ async def get_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: Return local information, do not retrieve the state @@ -330,8 +340,10 @@ async def create_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -385,8 +397,10 @@ async def restore( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -438,8 +452,10 @@ async def status( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether to ignore unavailable @@ -485,8 +501,10 @@ async def verify_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -533,8 +551,10 @@ async def cleanup_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -586,8 +606,10 @@ async def clone( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, diff --git a/opensearchpy/_async/client/tasks.py b/opensearchpy/_async/client/tasks.py index cbf2b66d..91826fa1 100644 --- a/opensearchpy/_async/client/tasks.py +++ b/opensearchpy/_async/client/tasks.py @@ -70,8 +70,10 @@ async def list( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg group_by: Key used to group tasks in the response. Valid choices are nodes, none, parents. :arg human: Whether to return human readable values for @@ -123,8 +125,10 @@ async def cancel( actions used to limit the request. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg nodes: Comma-separated list of node IDs or names used to @@ -167,8 +171,10 @@ async def get( :arg task_id: ID of the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/plugins/asynchronous_search.py b/opensearchpy/_async/plugins/asynchronous_search.py new file mode 100644 index 00000000..c8d6a032 --- /dev/null +++ b/opensearchpy/_async/plugins/asynchronous_search.py @@ -0,0 +1,171 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +# ------------------------------------------------------------------------------------------ +# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST +# +# To contribute, kindly make modifications in the opensearch-py client generator +# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md +# and https://github.com/opensearch-project/opensearch-api-specification for details. +# -----------------------------------------------------------------------------------------+ + + +from typing import Any + +from ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params + + +class AsynchronousSearchClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def delete( + self, + id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Delete asynchronous search. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'id'.") + + return await self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_asynchronous_search", id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def get( + self, + id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get partial responses from asynchronous search. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'id'.") + + return await self.transport.perform_request( + "GET", + _make_path("_plugins", "_asynchronous_search", id), + params=params, + headers=headers, + ) + + @query_params( + "error_trace", + "filter_path", + "human", + "index", + "keep_alive", + "keep_on_completion", + "pretty", + "source", + "wait_for_completion_timeout", + ) + async def search( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Perform an asynchronous search. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg index: The name of the index to be searched. + :arg keep_alive: The amount of time that the result is saved in + the cluster. + :arg keep_on_completion: Whether you want to save the results in + the cluster after the search is complete. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg wait_for_completion_timeout: The amount of time that you + plan to wait for the results. + """ + return await self.transport.perform_request( + "POST", + "/_plugins/_asynchronous_search", + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def stats( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Monitoring of asynchronous searches that are running, completed, and/or + persisted. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return await self.transport.perform_request( + "GET", + "/_plugins/_asynchronous_search/stats", + params=params, + headers=headers, + ) diff --git a/opensearchpy/_async/plugins/flow_framework.py b/opensearchpy/_async/plugins/flow_framework.py new file mode 100644 index 00000000..54bb3980 --- /dev/null +++ b/opensearchpy/_async/plugins/flow_framework.py @@ -0,0 +1,417 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +# ------------------------------------------------------------------------------------------ +# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST +# +# To contribute, kindly make modifications in the opensearch-py client generator +# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md +# and https://github.com/opensearch-project/opensearch-api-specification for details. +# -----------------------------------------------------------------------------------------+ + + +from typing import Any + +from ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params + + +class FlowFrameworkClient(NamespacedClient): + @query_params( + "error_trace", + "filter_path", + "human", + "pretty", + "provision", + "reprovision", + "source", + "update_fields", + "use_case", + "validation", + ) + async def create( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Create a workflow. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg use_case: To use a workflow template, specify it in the + use_case query parameter when creating a workflow. + """ + return await self.transport.perform_request( + "POST", + "/_plugins/_flow_framework/workflow", + params=params, + headers=headers, + body=body, + ) + + @query_params( + "clear_status", "error_trace", "filter_path", "human", "pretty", "source" + ) + async def delete( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Delete a workflow. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return await self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_flow_framework", "workflow", workflow_id), + params=params, + headers=headers, + ) + + @query_params( + "allow_delete", "error_trace", "filter_path", "human", "pretty", "source" + ) + async def deprovision( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deprovision workflow's resources when you no longer need it. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return await self.transport.perform_request( + "POST", + _make_path( + "_plugins", "_flow_framework", "workflow", workflow_id, "_deprovision" + ), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def get( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get a workflow. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return await self.transport.perform_request( + "GET", + _make_path("_plugins", "_flow_framework", "workflow", workflow_id), + params=params, + headers=headers, + ) + + @query_params("all", "error_trace", "filter_path", "human", "pretty", "source") + async def get_status( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get the provisioning deployment status until it is complete. + + + :arg all: The all parameter specifies whether the response + should return all fields. Default is false. + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return await self.transport.perform_request( + "GET", + _make_path( + "_plugins", "_flow_framework", "workflow", workflow_id, "_status" + ), + params=params, + headers=headers, + ) + + @query_params( + "error_trace", "filter_path", "human", "pretty", "source", "workflow_step" + ) + async def get_steps( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get a list of workflow steps. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return await self.transport.perform_request( + "GET", + "/_plugins/_flow_framework/workflow/_steps", + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def provision( + self, + workflow_id: Any, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Provisioning a workflow. This API is also executed when the Create or Update + Workflow API is called with the provision parameter set to true. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return await self.transport.perform_request( + "POST", + _make_path( + "_plugins", "_flow_framework", "workflow", workflow_id, "_provision" + ), + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def search( + self, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Search for workflows by using a query matching a field. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + return await self.transport.perform_request( + "POST", + "/_plugins/_flow_framework/workflow/_search", + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def search_state( + self, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Search for workflows by using a query matching a field. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + return await self.transport.perform_request( + "POST", + "/_plugins/_flow_framework/workflow/state/_search", + params=params, + headers=headers, + body=body, + ) + + @query_params( + "error_trace", + "filter_path", + "human", + "pretty", + "provision", + "reprovision", + "source", + "update_fields", + "use_case", + "validation", + ) + async def update( + self, + workflow_id: Any, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Update a workflow. You can only update a complete workflow if it has not yet + been provisioned. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg use_case: To use a workflow template, specify it in the + use_case query parameter when creating a workflow. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return await self.transport.perform_request( + "PUT", + _make_path("_plugins", "_flow_framework", "workflow", workflow_id), + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/_async/plugins/knn.py b/opensearchpy/_async/plugins/knn.py index 5a3e668d..9452313f 100644 --- a/opensearchpy/_async/plugins/knn.py +++ b/opensearchpy/_async/plugins/knn.py @@ -36,8 +36,10 @@ async def delete_model( :arg model_id: The id of the model. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ async def get_model( :arg model_id: The id of the model. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -179,12 +183,13 @@ async def search_models( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. + concrete indices that are open, closed or both. :arg explain: Specify whether to return detailed information about score computation as part of a hit. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting offset. Default is 0. :arg human: Whether to return human readable values for statistics. @@ -281,8 +286,10 @@ async def stats( or empty string to retrieve all stats. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -316,8 +323,10 @@ async def train_model( :arg model_id: The id of the model. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Preferred node to execute training. @@ -353,8 +362,10 @@ async def warmup( string to perform the operation on all indices. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/plugins/ml.py b/opensearchpy/_async/plugins/ml.py index b48bf775..6fd529c0 100644 --- a/opensearchpy/_async/plugins/ml.py +++ b/opensearchpy/_async/plugins/ml.py @@ -35,8 +35,10 @@ async def delete_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -67,8 +69,10 @@ async def delete_model_group( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -101,8 +105,10 @@ async def get_model_group( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -135,8 +141,10 @@ async def get_task( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -167,8 +175,10 @@ async def register_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -197,8 +207,10 @@ async def register_model_group( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -227,8 +239,10 @@ async def search_models( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -257,8 +271,10 @@ async def deploy_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -289,8 +305,10 @@ async def undeploy_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -307,3 +325,171 @@ async def undeploy_model( params=params, headers=headers, ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def create_connector( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Creates a standalone connector. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return await self.transport.perform_request( + "POST", + "/_plugins/_ml/connectors/_create", + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def delete_agent( + self, + agent_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Delete an agent. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if agent_id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'agent_id'.") + + return await self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_ml", "agents", agent_id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def delete_connector( + self, + connector_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deletes a standalone connector. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if connector_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'connector_id'." + ) + + return await self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_ml", "connectors", connector_id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def delete_task( + self, + task_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deletes a task. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if task_id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'task_id'.") + + return await self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_ml", "tasks", task_id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def register_agents( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Register an agent. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return await self.transport.perform_request( + "POST", + "/_plugins/_ml/agents/_register", + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/_async/plugins/notifications.py b/opensearchpy/_async/plugins/notifications.py index 660c5fe1..da8f43ed 100644 --- a/opensearchpy/_async/plugins/notifications.py +++ b/opensearchpy/_async/plugins/notifications.py @@ -35,8 +35,10 @@ async def create_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ async def delete_config( :arg config_id: The ID of the channel configuration to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -111,8 +115,10 @@ async def delete_configs( delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -137,8 +143,10 @@ async def get_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -159,6 +167,8 @@ async def get_config( @query_params( "chime.url", "chime.url.keyword", + "config_id", + "config_id_list", "config_type", "created_time_ms", "description", @@ -211,13 +221,17 @@ async def get_configs( Get multiple channel configurations with filtering. + :arg config_id: Notification configuration ID. + :arg config_id_list: Notification configuration IDs. :arg config_type: Type of notification configuration. Valid choices are chime, email, email_group, microsoft_teams, ses_account, slack, smtp_account, sns, webhook. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -245,8 +259,10 @@ async def list_features( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -271,8 +287,10 @@ async def send_test( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -304,8 +322,10 @@ async def update_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -337,8 +357,10 @@ async def list_channels( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/plugins/observability.py b/opensearchpy/_async/plugins/observability.py index 97d05b22..0fd38f63 100644 --- a/opensearchpy/_async/plugins/observability.py +++ b/opensearchpy/_async/plugins/observability.py @@ -35,8 +35,10 @@ async def create_object( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -66,8 +68,10 @@ async def delete_object( :arg object_id: The ID of the Observability Object. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -105,8 +109,10 @@ async def delete_objects( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg objectId: The ID of a single Observability Object to @@ -134,8 +140,10 @@ async def get_localstats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -164,8 +172,10 @@ async def get_object( :arg object_id: The ID of the Observability Object. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -195,8 +205,10 @@ async def list_objects( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -223,8 +235,10 @@ async def update_object( :arg object_id: The ID of the Observability Object. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/plugins/ppl.py b/opensearchpy/_async/plugins/ppl.py index 96237282..eba13f52 100644 --- a/opensearchpy/_async/plugins/ppl.py +++ b/opensearchpy/_async/plugins/ppl.py @@ -37,8 +37,10 @@ async def explain( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -71,8 +73,10 @@ async def get_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -104,8 +108,10 @@ async def post_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -139,8 +145,10 @@ async def query( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for diff --git a/opensearchpy/_async/plugins/query.py b/opensearchpy/_async/plugins/query.py index 7a208031..46bc29fa 100644 --- a/opensearchpy/_async/plugins/query.py +++ b/opensearchpy/_async/plugins/query.py @@ -36,8 +36,10 @@ async def datasource_delete( :arg datasource_name: The Name of the DataSource to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -71,8 +73,10 @@ async def datasource_retrieve( :arg datasource_name: The Name of the DataSource to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -105,8 +109,10 @@ async def datasources_create( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -134,8 +140,10 @@ async def datasources_list( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -160,8 +168,10 @@ async def datasources_update( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/plugins/rollups.py b/opensearchpy/_async/plugins/rollups.py index 5a4f7091..7b05eef8 100644 --- a/opensearchpy/_async/plugins/rollups.py +++ b/opensearchpy/_async/plugins/rollups.py @@ -36,8 +36,10 @@ async def delete( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ async def explain( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -102,8 +106,10 @@ async def get( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -144,8 +150,10 @@ async def put( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -182,8 +190,10 @@ async def start( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -215,8 +225,10 @@ async def stop( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/_async/plugins/sql.py b/opensearchpy/_async/plugins/sql.py index 625508b3..e84d04e5 100644 --- a/opensearchpy/_async/plugins/sql.py +++ b/opensearchpy/_async/plugins/sql.py @@ -37,8 +37,10 @@ async def close( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -72,8 +74,10 @@ async def explain( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -106,8 +110,10 @@ async def get_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -139,8 +145,10 @@ async def post_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -174,8 +182,10 @@ async def query( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -207,8 +217,10 @@ async def settings( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for diff --git a/opensearchpy/_async/plugins/transforms.py b/opensearchpy/_async/plugins/transforms.py index 9559097f..4a438459 100644 --- a/opensearchpy/_async/plugins/transforms.py +++ b/opensearchpy/_async/plugins/transforms.py @@ -36,8 +36,10 @@ async def delete( :arg id: Transform to delete :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ async def explain( :arg id: Transform to explain :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -102,8 +106,10 @@ async def get( :arg id: Transform to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -124,6 +130,7 @@ async def get( @query_params("error_trace", "filter_path", "human", "pretty", "source") async def preview( self, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -133,8 +140,10 @@ async def preview( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -143,7 +152,11 @@ async def preview( libraries that do not accept a request body for non-POST requests. """ return await self.transport.perform_request( - "GET", "/_plugins/_transform/_preview", params=params, headers=headers + "POST", + "/_plugins/_transform/_preview", + params=params, + headers=headers, + body=body, ) @query_params( @@ -170,8 +183,10 @@ async def put( :arg id: Transform to create/update :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -217,8 +232,10 @@ async def search( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: The starting transform to return. Default is `0`. :arg human: Whether to return human readable values for statistics. @@ -255,8 +272,10 @@ async def start( :arg id: Transform to start :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -288,8 +307,10 @@ async def stop( :arg id: Transform to stop :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/client/__init__.py b/opensearchpy/client/__init__.py index 8055eead..546abfe7 100644 --- a/opensearchpy/client/__init__.py +++ b/opensearchpy/client/__init__.py @@ -46,6 +46,7 @@ from .http import HttpClient from .indices import IndicesClient from .ingest import IngestClient +from .insights import InsightsClient from .nodes import NodesClient from .plugins import PluginsClient from .remote import RemoteClient @@ -214,6 +215,7 @@ class as kwargs, or a string in the format of ``host[:port]`` which will be super().__init__(hosts, transport_class, **kwargs) # namespaced clients for compatibility with API names + self.insights = InsightsClient(self) self.search_pipeline = SearchPipelineClient(self) self.cat = CatClient(self) self.cluster = ClusterClient(self) @@ -268,8 +270,10 @@ def ping( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -296,8 +300,10 @@ def info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -345,8 +351,10 @@ def create( :arg body: The document :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pipeline: ID of the pipeline to use to preprocess incoming @@ -423,8 +431,10 @@ def index( :arg id: Unique identifier for the document. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -519,8 +529,10 @@ def bulk( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pipeline: ID of the pipeline to use to preprocess incoming @@ -578,8 +590,10 @@ def clear_scroll( clear all scroll IDs, use `_all`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -656,10 +670,11 @@ def count( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + separated values, such as `open,hidden`. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_throttled: If `true`, concrete, expanded or aliased @@ -721,8 +736,10 @@ def delete( :arg id: Unique identifier for the document. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -842,8 +859,10 @@ def delete_by_query( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting offset. Default is 0. :arg human: Whether to return human readable values for statistics. @@ -933,8 +952,10 @@ def delete_by_query_rethrottle( :arg task_id: The ID for the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -979,8 +1000,10 @@ def delete_script( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1041,8 +1064,10 @@ def exists( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1113,8 +1138,10 @@ def exists_source( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1197,8 +1224,10 @@ def explain( in the query string. Default is _all. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg lenient: If `true`, format-based query failures (such as @@ -1264,12 +1293,13 @@ def field_caps( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. + separated values, such as `open,hidden`. :arg fields: Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `true`, missing or closed indices @@ -1327,8 +1357,10 @@ def get( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1385,8 +1417,10 @@ def get_script( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1441,8 +1475,10 @@ def get_source( to include in the response. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1517,8 +1553,10 @@ def mget( is `false`, this parameter is ignored. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Specifies the node or shard the operation @@ -1581,8 +1619,10 @@ def msearch( cross-cluster search requests. Default is True. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg max_concurrent_searches: Maximum number of concurrent @@ -1654,8 +1694,10 @@ def msearch_template( minimized for cross-cluster search requests. Default is True. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg max_concurrent_searches: Maximum number of concurrent @@ -1728,8 +1770,10 @@ def mtermvectors( fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ids: A comma-separated list of documents ids. You must @@ -1795,8 +1839,10 @@ def put_script( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1861,17 +1907,19 @@ def rank_eval( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `true`, missing or closed indices are not included in the response. :arg pretty: Whether to pretty format the returned JSON response. - :arg search_type: Search operation type + :arg search_type: Search operation type Valid choices are + dfs_query_then_fetch, query_then_fetch. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1917,8 +1965,10 @@ def reindex( prototype for the index request. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg max_docs: Maximum number of documents to process. By @@ -1968,8 +2018,10 @@ def reindex_rethrottle( :arg task_id: Identifier for the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2006,8 +2058,10 @@ def render_search_template( specified, this or the `id` request body parameter is required. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2037,8 +2091,10 @@ def scripts_painless_execute( :arg body: The script to execute :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2079,8 +2135,10 @@ def scroll( :arg scroll_id: The scroll ID for scrolled search :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2226,12 +2284,13 @@ def search( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. + separated values, such as `open,hidden`. :arg explain: If `true`, returns detailed information about score computation as part of a hit. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting document offset. Needs to be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the @@ -2408,8 +2467,10 @@ def search_shards( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -2480,8 +2541,10 @@ def search_template( `open`, `closed`, `hidden`, `none`. :arg explain: If `true`, the response includes additional details about score computation as part of a hit. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_throttled: If `true`, specified concrete, expanded, @@ -2561,8 +2624,10 @@ def termvectors( fields to include in the statistics. Used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg offsets: If `true`, the response includes term offsets. @@ -2640,8 +2705,10 @@ def update( retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -2768,8 +2835,10 @@ def update_by_query( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting offset. Default is 0. :arg human: Whether to return human readable values for statistics. @@ -2862,8 +2931,10 @@ def update_by_query_rethrottle( :arg task_id: The ID for the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2895,8 +2966,10 @@ def get_script_context( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2920,8 +2993,10 @@ def get_script_languages( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2962,10 +3037,11 @@ def create_pit( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg keep_alive: Specify the keep alive for point in time. @@ -2999,8 +3075,10 @@ def delete_all_pits( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -3026,8 +3104,10 @@ def delete_pit( :arg body: The point-in-time ids to be deleted :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -3055,8 +3135,10 @@ def get_all_pits( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -3067,3 +3149,93 @@ def get_all_pits( return self.transport.perform_request( "GET", "/_search/point_in_time/_all", params=params, headers=headers ) + + @query_params( + "_source", + "_source_excludes", + "_source_includes", + "batch_interval", + "batch_size", + "error_trace", + "filter_path", + "human", + "pipeline", + "pretty", + "refresh", + "require_alias", + "routing", + "source", + "timeout", + "wait_for_active_shards", + ) + def bulk_stream( + self, + body: Any, + index: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Allows to perform multiple index/update/delete operations using request + response streaming. + + + :arg body: The operation definition and data (action-data + pairs), separated by newlines + :arg index: Name of the data stream, index, or index alias to + perform bulk actions on. + :arg _source: `true` or `false` to return the `_source` field or + not, or a list of fields to return. + :arg _source_excludes: A comma-separated list of source fields + to exclude from the response. + :arg _source_includes: A comma-separated list of source fields + to include in the response. + :arg batch_interval: Specifies for how long bulk operations + should be accumulated into a batch before sending the batch to data + nodes. + :arg batch_size: Specifies how many bulk operations should be + accumulated into a batch before sending the batch to data nodes. + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pipeline: ID of the pipeline to use to preprocess incoming + documents. If the index has a default ingest pipeline specified, then + setting the value to `_none` disables the default ingest pipeline for + this request. If a final pipeline is configured it will always run, + regardless of the value of this parameter. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg refresh: If `true`, OpenSearch refreshes 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` do + nothing with refreshes. Valid values: `true`, `false`, `wait_for`. + :arg require_alias: If `true`, the request's actions must target + an index alias. Default is false. + :arg routing: Custom value used to route operations to a + specific shard. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg timeout: Period each action waits for the following + operations: automatic index creation, dynamic mapping updates, waiting + for active shards. + :arg wait_for_active_shards: The number of shard copies that + must be active before proceeding with the operation. Set to all or any + positive integer up to the total number of shards in the index + (`number_of_replicas+1`). Valid choices are all, index-setting. + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + body = _bulk_body(self.transport.serializer, body) + return self.transport.perform_request( + "PUT", + _make_path(index, "_bulk", "stream"), + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/client/cat.py b/opensearchpy/client/cat.py index 16255cd4..53fdcb77 100644 --- a/opensearchpy/client/cat.py +++ b/opensearchpy/client/cat.py @@ -71,10 +71,11 @@ def aliases( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -121,8 +122,10 @@ def all_pit_segments( choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -176,8 +179,10 @@ def allocation( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -232,8 +237,10 @@ def cluster_manager( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -285,8 +292,10 @@ def count( all data streams and indices, omit this parameter or use `*` or `_all`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -335,8 +344,10 @@ def fielddata( are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -383,8 +394,10 @@ def health( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -419,8 +432,10 @@ def help( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -474,9 +489,11 @@ def indices( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: The type of index that wildcard patterns - can match. Valid choices are all, closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + can match. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -538,8 +555,10 @@ def master( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -596,8 +615,10 @@ def nodeattrs( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -654,8 +675,10 @@ def nodes( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg full_id: If `true`, return the full node ID. If `false`, @@ -713,8 +736,10 @@ def pending_tasks( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -767,8 +792,10 @@ def pit_segments( choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -815,8 +842,10 @@ def plugins( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -876,8 +905,10 @@ def recovery( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -926,8 +957,10 @@ def repositories( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1001,10 +1034,11 @@ def segment_replication( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1068,8 +1102,10 @@ def segments( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1127,8 +1163,10 @@ def shards( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1187,8 +1225,10 @@ def thread_pool( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1250,8 +1290,10 @@ def snapshots( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1313,8 +1355,10 @@ def tasks( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. @@ -1372,8 +1416,10 @@ def templates( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg h: Comma-separated list of column names to display. diff --git a/opensearchpy/client/cluster.py b/opensearchpy/client/cluster.py index 271ed4d3..5bb8202b 100644 --- a/opensearchpy/client/cluster.py +++ b/opensearchpy/client/cluster.py @@ -81,10 +81,11 @@ def health( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg level: Can be one of cluster, indices or shards. Controls @@ -159,8 +160,10 @@ def pending_tasks( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: If `true`, the request retrieves information from @@ -218,10 +221,11 @@ def state( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -275,8 +279,10 @@ def stats( returned information. Defaults to all nodes in the cluster. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -335,8 +341,10 @@ def reroute( errors. :arg explain: If true, then the response contains an explanation of why the commands can or cannot be executed. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -384,8 +392,10 @@ def get_settings( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -435,8 +445,10 @@ def put_settings( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -469,8 +481,10 @@ def remote_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -505,8 +519,10 @@ def allocation_explain( means 'explain the first unassigned shard' :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg include_disk_info: If true, returns information about disk @@ -552,8 +568,10 @@ def delete_component_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -604,8 +622,10 @@ def get_component_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: If `true`, the request retrieves information from @@ -666,8 +686,10 @@ def put_component_template( existing component templates. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -718,8 +740,10 @@ def exists_component_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: If true, the request retrieves information from the @@ -758,8 +782,10 @@ def delete_voting_config_exclusions( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -802,8 +828,10 @@ def post_voting_config_exclusions( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg node_ids: A comma-separated list of the persistent ids of @@ -838,8 +866,10 @@ def delete_decommission_awareness( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -854,6 +884,7 @@ def delete_decommission_awareness( @query_params("error_trace", "filter_path", "human", "pretty", "source") def delete_weighted_routing( self, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -863,8 +894,10 @@ def delete_weighted_routing( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -877,6 +910,7 @@ def delete_weighted_routing( "/_cluster/routing/awareness/weights", params=params, headers=headers, + body=body, ) @query_params("error_trace", "filter_path", "human", "pretty", "source") @@ -893,8 +927,10 @@ def get_decommission_awareness( :arg awareness_attribute_name: Awareness attribute name. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -934,8 +970,10 @@ def get_weighted_routing( :arg attribute: Awareness attribute name. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -969,8 +1007,10 @@ def put_decommission_awareness( :arg awareness_attribute_value: Awareness attribute value. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -999,6 +1039,7 @@ def put_decommission_awareness( def put_weighted_routing( self, attribute: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -1009,8 +1050,10 @@ def put_weighted_routing( :arg attribute: Awareness attribute name. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1026,4 +1069,5 @@ def put_weighted_routing( _make_path("_cluster", "routing", "awareness", attribute, "weights"), params=params, headers=headers, + body=body, ) diff --git a/opensearchpy/client/dangling_indices.py b/opensearchpy/client/dangling_indices.py index bee5c3f1..2b4b1edb 100644 --- a/opensearchpy/client/dangling_indices.py +++ b/opensearchpy/client/dangling_indices.py @@ -68,8 +68,10 @@ def delete_dangling_index( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -119,8 +121,10 @@ def import_dangling_index( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -151,8 +155,10 @@ def list_dangling_indices( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/client/indices.py b/opensearchpy/client/indices.py index e4ed6fa5..564de9a4 100644 --- a/opensearchpy/client/indices.py +++ b/opensearchpy/client/indices.py @@ -58,8 +58,10 @@ def analyze( :arg index: The name of the index to scope the operation. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -109,8 +111,10 @@ def refresh( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -160,8 +164,10 @@ def flush( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg force: If `true`, the request forces a flush even if there are no changes to commit to the index. :arg human: Whether to return human readable values for @@ -210,8 +216,10 @@ def create( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -270,8 +278,10 @@ def clone( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -347,10 +357,11 @@ def get( :arg expand_wildcards: Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. - Supports comma-separated values, such as open,hidden. Valid choices are - all, closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + Supports comma-separated values, such as open,hidden. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If true, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -424,8 +435,10 @@ def open( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -496,8 +509,10 @@ def close( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -565,8 +580,10 @@ def delete( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -629,8 +646,10 @@ def exists( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -694,8 +713,10 @@ def put_mapping( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -767,8 +788,10 @@ def get_mapping( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -827,8 +850,10 @@ def get_field_mapping( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -890,8 +915,10 @@ def exists_alias( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, requests that include a @@ -950,8 +977,10 @@ def get_alias( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -992,8 +1021,10 @@ def update_aliases( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1044,8 +1075,10 @@ def delete_alias( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1098,8 +1131,10 @@ def put_template( existing index templates. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1153,8 +1188,10 @@ def exists_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1205,8 +1242,10 @@ def get_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1252,8 +1291,10 @@ def delete_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1319,10 +1360,11 @@ def get_settings( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + separated values, such as `open,hidden`. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1389,10 +1431,11 @@ def put_settings( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + separated values, such as `open,hidden`. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If `true`, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -1462,14 +1505,15 @@ def stats( :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma- - separated values, such as `open,hidden`. Valid choices are all, closed, - hidden, none, open. + separated values, such as `open,hidden`. :arg fielddata_fields: Comma-separated list or wildcard expressions of fields to include in fielddata statistics. :arg fields: Comma-separated list or wildcard expressions of fields to include in the statistics. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg forbid_closed_indices: If true, statistics are not collected from closed indices. Default is True. :arg groups: Comma-separated list of search groups to include in @@ -1529,8 +1573,10 @@ def segments( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -1605,8 +1651,10 @@ def validate_query( `open`, `closed`, `hidden`, `none`. :arg explain: If `true`, the response returns detailed information if an error has occurred. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -1673,8 +1721,10 @@ def clear_cache( the `fielddata` parameter. :arg file: If true, clears the unused entries from the file cache on nodes with the Search role. Default is false. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If `false`, the request returns an @@ -1718,8 +1768,10 @@ def recovery( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1761,10 +1813,11 @@ def upgrade( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether specified concrete indices @@ -1810,10 +1863,11 @@ def get_upgrade( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether specified concrete indices @@ -1858,10 +1912,11 @@ def shard_stores( errors. :arg expand_wildcards: Type of index that wildcard patterns can match. If the request can target data streams, this argument determines - whether wildcard expressions match hidden data streams. Valid choices - are all, closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + whether wildcard expressions match hidden data streams. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If true, missing or closed indices are @@ -1910,10 +1965,11 @@ def forcemerge( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flush: Specify whether the index should be flushed after performing the operation. Default is True. :arg human: Whether to return human readable values for @@ -1975,8 +2031,10 @@ def shrink( source index. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2048,8 +2106,10 @@ def split( source index. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2121,8 +2181,10 @@ def rollover( Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2173,8 +2235,10 @@ def create_data_stream( :arg body: The data stream definition :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2208,8 +2272,10 @@ def delete_data_stream( Wildcard (`*`) expressions are supported. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2250,8 +2316,10 @@ def delete_index_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2303,8 +2371,10 @@ def exists_index_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: Return settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -2354,8 +2424,10 @@ def get_index_template( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If true, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -2408,8 +2480,10 @@ def put_index_template( existing index templates. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2469,8 +2543,10 @@ def simulate_index_template( only used for the simulation. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2509,8 +2585,10 @@ def get_data_stream( all data streams are returned. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2558,8 +2636,10 @@ def simulate_template( only used for the simulation. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2602,8 +2682,10 @@ def resolve_index( whether wildcard expressions match hidden data streams. Supports comma- separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2653,10 +2735,11 @@ def add_block( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + concrete indices that are open, closed or both. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether specified concrete indices @@ -2694,8 +2777,10 @@ def data_streams_stats( data streams in a cluster, omit this parameter or use `*`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2743,8 +2828,10 @@ def put_alias( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, diff --git a/opensearchpy/client/ingest.py b/opensearchpy/client/ingest.py index 7d070bff..f382146c 100644 --- a/opensearchpy/client/ingest.py +++ b/opensearchpy/client/ingest.py @@ -66,8 +66,10 @@ def get_pipeline( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -110,8 +112,10 @@ def put_pipeline( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -165,8 +169,10 @@ def delete_pipeline( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -208,8 +214,10 @@ def simulate( the request body, this parameter is required. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -242,8 +250,10 @@ def processor_grok( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/client/insights.py b/opensearchpy/client/insights.py new file mode 100644 index 00000000..e1b31609 --- /dev/null +++ b/opensearchpy/client/insights.py @@ -0,0 +1,51 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +# ------------------------------------------------------------------------------------------ +# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST +# +# To contribute, kindly make modifications in the opensearch-py client generator +# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md +# and https://github.com/opensearch-project/opensearch-api-specification for details. +# -----------------------------------------------------------------------------------------+ + + +from typing import Any + +from .utils import NamespacedClient, query_params + + +class InsightsClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def top_queries( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Retrieves the top queries based on the given metric type (latency, CPU, or + memory). + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return self.transport.perform_request( + "GET", "/_insights/top_queries", params=params, headers=headers + ) diff --git a/opensearchpy/client/nodes.py b/opensearchpy/client/nodes.py index 0e264488..7ed3d60d 100644 --- a/opensearchpy/client/nodes.py +++ b/opensearchpy/client/nodes.py @@ -58,8 +58,10 @@ def reload_secure_settings( target. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -104,8 +106,10 @@ def info( metrics. Supports a comma-separated list, such as http,ingest. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg flat_settings: If true, returns settings in flat format. Default is false. :arg human: Whether to return human readable values for @@ -164,8 +168,10 @@ def stats( expressions of fields to include in fielddata statistics. :arg fields: Comma-separated list or wildcard expressions of fields to include in the statistics. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg groups: Comma-separated list of search groups to include in the search statistics. :arg human: Whether to return human readable values for @@ -224,8 +230,10 @@ def hot_threads( wait. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_idle_threads: Don't show threads that are in known- @@ -274,8 +282,10 @@ def usage( `rest_actions`. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/client/plugins.py b/opensearchpy/client/plugins.py index 526e1cab..764cb2ca 100644 --- a/opensearchpy/client/plugins.py +++ b/opensearchpy/client/plugins.py @@ -11,6 +11,8 @@ from typing import Any from ..plugins.alerting import AlertingClient +from ..plugins.asynchronous_search import AsynchronousSearchClient +from ..plugins.flow_framework import FlowFrameworkClient from ..plugins.index_management import IndexManagementClient from ..plugins.knn import KnnClient from ..plugins.ml import MlClient @@ -26,12 +28,24 @@ class PluginsClient(NamespacedClient): + asynchronous_search: Any alerting: Any index_management: Any + knn: Any + ml: Any + notifications: Any + observability: Any + ppl: Any + query: Any + rollups: Any + sql: Any + transforms: Any def __init__(self, client: Client) -> None: super().__init__(client) + self.flow_framework = FlowFrameworkClient(client) + self.asynchronous_search = AsynchronousSearchClient(client) self.alerting = AlertingClient(client) self.index_management = IndexManagementClient(client) self.knn = KnnClient(client) @@ -50,13 +64,19 @@ def _dynamic_lookup(self, client: Any) -> None: # Issue : https://github.com/opensearch-project/opensearch-py/issues/90#issuecomment-1003396742 plugins = [ - # "query_workbench", - # "reporting", - # "notebooks", + "flow_framework", + "asynchronous_search", "alerting", - # "anomaly_detection", - # "trace_analytics", "index_management", + "knn", + "ml", + "notifications", + "observability", + "ppl", + "query", + "rollups", + "sql", + "transforms", ] for plugin in plugins: if not hasattr(client, plugin): diff --git a/opensearchpy/client/remote_store.py b/opensearchpy/client/remote_store.py index 20e22eae..ae815807 100644 --- a/opensearchpy/client/remote_store.py +++ b/opensearchpy/client/remote_store.py @@ -46,8 +46,10 @@ def restore( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/client/search_pipeline.py b/opensearchpy/client/search_pipeline.py index bd764c3c..d9769ebf 100644 --- a/opensearchpy/client/search_pipeline.py +++ b/opensearchpy/client/search_pipeline.py @@ -46,8 +46,10 @@ def get( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -83,8 +85,10 @@ def delete( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -128,8 +132,10 @@ def put( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/client/security.py b/opensearchpy/client/security.py index 0b2d63a4..06678226 100644 --- a/opensearchpy/client/security.py +++ b/opensearchpy/client/security.py @@ -36,8 +36,10 @@ def get_account_details( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -62,8 +64,10 @@ def change_password( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -96,8 +100,10 @@ def get_action_group( :arg action_group: The name of the action group to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -129,8 +135,10 @@ def get_action_groups( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -159,8 +167,10 @@ def delete_action_group( :arg action_group: The name of the action group to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -196,8 +206,10 @@ def create_action_group( replace. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -232,8 +244,10 @@ def patch_action_group( :arg action_group: The name of the action group to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -266,8 +280,10 @@ def patch_action_groups( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -300,8 +316,10 @@ def get_user( :arg username: The name of the user to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -331,8 +349,10 @@ def get_users( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -361,8 +381,10 @@ def delete_user( :arg username: The name of the user to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -395,8 +417,10 @@ def create_user( :arg username: The name of the user to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -431,8 +455,10 @@ def patch_user( :arg username: The name of the user to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -465,8 +491,10 @@ def patch_users( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -498,8 +526,10 @@ def get_role( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -529,8 +559,10 @@ def get_roles( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -556,8 +588,10 @@ def delete_role( :arg role: The name of the role to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -590,8 +624,10 @@ def create_role( :arg role: The name of the role to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -626,8 +662,10 @@ def patch_role( :arg role: The name of the role to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -660,8 +698,10 @@ def patch_roles( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -693,8 +733,10 @@ def get_role_mapping( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -724,8 +766,10 @@ def get_role_mappings( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -754,8 +798,10 @@ def delete_role_mapping( :arg role: The name of the role whose mapping needs to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -788,8 +834,10 @@ def create_role_mapping( :arg role: The name of the role to create a role mapping for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -824,8 +872,10 @@ def patch_role_mapping( :arg role: The name of the role to update role-mapping for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -858,8 +908,10 @@ def patch_role_mappings( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -892,8 +944,10 @@ def get_tenant( :arg tenant: The name of the tenant to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -923,8 +977,10 @@ def get_tenants( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -950,8 +1006,10 @@ def delete_tenant( :arg tenant: The name of the tenant to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -984,8 +1042,10 @@ def create_tenant( :arg tenant: The name of the tenant to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1020,8 +1080,10 @@ def patch_tenant( :arg tenant: The name of the tenant to update. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1054,8 +1116,10 @@ def patch_tenants( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1086,8 +1150,10 @@ def get_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1116,8 +1182,10 @@ def update_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1151,8 +1219,10 @@ def patch_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1184,8 +1254,10 @@ def get_distinguished_names( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1211,8 +1283,10 @@ def get_certificates( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1236,8 +1310,10 @@ def reload_transport_certificates( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1264,8 +1340,10 @@ def reload_http_certificates( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1292,8 +1370,10 @@ def flush_cache( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1317,8 +1397,10 @@ def health( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg mode: A flag to indicate whether service should consider @@ -1345,8 +1427,10 @@ def get_audit_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1371,8 +1455,10 @@ def update_audit_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1404,8 +1490,10 @@ def patch_audit_configuration( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1438,8 +1526,10 @@ def patch_distinguished_names( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1479,8 +1569,10 @@ def authinfo( :arg auth_type: The type of current authentication request. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1506,8 +1598,10 @@ def authtoken( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1531,8 +1625,10 @@ def cache( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1557,8 +1653,10 @@ def config_upgrade_check( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1586,8 +1684,10 @@ def config_upgrade_perform( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1617,8 +1717,10 @@ def create_allowlist( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1651,8 +1753,10 @@ def create_update_tenancy_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1686,8 +1790,10 @@ def create_user_legacy( :arg username: The name of the user to be created. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1723,8 +1829,10 @@ def delete_distinguished_name( distinguished names. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1758,8 +1866,10 @@ def delete_user_legacy( :arg username: The name of the user to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1790,8 +1900,10 @@ def generate_obo_token( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1825,8 +1937,10 @@ def generate_user_token( be vended. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1861,8 +1975,10 @@ def generate_user_token_legacy( be vended. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1892,8 +2008,10 @@ def get_allowlist( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1917,8 +2035,10 @@ def get_dashboards_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1946,8 +2066,10 @@ def get_distinguished_name( for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -1981,8 +2103,10 @@ def get_permissions_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2009,8 +2133,10 @@ def get_sslinfo( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2037,8 +2163,10 @@ def get_tenancy_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2067,8 +2195,10 @@ def get_user_legacy( :arg username: The name of the user to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2098,8 +2228,10 @@ def get_users_legacy( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2123,8 +2255,10 @@ def migrate( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2149,8 +2283,10 @@ def patch_allowlist( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2185,8 +2321,10 @@ def patch_distinguished_name( :arg cluster_name: The cluster-name to update nodesDn value. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2219,8 +2357,10 @@ def post_dashboards_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2245,8 +2385,10 @@ def tenant_info( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2276,8 +2418,10 @@ def update_distinguished_name( value for. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2315,8 +2459,10 @@ def validate( v6 configuration should be allowed. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2340,8 +2486,10 @@ def who_am_i( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2367,8 +2515,10 @@ def who_am_i_protected( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2402,8 +2552,10 @@ def get_all_certificates( to retrieve from all nodes. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -2444,8 +2596,10 @@ def get_node_certificates( to retrieve for a node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/client/snapshot.py b/opensearchpy/client/snapshot.py index 0c68d75c..8491a410 100644 --- a/opensearchpy/client/snapshot.py +++ b/opensearchpy/client/snapshot.py @@ -70,8 +70,10 @@ def create( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -124,8 +126,10 @@ def delete( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -180,8 +184,10 @@ def get( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: If false, the request returns an error @@ -236,8 +242,10 @@ def delete_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -284,8 +292,10 @@ def get_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg local: Return local information, do not retrieve the state @@ -330,8 +340,10 @@ def create_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -385,8 +397,10 @@ def restore( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -438,8 +452,10 @@ def status( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg ignore_unavailable: Whether to ignore unavailable @@ -485,8 +501,10 @@ def verify_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -533,8 +551,10 @@ def cleanup_repository( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, @@ -586,8 +606,10 @@ def clone( to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg master_timeout (Deprecated: To promote inclusive language, diff --git a/opensearchpy/client/tasks.py b/opensearchpy/client/tasks.py index 2303bb7e..24d531d8 100644 --- a/opensearchpy/client/tasks.py +++ b/opensearchpy/client/tasks.py @@ -70,8 +70,10 @@ def list( information about shard recoveries. Default is false. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg group_by: Key used to group tasks in the response. Valid choices are nodes, none, parents. :arg human: Whether to return human readable values for @@ -123,8 +125,10 @@ def cancel( actions used to limit the request. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg nodes: Comma-separated list of node IDs or names used to @@ -167,8 +171,10 @@ def get( :arg task_id: ID of the task. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/plugins/asynchronous_search.py b/opensearchpy/plugins/asynchronous_search.py new file mode 100644 index 00000000..5f0dc850 --- /dev/null +++ b/opensearchpy/plugins/asynchronous_search.py @@ -0,0 +1,171 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +# ------------------------------------------------------------------------------------------ +# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST +# +# To contribute, kindly make modifications in the opensearch-py client generator +# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md +# and https://github.com/opensearch-project/opensearch-api-specification for details. +# -----------------------------------------------------------------------------------------+ + + +from typing import Any + +from ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params + + +class AsynchronousSearchClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def delete( + self, + id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Delete asynchronous search. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'id'.") + + return self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_asynchronous_search", id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def get( + self, + id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get partial responses from asynchronous search. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'id'.") + + return self.transport.perform_request( + "GET", + _make_path("_plugins", "_asynchronous_search", id), + params=params, + headers=headers, + ) + + @query_params( + "error_trace", + "filter_path", + "human", + "index", + "keep_alive", + "keep_on_completion", + "pretty", + "source", + "wait_for_completion_timeout", + ) + def search( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Perform an asynchronous search. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg index: The name of the index to be searched. + :arg keep_alive: The amount of time that the result is saved in + the cluster. + :arg keep_on_completion: Whether you want to save the results in + the cluster after the search is complete. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg wait_for_completion_timeout: The amount of time that you + plan to wait for the results. + """ + return self.transport.perform_request( + "POST", + "/_plugins/_asynchronous_search", + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def stats( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Monitoring of asynchronous searches that are running, completed, and/or + persisted. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return self.transport.perform_request( + "GET", + "/_plugins/_asynchronous_search/stats", + params=params, + headers=headers, + ) diff --git a/opensearchpy/plugins/flow_framework.py b/opensearchpy/plugins/flow_framework.py new file mode 100644 index 00000000..e21ab1ab --- /dev/null +++ b/opensearchpy/plugins/flow_framework.py @@ -0,0 +1,417 @@ +# SPDX-License-Identifier: Apache-2.0 +# +# The OpenSearch Contributors require contributions made to +# this file be licensed under the Apache-2.0 license or a +# compatible open source license. +# +# Modifications Copyright OpenSearch Contributors. See +# GitHub history for details. + +# ------------------------------------------------------------------------------------------ +# THIS CODE IS AUTOMATICALLY GENERATED AND MANUAL EDITS WILL BE LOST +# +# To contribute, kindly make modifications in the opensearch-py client generator +# or in the OpenSearch API specification, and run `nox -rs generate`. See DEVELOPER_GUIDE.md +# and https://github.com/opensearch-project/opensearch-api-specification for details. +# -----------------------------------------------------------------------------------------+ + + +from typing import Any + +from ..client.utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params + + +class FlowFrameworkClient(NamespacedClient): + @query_params( + "error_trace", + "filter_path", + "human", + "pretty", + "provision", + "reprovision", + "source", + "update_fields", + "use_case", + "validation", + ) + def create( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Create a workflow. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg use_case: To use a workflow template, specify it in the + use_case query parameter when creating a workflow. + """ + return self.transport.perform_request( + "POST", + "/_plugins/_flow_framework/workflow", + params=params, + headers=headers, + body=body, + ) + + @query_params( + "clear_status", "error_trace", "filter_path", "human", "pretty", "source" + ) + def delete( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Delete a workflow. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_flow_framework", "workflow", workflow_id), + params=params, + headers=headers, + ) + + @query_params( + "allow_delete", "error_trace", "filter_path", "human", "pretty", "source" + ) + def deprovision( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deprovision workflow's resources when you no longer need it. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return self.transport.perform_request( + "POST", + _make_path( + "_plugins", "_flow_framework", "workflow", workflow_id, "_deprovision" + ), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def get( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get a workflow. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return self.transport.perform_request( + "GET", + _make_path("_plugins", "_flow_framework", "workflow", workflow_id), + params=params, + headers=headers, + ) + + @query_params("all", "error_trace", "filter_path", "human", "pretty", "source") + def get_status( + self, + workflow_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get the provisioning deployment status until it is complete. + + + :arg all: The all parameter specifies whether the response + should return all fields. Default is false. + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return self.transport.perform_request( + "GET", + _make_path( + "_plugins", "_flow_framework", "workflow", workflow_id, "_status" + ), + params=params, + headers=headers, + ) + + @query_params( + "error_trace", "filter_path", "human", "pretty", "source", "workflow_step" + ) + def get_steps( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Get a list of workflow steps. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return self.transport.perform_request( + "GET", + "/_plugins/_flow_framework/workflow/_steps", + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def provision( + self, + workflow_id: Any, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Provisioning a workflow. This API is also executed when the Create or Update + Workflow API is called with the provision parameter set to true. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return self.transport.perform_request( + "POST", + _make_path( + "_plugins", "_flow_framework", "workflow", workflow_id, "_provision" + ), + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def search( + self, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Search for workflows by using a query matching a field. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + return self.transport.perform_request( + "POST", + "/_plugins/_flow_framework/workflow/_search", + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def search_state( + self, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Search for workflows by using a query matching a field. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if body in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'body'.") + + return self.transport.perform_request( + "POST", + "/_plugins/_flow_framework/workflow/state/_search", + params=params, + headers=headers, + body=body, + ) + + @query_params( + "error_trace", + "filter_path", + "human", + "pretty", + "provision", + "reprovision", + "source", + "update_fields", + "use_case", + "validation", + ) + def update( + self, + workflow_id: Any, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Update a workflow. You can only update a complete workflow if it has not yet + been provisioned. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg use_case: To use a workflow template, specify it in the + use_case query parameter when creating a workflow. + """ + if workflow_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'workflow_id'." + ) + + return self.transport.perform_request( + "PUT", + _make_path("_plugins", "_flow_framework", "workflow", workflow_id), + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/plugins/knn.py b/opensearchpy/plugins/knn.py index 9e2f61e2..04b9e519 100644 --- a/opensearchpy/plugins/knn.py +++ b/opensearchpy/plugins/knn.py @@ -36,8 +36,10 @@ def delete_model( :arg model_id: The id of the model. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ def get_model( :arg model_id: The id of the model. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -179,12 +183,13 @@ def search_models( :arg error_trace: Whether to include the stack trace of returned errors. :arg expand_wildcards: Whether to expand wildcard expression to - concrete indices that are open, closed or both. Valid choices are all, - closed, hidden, none, open. + concrete indices that are open, closed or both. :arg explain: Specify whether to return detailed information about score computation as part of a hit. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: Starting offset. Default is 0. :arg human: Whether to return human readable values for statistics. @@ -281,8 +286,10 @@ def stats( or empty string to retrieve all stats. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -316,8 +323,10 @@ def train_model( :arg model_id: The id of the model. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg preference: Preferred node to execute training. @@ -353,8 +362,10 @@ def warmup( string to perform the operation on all indices. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/plugins/ml.py b/opensearchpy/plugins/ml.py index 1183bf5e..403eb3b0 100644 --- a/opensearchpy/plugins/ml.py +++ b/opensearchpy/plugins/ml.py @@ -35,8 +35,10 @@ def delete_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -67,8 +69,10 @@ def delete_model_group( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -101,8 +105,10 @@ def get_model_group( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -135,8 +141,10 @@ def get_task( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -167,8 +175,10 @@ def register_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -197,8 +207,10 @@ def register_model_group( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -227,8 +239,10 @@ def search_models( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -257,8 +271,10 @@ def deploy_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -289,8 +305,10 @@ def undeploy_model( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -307,3 +325,171 @@ def undeploy_model( params=params, headers=headers, ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def create_connector( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Creates a standalone connector. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return self.transport.perform_request( + "POST", + "/_plugins/_ml/connectors/_create", + params=params, + headers=headers, + body=body, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def delete_agent( + self, + agent_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Delete an agent. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if agent_id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'agent_id'.") + + return self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_ml", "agents", agent_id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def delete_connector( + self, + connector_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deletes a standalone connector. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if connector_id in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'connector_id'." + ) + + return self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_ml", "connectors", connector_id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def delete_task( + self, + task_id: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deletes a task. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if task_id in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'task_id'.") + + return self.transport.perform_request( + "DELETE", + _make_path("_plugins", "_ml", "tasks", task_id), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def register_agents( + self, + body: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Register an agent. + + + :arg error_trace: Whether to include the stack trace of returned + errors. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. + :arg pretty: Whether to pretty format the returned JSON + response. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + return self.transport.perform_request( + "POST", + "/_plugins/_ml/agents/_register", + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/plugins/notifications.py b/opensearchpy/plugins/notifications.py index 97f95974..9f1e3680 100644 --- a/opensearchpy/plugins/notifications.py +++ b/opensearchpy/plugins/notifications.py @@ -35,8 +35,10 @@ def create_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ def delete_config( :arg config_id: The ID of the channel configuration to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -111,8 +115,10 @@ def delete_configs( delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -137,8 +143,10 @@ def get_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -159,6 +167,8 @@ def get_config( @query_params( "chime.url", "chime.url.keyword", + "config_id", + "config_id_list", "config_type", "created_time_ms", "description", @@ -211,13 +221,17 @@ def get_configs( Get multiple channel configurations with filtering. + :arg config_id: Notification configuration ID. + :arg config_id_list: Notification configuration IDs. :arg config_type: Type of notification configuration. Valid choices are chime, email, email_group, microsoft_teams, ses_account, slack, smtp_account, sns, webhook. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -245,8 +259,10 @@ def list_features( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -271,8 +287,10 @@ def send_test( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -304,8 +322,10 @@ def update_config( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -337,8 +357,10 @@ def list_channels( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/plugins/observability.py b/opensearchpy/plugins/observability.py index 1bf02b4a..eaa2867e 100644 --- a/opensearchpy/plugins/observability.py +++ b/opensearchpy/plugins/observability.py @@ -35,8 +35,10 @@ def create_object( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -66,8 +68,10 @@ def delete_object( :arg object_id: The ID of the Observability Object. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -105,8 +109,10 @@ def delete_objects( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg objectId: The ID of a single Observability Object to @@ -134,8 +140,10 @@ def get_localstats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -164,8 +172,10 @@ def get_object( :arg object_id: The ID of the Observability Object. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -195,8 +205,10 @@ def list_objects( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -223,8 +235,10 @@ def update_object( :arg object_id: The ID of the Observability Object. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/plugins/ppl.py b/opensearchpy/plugins/ppl.py index a18f1690..d1fa476a 100644 --- a/opensearchpy/plugins/ppl.py +++ b/opensearchpy/plugins/ppl.py @@ -37,8 +37,10 @@ def explain( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -71,8 +73,10 @@ def get_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -104,8 +108,10 @@ def post_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -139,8 +145,10 @@ def query( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for diff --git a/opensearchpy/plugins/query.py b/opensearchpy/plugins/query.py index 7bb3a5b6..f62989db 100644 --- a/opensearchpy/plugins/query.py +++ b/opensearchpy/plugins/query.py @@ -36,8 +36,10 @@ def datasource_delete( :arg datasource_name: The Name of the DataSource to delete. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -71,8 +73,10 @@ def datasource_retrieve( :arg datasource_name: The Name of the DataSource to retrieve. :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -105,8 +109,10 @@ def datasources_create( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -134,8 +140,10 @@ def datasources_list( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -160,8 +168,10 @@ def datasources_update( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/plugins/rollups.py b/opensearchpy/plugins/rollups.py index b33d8a00..099dbbc0 100644 --- a/opensearchpy/plugins/rollups.py +++ b/opensearchpy/plugins/rollups.py @@ -36,8 +36,10 @@ def delete( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ def explain( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -102,8 +106,10 @@ def get( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -144,8 +150,10 @@ def put( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -182,8 +190,10 @@ def start( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -215,8 +225,10 @@ def stop( :arg id: Rollup to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON diff --git a/opensearchpy/plugins/sql.py b/opensearchpy/plugins/sql.py index 67cdd99e..3dea90e0 100644 --- a/opensearchpy/plugins/sql.py +++ b/opensearchpy/plugins/sql.py @@ -37,8 +37,10 @@ def close( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -72,8 +74,10 @@ def explain( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -106,8 +110,10 @@ def get_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -139,8 +145,10 @@ def post_stats( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -174,8 +182,10 @@ def query( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for @@ -207,8 +217,10 @@ def settings( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg format: A short version of the Accept header, e.g. json, yaml. :arg human: Whether to return human readable values for diff --git a/opensearchpy/plugins/transforms.py b/opensearchpy/plugins/transforms.py index 3b619278..20608401 100644 --- a/opensearchpy/plugins/transforms.py +++ b/opensearchpy/plugins/transforms.py @@ -36,8 +36,10 @@ def delete( :arg id: Transform to delete :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -69,8 +71,10 @@ def explain( :arg id: Transform to explain :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -102,8 +106,10 @@ def get( :arg id: Transform to access :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -124,6 +130,7 @@ def get( @query_params("error_trace", "filter_path", "human", "pretty", "source") def preview( self, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -133,8 +140,10 @@ def preview( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -143,7 +152,11 @@ def preview( libraries that do not accept a request body for non-POST requests. """ return self.transport.perform_request( - "GET", "/_plugins/_transform/_preview", params=params, headers=headers + "POST", + "/_plugins/_transform/_preview", + params=params, + headers=headers, + body=body, ) @query_params( @@ -170,8 +183,10 @@ def put( :arg id: Transform to create/update :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg if_primary_term: Only perform the operation if the document @@ -217,8 +232,10 @@ def search( :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg from_: The starting transform to return. Default is `0`. :arg human: Whether to return human readable values for statistics. @@ -255,8 +272,10 @@ def start( :arg id: Transform to start :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON @@ -288,8 +307,10 @@ def stop( :arg id: Transform to stop :arg error_trace: Whether to include the stack trace of returned errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for statistics. :arg pretty: Whether to pretty format the returned JSON