diff --git a/CHANGELOG.md b/CHANGELOG.md index 8f11b945..b19a01d4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,6 +36,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@bf35601](https://github.com/opensearch-project/opensearch-api-specification/commit/bf356019ed3450d97fb4f9f68be4db86d1ed2195) - 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 24b95498..4e11caca 100644 --- a/opensearchpy/_async/client/__init__.py +++ b/opensearchpy/_async/client/__init__.py @@ -46,6 +46,8 @@ from .http import HttpClient from .indices import IndicesClient from .ingest import IngestClient +from .insights import InsightsClient +from .list import ListClient from .nodes import NodesClient from .plugins import PluginsClient from .remote import RemoteClient @@ -55,6 +57,7 @@ from .snapshot import SnapshotClient from .tasks import TasksClient from .utils import SKIP_IN_PATH, _bulk_body, _make_path, query_params +from .wlm import WlmClient logger = logging.getLogger("opensearch") @@ -216,6 +219,9 @@ 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.wlm = WlmClient(self) + self.list = ListClient(self) + self.insights = InsightsClient(self) self.search_pipeline = SearchPipelineClient(self) self.cat = CatClient(self) self.cluster = ClusterClient(self) @@ -269,13 +275,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -297,13 +305,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -346,18 +356,20 @@ async def create( :arg id: Unique identifier for the document. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :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. + response. Default is false. :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 @@ -424,11 +436,13 @@ async def index( :arg body: The document :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has @@ -445,7 +459,7 @@ async def index( 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. + response. Default is false. :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 @@ -520,18 +534,20 @@ async def bulk( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :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. + response. Default is false. :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 @@ -575,17 +591,19 @@ async def clear_scroll( :arg body: Comma-separated list of scroll IDs to clear if none - was specified via the scroll_id parameter + was specified using the `scroll_id` parameter :arg scroll_id: Comma-separated list of scroll IDs to clear. To 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -634,13 +652,13 @@ async def count( :arg body: Query to restrict the results specified with the Query DSL (optional) - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - and indices, omit this parameter or use `*` or `_all`. + and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg analyze_wildcard: If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the `q` query string parameter is specified. Default is false. @@ -654,18 +672,19 @@ async def count( in the query string. This parameter can only be used when the `q` query string parameter is specified. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. + statistics. Default is True. :arg ignore_throttled: If `true`, concrete, expanded or aliased - indices are ignored when frozen. + indexes are ignored when frozen. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as @@ -675,7 +694,7 @@ async def count( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg routing: Custom value used to route operations to a specific shard. @@ -722,17 +741,19 @@ async def delete( :arg index: Name of the target 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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 @@ -812,9 +833,9 @@ async def delete_by_query( Deletes documents matching the provided query. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - or indices, omit this parameter or use `*` or `_all`. + or indexes, omit this parameter or use `*` or `_all`. :arg body: The search definition using the Query DSL :arg _source: True or false to return the _source field or not, or a list of fields to return. @@ -824,8 +845,8 @@ async def delete_by_query( the _source field. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg analyze_wildcard: If `true`, wildcard and prefix queries @@ -838,17 +859,19 @@ async def delete_by_query( :arg df: Field to use as default where no field prefix is given in the query string. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as @@ -858,7 +881,7 @@ async def delete_by_query( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg refresh: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. @@ -890,7 +913,7 @@ async def delete_by_query( caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target - data streams with backing indices across multiple data tiers. + data streams with backing indexes across multiple data tiers. :arg timeout: Period each deletion request waits for active shards. :arg version: If `true`, returns the document version as part of @@ -934,13 +957,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg requests_per_second: The throttle for this request in sub- requests per second. :arg source: The URL-encoded request definition. Useful for @@ -980,17 +1005,19 @@ async def delete_script( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1032,7 +1059,7 @@ async def exists( Returns information about whether a document exists in an index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). :arg id: Identifier of the document. :arg _source: `true` or `false` to return the `_source` field or @@ -1042,15 +1069,17 @@ async def exists( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If `true`, the request is real-time as opposed to near-real-time. :arg refresh: If `true`, OpenSearch refreshes all shards @@ -1104,7 +1133,7 @@ async def exists_source( Returns information about whether a document source exists in an index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). :arg id: Identifier of the document. :arg _source: `true` or `false` to return the `_source` field or @@ -1114,15 +1143,17 @@ async def exists_source( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If true, the request is real-time as opposed to near-real-time. :arg refresh: If `true`, OpenSearch refreshes all shards @@ -1198,17 +1229,19 @@ async def explain( :arg df: Field to use as default where no field prefix is given 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg lenient: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg routing: Custom value used to route operations to a specific shard. @@ -1248,38 +1281,39 @@ async def field_caps( ) -> Any: """ Returns the information about the capabilities of fields among multiple - indices. + indexes. :arg body: An index filter specified with the Query DSL - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all - data streams and indices, omit this parameter or use * or _all. + data streams and indexes, omit this parameter or use * or _all. :arg allow_no_indices: If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 + statistics. Default is True. + :arg ignore_unavailable: If `true`, missing or closed indexes are not included in the response. :arg include_unmapped: If true, unmapped fields are included in the response. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1328,15 +1362,17 @@ async def get( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If `true`, the request is real-time as opposed to near-real-time. :arg refresh: If true, OpenSearch refreshes the affected shards @@ -1386,16 +1422,18 @@ async def get_script( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1442,15 +1480,17 @@ async def get_source( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: Boolean) If true, the request is real-time as opposed to near-real-time. :arg refresh: If true, OpenSearch refreshes the affected shards @@ -1518,15 +1558,17 @@ async def mget( using the `_source_excludes` query parameter. If the `_source` parameter 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If `true`, the request is real-time as opposed to near-real-time. :arg refresh: If `true`, the request refreshes relevant shards @@ -1576,17 +1618,19 @@ async def msearch( :arg body: The request definitions (metadata-search request definition pairs), separated by newlines - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases to search. :arg ccs_minimize_roundtrips: If true, network roundtrips between the coordinating node and remote clusters are 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg max_concurrent_searches: Maximum number of concurrent searches the multi search API can execute. :arg max_concurrent_shard_requests: Maximum number of concurrent @@ -1600,7 +1644,7 @@ async def msearch( on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg rest_total_hits_as_int: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. Default is false. @@ -1649,21 +1693,23 @@ async def msearch_template( :arg body: The request definitions (metadata-search request definition pairs), separated by newlines - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - and indices, omit this parameter or use `*`. + and indexes, omit this parameter or use `*`. :arg ccs_minimize_roundtrips: If `true`, network round-trips are 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg max_concurrent_searches: Maximum number of concurrent searches the API can run. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg rest_total_hits_as_int: If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object. Default is false. @@ -1722,7 +1768,7 @@ async def mtermvectors( document ids. See documentation. :arg index: Name of the index that contains the documents. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :arg field_statistics: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Default is True. @@ -1730,10 +1776,12 @@ 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. + statistics. Default is True. :arg ids: A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body :arg offsets: If `true`, the response includes term offsets. @@ -1745,7 +1793,7 @@ async def mtermvectors( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If true, the request is real-time as opposed to near-real-time. Default is True. :arg routing: Custom value used to route operations to a @@ -1796,17 +1844,19 @@ async def put_script( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1850,30 +1900,32 @@ async def rank_eval( :arg body: The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (`*`) expressions are - supported. To target all data streams and indices in a cluster, omit + supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: If `true`, missing or closed indexes are not included in the response. :arg pretty: Whether to pretty format the returned JSON - response. - :arg search_type: Search operation type + response. Default is false. + :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. """ @@ -1918,15 +1970,17 @@ async def reindex( :arg body: The search definition using the Query DSL and the 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg max_docs: Maximum number of documents to process. By default, all documents. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg refresh: If `true`, the request refreshes affected shards to make this operation visible to search. :arg requests_per_second: The throttle for this request in sub- @@ -1969,13 +2023,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg requests_per_second: The throttle for this request in sub- requests per second. :arg source: The URL-encoded request definition. Useful for @@ -2007,13 +2063,15 @@ async def render_search_template( :arg id: ID of the search template to render. If no `source` is 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2038,13 +2096,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2080,13 +2140,15 @@ async def scroll( parameter. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg rest_total_hits_as_int: If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. Default is @@ -2171,9 +2233,9 @@ async def search( :arg body: The search definition using the Query DSL - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - and indices, omit this parameter or use `*` or `_all`. + and indexes, omit this parameter or use `*` or `_all`. :arg _source: Indicates which source fields are returned for matching documents. These fields are returned in the `hits._source` property of the search response. Valid values are: `true` to return the @@ -2191,8 +2253,8 @@ async def search( is `false`, this parameter is ignored. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg allow_partial_search_results: If true, returns partial @@ -2224,24 +2286,25 @@ async def search( :arg docvalue_fields: A comma-separated list of fields to return as the docvalue representation for each hit. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 `search_after` parameter. Default is 0. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_throttled: If `true`, concrete, expanded or aliased - indices will be ignored when frozen. + indexes will be ignored when frozen. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg include_named_queries_score: Indicates whether @@ -2287,7 +2350,7 @@ async def search( `` to the same shards in the same order. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax using query parameter search. Query parameter searches do not support the full OpenSearch Query DSL but are handy for testing. @@ -2343,7 +2406,7 @@ async def search( caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target - data streams with backing indices across multiple data tiers. If set to + data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. :arg timeout: Specifies the period of time to wait for a response from each shard. If no response is received before the timeout @@ -2391,29 +2454,31 @@ async def search_shards( headers: Any = None, ) -> Any: """ - Returns information about the indices and shards that a search request would be + Returns information about the indexes and shards that a search request would be executed against. - :arg index: Returns the indices and shards that a search request + :arg index: Returns the indexes and shards that a search request would be executed against. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg local: If `true`, the request retrieves information from @@ -2421,7 +2486,7 @@ async def search_shards( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg routing: Custom value used to route operations to a specific shard. :arg source: The URL-encoded request definition. Useful for @@ -2463,18 +2528,18 @@ async def search_template( :arg body: The search definition template and its params - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg ccs_minimize_roundtrips: If `true`, network round-trips are minimized for cross-cluster search requests. Default is True. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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- @@ -2482,18 +2547,20 @@ 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. + statistics. Default is True. :arg ignore_throttled: If `true`, specified concrete, expanded, - or aliased indices are not included in the response when throttled. + or aliased indexes are not included in the response when throttled. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg profile: If `true`, the query execution is profiled. :arg rest_total_hits_as_int: If true, hits.total are rendered as an integer in the response. Default is false. @@ -2555,7 +2622,7 @@ async def termvectors( termvectors for. See documentation. :arg id: Unique identifier of the document. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :arg field_statistics: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Default is True. @@ -2563,10 +2630,12 @@ 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. + statistics. Default is True. :arg offsets: If `true`, the response includes term offsets. Default is True. :arg payloads: If `true`, the response includes term payloads. @@ -2576,7 +2645,7 @@ async def termvectors( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If true, the request is real-time as opposed to near-real-time. Default is True. :arg routing: Custom value used to route operations to a @@ -2641,18 +2710,20 @@ async def update( :arg _source_includes: Specify the source fields you want 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg lang: The script language. Default is painless. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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 @@ -2738,9 +2809,9 @@ async def update_by_query( for example to pick up a mapping change. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - or indices, omit this parameter or use `*` or `_all`. + or indexes, omit this parameter or use `*` or `_all`. :arg body: The search definition using the Query DSL :arg _source: True or false to return the _source field or not, or a list of fields to return. @@ -2750,8 +2821,8 @@ async def update_by_query( the _source field. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg analyze_wildcard: If `true`, wildcard and prefix queries @@ -2764,17 +2835,19 @@ async def update_by_query( :arg df: Field to use as default where no field prefix is given in the query string. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as @@ -2789,7 +2862,7 @@ async def update_by_query( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg refresh: If `true`, OpenSearch refreshes affected shards to make the operation visible to search. @@ -2820,7 +2893,7 @@ async def update_by_query( caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target - data streams with backing indices across multiple data tiers. + data streams with backing indexes across multiple data tiers. :arg timeout: Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. :arg version: If `true`, returns the document version as part of @@ -2863,13 +2936,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg requests_per_second: The throttle for this request in sub- requests per second. :arg source: The URL-encoded request definition. Useful for @@ -2896,13 +2971,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2921,13 +2998,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2957,24 +3036,25 @@ async def create_pit( Creates point in time context. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. :arg allow_partial_pit_creation: Allow if point in time can be created with partial failures. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. + statistics. Default is True. :arg keep_alive: Specify the keep alive for point in time. :arg preference: Specify the node or shard the operation should be performed on. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg routing: Comma-separated list of specific routing values. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. @@ -3000,13 +3080,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -3027,13 +3109,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -3056,16 +3140,108 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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", "/_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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :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. Default is false. + :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..11169f47 100644 --- a/opensearchpy/_async/client/cat.py +++ b/opensearchpy/_async/client/cat.py @@ -61,30 +61,31 @@ async def aliases( headers: Any = None, ) -> Any: """ - Shows information about currently configured aliases to indices including - filter and routing infos. + Shows information about currently configured aliases to indexes including + filter and routing info. :arg name: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -120,17 +121,19 @@ async def all_pit_segments( :arg bytes: The unit in which to display byte values. Valid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -175,22 +178,24 @@ async def allocation( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -231,22 +236,24 @@ async def cluster_manager( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -277,24 +284,26 @@ async def count( ) -> Any: """ Provides quick access to the document count of the entire cluster, or - individual indices. + individual indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -334,17 +343,19 @@ async def fielddata( :arg bytes: The unit used to display byte values. Valid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -382,17 +393,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -418,13 +431,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -460,32 +475,34 @@ async def indices( headers: Any = None, ) -> Any: """ - Returns information about indices: number of primaries and replicas, document + Returns information about indexes: number of primaries and replicas, document counts, disk size, ... - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. - :arg health: The health status used to limit returned indices. - By default, the response includes indices of any health status. Valid + :arg health: The health status used to limit returned indexes. + By default, the response includes indexes of any health status. Valid choices are green, red, yellow. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_unloaded_segments: If true, the response includes information from segments that are not loaded into memory. Default is false. @@ -495,7 +512,7 @@ async def indices( use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg pri: If true, the response only includes information from primary shards. Default is false. :arg s: Comma-separated list of column names or column aliases @@ -537,22 +554,24 @@ async def master( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -595,22 +614,24 @@ async def nodeattrs( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -653,9 +674,11 @@ async def nodes( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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`, @@ -663,7 +686,7 @@ async def nodes( :arg h: Comma-separated list of column names to display. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local (Deprecated: This parameter does not cause this API to act locally.): Return local information, do not retrieve the state from cluster-manager node. Default is false. @@ -671,7 +694,7 @@ async def nodes( use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -712,22 +735,24 @@ async def pending_tasks( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -766,17 +791,19 @@ async def pit_segments( :arg bytes: The unit in which to display byte values. Valid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -814,22 +841,24 @@ async def plugins( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -875,17 +904,19 @@ async def recovery( :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -925,22 +956,24 @@ async def repositories( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -989,9 +1022,9 @@ async def segment_replication( names to limit the returned information. :arg active_only: If `true`, the response only includes ongoing segment replication events. Default is false. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg bytes: The unit in which to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg completed_only: If `true`, the response only includes @@ -999,24 +1032,25 @@ async def segment_replication( :arg detailed: If `true`, the response includes detailed information about segment replications. Default is false. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_throttled: Whether specified concrete, expanded or - aliased indices should be ignored when throttled. - :arg ignore_unavailable: Whether specified concrete indices + aliased indexes should be ignored when throttled. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg shards: Comma-separated list of shards to display. @@ -1059,28 +1093,30 @@ async def segments( Provides low-level information about the segments in the shards of an index. - :arg index: A comma-separated list of data streams, indices, and + :arg index: A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1118,30 +1154,32 @@ async def shards( Provides a detailed view of shard allocation on nodes. - :arg index: A comma-separated list of data streams, indices, and + :arg index: A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1186,22 +1224,24 @@ async def thread_pool( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg size: The multiplier in which to display values. @@ -1249,22 +1289,24 @@ async def snapshots( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_unavailable: If `true`, the response does not include information from unavailable snapshots. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1312,15 +1354,17 @@ async def tasks( :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg nodes: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all @@ -1328,7 +1372,7 @@ async def tasks( :arg parent_task_id: The parent task identifier, which is used to limit the response. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1371,22 +1415,24 @@ async def templates( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for diff --git a/opensearchpy/_async/client/cluster.py b/opensearchpy/_async/client/cluster.py index 655025c4..1e307cff 100644 --- a/opensearchpy/_async/client/cluster.py +++ b/opensearchpy/_async/client/cluster.py @@ -70,24 +70,25 @@ async def health( Returns basic information about the health of the cluster. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are - supported. To target all data streams and indices in a cluster, omit + supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. :arg awareness_attribute: The awareness attribute for which the health is required. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg level: Can be one of cluster, indexes or shards. Controls the details level of the health information returned. Valid choices are awareness_attributes, cluster, indices, shards. :arg local: If true, the request retrieves information from the @@ -98,7 +99,7 @@ async def health( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -158,11 +159,13 @@ async def pending_tasks( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. Default is false. @@ -171,7 +174,7 @@ async def pending_tasks( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -209,24 +212,25 @@ async def state( :arg metric: Limit the information returned to the specified metrics :arg index: A comma-separated list of index names; use `_all` or - empty string to perform the operation on all indices - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified) + empty string to perform the operation on all indexes + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified) :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 - statistics. - :arg ignore_unavailable: Whether specified concrete indices + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed) :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. @@ -234,7 +238,7 @@ async def state( use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg wait_for_metadata_version: Wait for the metadata version to @@ -263,6 +267,8 @@ async def state( ) async def stats( self, + metric: Any = None, + index_metric: Any = None, node_id: Any = None, params: Any = None, headers: Any = None, @@ -271,18 +277,25 @@ async def stats( Returns high-level overview of cluster statistics. + :arg metric: Limit the information returned to the specified + metrics + :arg index_metric: Limit the information returned for indexes + metric to the specific index metrics. It can be used only if indexes (or + all) metric is specified. :arg node_id: Comma-separated list of node filters used to limit 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for each node to respond. If a node @@ -332,13 +345,15 @@ async def reroute( :arg dry_run: If true, then the request simulates the operation only and returns the resulting state. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout @@ -346,7 +361,7 @@ async def reroute( :arg metric: Limits the information returned to the specified metrics. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg retry_failed: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. :arg source: The URL-encoded request definition. Useful for @@ -383,13 +398,15 @@ async def get_settings( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg include_defaults: If `true`, returns default cluster settings from the local node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -397,7 +414,7 @@ async def get_settings( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -434,18 +451,20 @@ async def put_settings( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -468,13 +487,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -504,17 +525,19 @@ async def allocation_explain( :arg body: The index, shard, and primary flag to explain. Empty 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_disk_info: If true, returns information about disk usage and shard sizes. Default is false. :arg include_yes_decisions: If true, returns YES decisions in explanation. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -551,17 +574,19 @@ async def delete_component_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -603,11 +628,13 @@ async def get_component_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. Default is false. @@ -616,7 +643,7 @@ async def get_component_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -653,7 +680,7 @@ async def put_component_template( includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics- mapping`; `synthetics-settings`. OpenSearch Agent uses these templates - to configure backing indices for its data streams. If you use OpenSearch + to configure backing indexes for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component @@ -665,17 +692,19 @@ async def put_component_template( :arg create: If `true`, this request cannot replace or update 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. @@ -717,11 +746,13 @@ async def exists_component_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. Default is false. @@ -730,7 +761,7 @@ async def exists_component_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -757,13 +788,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg wait_for_removal: Specifies whether to wait for all @@ -801,11 +834,13 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg node_ids: A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names. @@ -813,7 +848,7 @@ async def post_voting_config_exclusions( nodes to exclude from the voting configuration. If specified, you may not also specify node_ids. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: When adding a voting configuration exclusion, the @@ -837,13 +872,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -854,6 +891,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: @@ -862,13 +900,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -877,6 +917,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") @@ -892,13 +933,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -933,13 +976,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -968,13 +1013,15 @@ async def put_decommission_awareness( :arg awareness_attribute_name: Awareness attribute name. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -999,6 +1046,7 @@ async def put_decommission_awareness( async def put_weighted_routing( self, attribute: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -1008,13 +1056,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1026,4 +1076,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..0a7e5966 100644 --- a/opensearchpy/_async/client/dangling_indices.py +++ b/opensearchpy/_async/client/dangling_indices.py @@ -67,16 +67,18 @@ async def delete_dangling_index( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -118,16 +120,18 @@ async def import_dangling_index( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -146,17 +150,19 @@ async def list_dangling_indices( headers: Any = None, ) -> Any: """ - Returns all dangling indices. + Returns all dangling indexes. :arg error_trace: Whether to include the stack trace of returned - errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/client/indices.py b/opensearchpy/_async/client/indices.py index 2c692fe8..099b26d3 100644 --- a/opensearchpy/_async/client/indices.py +++ b/opensearchpy/_async/client/indices.py @@ -57,13 +57,15 @@ async def analyze( which the analysis should be performed :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -92,31 +94,33 @@ async def refresh( headers: Any = None, ) -> Any: """ - Performs the refresh operation in one or more indices. + Performs the refresh operation in one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -143,33 +147,35 @@ async def flush( headers: Any = None, ) -> Any: """ - Performs the flush operation on one or more indices. + Performs the flush operation on one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (`*`). To flush all data streams - and indices, omit this parameter or use `*` or `_all`. + and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg wait_if_ongoing: If `true`, the flush operation blocks @@ -209,17 +215,19 @@ async def create( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -269,17 +277,19 @@ async def clone( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -328,33 +338,34 @@ async def get( headers: Any = None, ) -> Any: """ - Returns information about one or more indices. + Returns information about one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. :arg allow_no_indices: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing - or closed indices. This behavior applies even if the request targets - other open indices. For example, a request targeting foo*,bar* returns + or closed indexes. This behavior applies even if the request targets + other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. Default is false. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If false, requests that target a missing index return an error. Default is false. :arg include_defaults: If true, return all default settings in @@ -367,7 +378,7 @@ async def get( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -404,30 +415,32 @@ async def open( Opens an index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). By default, - you must explicitly name the indices you using to limit the request. To + you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg master_timeout (Deprecated: To promote inclusive language, @@ -435,7 +448,7 @@ async def open( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -485,21 +498,23 @@ async def close( names used to limit the request. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg master_timeout (Deprecated: To promote inclusive language, @@ -507,7 +522,7 @@ async def close( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -548,27 +563,29 @@ async def delete( Deletes an index. - :arg index: Comma-separated list of indices to delete. You + :arg index: Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. Default is false. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. Default is false. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -576,7 +593,7 @@ async def delete( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -614,27 +631,29 @@ async def exists( Returns information about whether a particular index exists. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. Default is false. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. Default is false. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. Default is false. :arg include_defaults: If `true`, return all default settings in @@ -642,7 +661,7 @@ async def exists( :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -683,21 +702,23 @@ async def put_mapping( string to perform the operation on all indices. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg master_timeout (Deprecated: To promote inclusive language, @@ -705,7 +726,7 @@ async def put_mapping( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -748,29 +769,31 @@ async def get_mapping( headers: Any = None, ) -> Any: """ - Returns mappings for one or more indices. + Returns mappings for one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg local: If `true`, the request retrieves information from @@ -780,7 +803,7 @@ async def get_mapping( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -813,24 +836,26 @@ async def get_field_mapping( :arg fields: Comma-separated list or wildcard expression of fields used to limit returned information. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg include_defaults: If `true`, return all default settings in @@ -838,7 +863,7 @@ async def get_field_mapping( :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -876,31 +901,33 @@ async def exists_alias( :arg name: Comma-separated list of aliases to check. Supports wildcards (`*`). - :arg index: Comma-separated list of data streams or indices used + :arg index: Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data - streams and indices, omit this parameter or use `*` or `_all`. + streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, requests that include a - missing data stream or index in the target indices or data streams + missing data stream or index in the target indexes or data streams return an error. :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -933,33 +960,35 @@ async def get_alias( Returns an alias. - :arg index: Comma-separated list of data streams or indices used + :arg index: Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data - streams and indices, omit this parameter or use `*` or `_all`. + streams and indexes, omit this parameter or use `*` or `_all`. :arg name: Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -991,17 +1020,19 @@ async def update_aliases( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1036,24 +1067,26 @@ async def delete_alias( Deletes an alias. - :arg index: Comma-separated list of data streams or indices used + :arg index: Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). :arg name: Comma-separated list of aliases to remove. Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1097,11 +1130,13 @@ async def put_template( :arg create: If true, this request cannot replace or update 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout @@ -1111,7 +1146,7 @@ async def put_template( are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1152,20 +1187,22 @@ async def exists_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1204,13 +1241,15 @@ async def get_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1218,7 +1257,7 @@ async def get_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1251,17 +1290,19 @@ async def delete_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1298,35 +1339,36 @@ async def get_settings( headers: Any = None, ) -> Any: """ - Returns settings for one or more indices. + Returns settings for one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg name: Comma-separated list or wildcard expression of settings to retrieve. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg include_defaults: If `true`, return all default settings in @@ -1339,7 +1381,7 @@ async def get_settings( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1373,31 +1415,32 @@ async def put_settings( Updates the index settings. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 - statistics. - :arg ignore_unavailable: Whether specified concrete indices + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection @@ -1406,7 +1449,7 @@ async def put_settings( :arg preserve_existing: If `true`, existing index settings remain unchanged. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1452,30 +1495,31 @@ async def stats( :arg index: A comma-separated list of index names; use `_all` or - empty string to perform the operation on all indices + empty string to perform the operation on all indexes :arg metric: Limit the information returned the specific metrics. :arg completion_fields: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. + collected from closed indexes. Default is True. :arg groups: Comma-separated list of search groups to include in the search statistics. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_segment_file_sizes: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Default is false. @@ -1486,7 +1530,7 @@ async def stats( cluster, index, or shard level. Valid choices are cluster, indices, shards. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1515,28 +1559,30 @@ async def segments( Provides low-level information about segments in a Lucene index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: If `true`, the request returns a verbose response. @@ -1577,15 +1623,15 @@ async def validate_query( :arg body: The query definition specified with the Query DSL - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - or indices, omit this parameter or use `*` or `_all`. + or indexes, omit this parameter or use `*` or `_all`. :arg all_shards: If `true`, the validation is executed on all shards instead of one random shard per index. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg analyze_wildcard: If `true`, wildcard and prefix queries are analyzed. Default is false. :arg analyzer: Analyzer to use for the query string. This @@ -1597,7 +1643,7 @@ async def validate_query( in the query string. This parameter can only be used when the `q` query string parameter is specified. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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- @@ -1605,16 +1651,18 @@ 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg rewrite: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. @@ -1651,17 +1699,17 @@ async def clear_cache( headers: Any = None, ) -> Any: """ - Clears all or specific caches for one or more indices. + Clears all or specific caches for one or more indexes. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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- @@ -1673,14 +1721,16 @@ 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg query: If `true`, clears the query cache. :arg request: If `true`, clears the request cache. :arg source: The URL-encoded request definition. Useful for @@ -1709,21 +1759,23 @@ async def recovery( Returns information about ongoing index shard recoveries. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg active_only: If `true`, the response only includes ongoing shard recoveries. Default is false. :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1753,26 +1805,27 @@ async def upgrade( The _upgrade API is no longer useful and will be removed. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg only_ancient_segments: If true, only ancient (an older Lucene major release) segments will be upgraded. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should this request wait until the @@ -1802,24 +1855,25 @@ async def get_upgrade( The _upgrade API is no longer useful and will be removed. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1845,29 +1899,30 @@ async def shard_stores( headers: Any = None, ) -> Any: """ - Provides store information for shard copies of indices. + Provides store information for shard copies of indexes. - :arg index: List of data streams, indices, and aliases used to + :arg index: List of data streams, indexes, and aliases used to limit the request. :arg allow_no_indices: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing - or closed indices. This behavior applies even if the request targets - other open indices. + or closed indexes. This behavior applies even if the request targets + other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 + statistics. Default is True. + :arg ignore_unavailable: If true, missing or closed indexes are not included in the response. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg status: List of shard health statuses used to limit the @@ -1899,26 +1954,27 @@ async def forcemerge( headers: Any = None, ) -> Any: """ - Performs the force merge operation on one or more indices. + Performs the force merge operation on one or more indexes. :arg index: A comma-separated list of index names; use `_all` or - empty string to perform the operation on all indices - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified) + empty string to perform the operation on all indexes + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified) :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 - statistics. - :arg ignore_unavailable: Whether specified concrete indices + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed) :arg max_num_segments: The number of larger segments into which smaller segments are merged. Set this parameter to 1 to merge all @@ -1927,7 +1983,7 @@ async def forcemerge( :arg only_expunge_deletes: Specify whether the operation should only expunge deleted documents :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg primary_only: Specify whether the operation should only perform on primary shards. Defaults to false. Default is false. :arg source: The URL-encoded request definition. Useful for @@ -1974,17 +2030,19 @@ async def shrink( :arg copy_settings: whether or not to copy settings from the 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -2047,17 +2105,19 @@ async def split( :arg copy_settings: whether or not to copy settings from the 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -2120,17 +2180,19 @@ async def rollover( satisfies the specified conditions but does not perform a 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -2172,13 +2234,15 @@ async def create_data_stream( faster. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2207,13 +2271,15 @@ async def delete_data_stream( :arg name: Comma-separated list of data streams to delete. 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2249,17 +2315,19 @@ async def delete_index_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -2302,13 +2370,15 @@ async def exists_index_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2316,7 +2386,7 @@ async def exists_index_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2353,13 +2423,15 @@ async def get_index_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. Default is false. @@ -2368,7 +2440,7 @@ async def get_index_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2407,16 +2479,18 @@ async def put_index_template( :arg create: If `true`, this request cannot replace or update 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2468,17 +2542,19 @@ async def simulate_index_template( the template is not permanently added or updated in either case; it is 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2508,13 +2584,15 @@ async def get_data_stream( limit the request. Wildcard (`*`) expressions are supported. If omitted, 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2557,17 +2635,19 @@ async def simulate_template( the template is not permanently added or updated in either case; it is 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2589,25 +2669,27 @@ async def resolve_index( headers: Any = None, ) -> Any: """ - Returns information about any matching indices, aliases, and data streams. + Returns information about any matching indexes, aliases, and data streams. :arg name: Comma-separated name(s) or index pattern(s) of the - indices, aliases, and data streams to resolve. Resources on remote + indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2642,30 +2724,31 @@ async def add_block( Adds a block to an index. - :arg index: A comma separated list of indices to add a block to + :arg index: A comma separated list of indexes to add a block to :arg block: The block to add (one of read, write, read_only or metadata) - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified) + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified) :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed) :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -2693,13 +2776,15 @@ async def data_streams_stats( the request. Wildcard expressions (`*`) are supported. To target all 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2734,25 +2819,27 @@ async def put_alias( :arg body: The settings for the alias, such as `routing` or `filter` - :arg index: Comma-separated list of data streams or indices to + :arg index: Comma-separated list of data streams or indexes to add. Supports wildcards (`*`). Wildcard patterns that match both data - streams and indices return an error. + streams and indexes return an error. :arg name: Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is diff --git a/opensearchpy/_async/client/ingest.py b/opensearchpy/_async/client/ingest.py index db9e0bbc..c07b08ee 100644 --- a/opensearchpy/_async/client/ingest.py +++ b/opensearchpy/_async/client/ingest.py @@ -65,17 +65,19 @@ async def get_pipeline( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -109,17 +111,19 @@ async def put_pipeline( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -164,17 +168,19 @@ async def delete_pipeline( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -207,13 +213,15 @@ async def simulate( :arg id: Pipeline to test. If you don't specify a `pipeline` in 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: If `true`, the response includes output data for @@ -241,13 +249,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/client/insights.py b/opensearchpy/_async/client/insights.py new file mode 100644 index 00000000..3e09c518 --- /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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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/list.py b/opensearchpy/_async/client/list.py new file mode 100644 index 00000000..a2321516 --- /dev/null +++ b/opensearchpy/_async/client/list.py @@ -0,0 +1,211 @@ +# 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, _make_path, query_params + + +class ListClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def help( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Returns help for the List APIs. + + + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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", "/_list", params=params, headers=headers + ) + + @query_params( + "bytes", + "cluster_manager_timeout", + "error_trace", + "expand_wildcards", + "filter_path", + "format", + "h", + "health", + "help", + "human", + "include_unloaded_segments", + "local", + "master_timeout", + "next_token", + "pretty", + "pri", + "s", + "size", + "sort", + "source", + "time", + "v", + ) + async def indices( + self, + index: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Returns paginated information about indexes including number of primaries and + replicas, document counts, disk size. + + + :arg index: Comma-separated list of data streams, indexes, and + aliases used to limit the request. Supports wildcards (`*`). To target + all data streams and indexes, omit this parameter or use `*` or `_all`. + :arg bytes: The unit used to display byte values. Valid choices + are b, g, gb, k, kb, m, mb, p, pb, t, tb. + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg expand_wildcards: The type of index that wildcard patterns + 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, such as + `JSON`, `YAML`. + :arg h: Comma-separated list of column names to display. + :arg health: The health status used to limit returned indexes. + By default, the response includes indexes of any health status. Valid + choices are green, red, yellow. + :arg help: Return help information. Default is false. + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg include_unloaded_segments: If true, the response includes + information from segments that are not loaded into memory. Default is + false. + :arg local: Return local information, do not retrieve the state + from cluster-manager node. Default is false. + :arg master_timeout (Deprecated: To promote inclusive language, + use `cluster_manager_timeout` instead.): Operation timeout for + connection to cluster manager node. + :arg next_token: Token to retrieve next page of indexes. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg pri: If true, the response only includes information from + primary shards. Default is false. + :arg s: Comma-separated list of column names or column aliases + to sort by. + :arg size: Maximum number of indexes to be displayed in a page. + :arg sort: Defines order in which indexes will be displayed. + Accepted values are `asc` and `desc`. If `desc`, most recently created + indexes would be displayed first. Valid choices are asc, desc. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg time: The unit used to display time values. Valid choices + are d, h, m, micros, ms, nanos, s. + :arg v: Verbose mode. Display column headers. Default is false. + """ + return await self.transport.perform_request( + "GET", _make_path("_list", "indices", index), params=params, headers=headers + ) + + @query_params( + "bytes", + "cluster_manager_timeout", + "error_trace", + "filter_path", + "format", + "h", + "help", + "human", + "local", + "master_timeout", + "next_token", + "pretty", + "s", + "size", + "sort", + "source", + "time", + "v", + ) + async def shards( + self, + index: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Returns paginated details of shard allocation on nodes. + + + :arg index: A comma-separated list of data streams, indexes, and + aliases used to limit the request. Supports wildcards (`*`). To target + all data streams and indexes, omit this parameter or use `*` or `_all`. + :arg bytes: The unit used to display byte values. Valid choices + are b, g, gb, k, kb, m, mb, p, pb, t, tb. + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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, such as + `JSON`, `YAML`. + :arg h: Comma-separated list of column names to display. + :arg help: Return help information. Default is false. + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg local: Return local information, do not retrieve the state + from cluster-manager node. Default is false. + :arg master_timeout (Deprecated: To promote inclusive language, + use 'cluster_manager_timeout' instead.): Operation timeout for + connection to cluster manager node. + :arg next_token: Token to retrieve next page of shards. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg s: Comma-separated list of column names or column aliases + to sort by. + :arg size: Maximum number of shards to be displayed in a page. + :arg sort: Defines order in which shards will be displayed. + Accepted values are `asc` and `desc`. If `desc`, most recently created + shards would be displayed first. Valid choices are asc, desc. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg time: The unit in which to display time values. Valid + choices are d, h, m, micros, ms, nanos, s. + :arg v: Verbose mode. Display column headers. Default is false. + """ + return await self.transport.perform_request( + "GET", _make_path("_list", "shards", index), params=params, headers=headers + ) diff --git a/opensearchpy/_async/client/nodes.py b/opensearchpy/_async/client/nodes.py index cd1dd7c6..5d5091f2 100644 --- a/opensearchpy/_async/client/nodes.py +++ b/opensearchpy/_async/client/nodes.py @@ -57,13 +57,15 @@ async def reload_secure_settings( :arg node_id: The names of particular nodes in the cluster to 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -91,6 +93,7 @@ async def info( self, node_id: Any = None, metric: Any = None, + node_id_or_metric: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -102,16 +105,21 @@ async def info( limit returned information. :arg metric: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + :arg node_id_or_metric: Limits the information returned to a + list of node IDs or specific metrics. Supports a comma-separated list, + such as node1,node2 or 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -153,23 +161,25 @@ async def stats( limit returned information. :arg metric: Limit the information returned to the specified metrics - :arg index_metric: Limit the information returned for indices - metric to the specific index metrics. It can be used only if indices (or + :arg index_metric: Limit the information returned for indexes + metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. :arg completion_fields: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 groups: Comma-separated list of search groups to include in the search statistics. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_segment_file_sizes: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Default is false. @@ -177,7 +187,7 @@ async def stats( cluster, index, or shard level. Valid choices are cluster, indices, shards. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -223,17 +233,19 @@ async def hot_threads( :arg doc_type: The type to sample. Valid choices are block, cpu, 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_idle_threads: Don't show threads that are in known- idle places, such as waiting on a socket select or pulling from an empty task queue. Default is True. :arg interval: The interval for the second sampling of threads. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg snapshots: Number of samples of thread stacktrace. Default is 10. :arg source: The URL-encoded request definition. Useful for @@ -273,13 +285,15 @@ async def usage( metrics. A comma-separated list of the following options: `_all`, `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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is 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..8187a8b6 100644 --- a/opensearchpy/_async/client/remote_store.py +++ b/opensearchpy/_async/client/remote_store.py @@ -45,13 +45,15 @@ async def restore( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should this request wait until the diff --git a/opensearchpy/_async/client/search_pipeline.py b/opensearchpy/_async/client/search_pipeline.py index 9225085f..a22d8dd2 100644 --- a/opensearchpy/_async/client/search_pipeline.py +++ b/opensearchpy/_async/client/search_pipeline.py @@ -45,13 +45,15 @@ async def get( :arg cluster_manager_timeout: operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -82,13 +84,15 @@ async def delete( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. @@ -127,13 +131,15 @@ async def put( :arg cluster_manager_timeout: operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. diff --git a/opensearchpy/_async/client/security.py b/opensearchpy/_async/client/security.py index 5d3f8171..c1fb0f4c 100644 --- a/opensearchpy/_async/client/security.py +++ b/opensearchpy/_async/client/security.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -61,13 +63,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -95,13 +99,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -128,13 +134,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -158,13 +166,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -195,13 +205,15 @@ async def create_action_group( :arg action_group: The name of the action group to create or 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -231,13 +243,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -265,13 +279,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -299,13 +315,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -330,13 +348,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -360,13 +380,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -394,13 +416,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -430,13 +454,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -464,13 +490,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -497,13 +525,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -528,13 +558,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -555,13 +587,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -589,13 +623,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -625,13 +661,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -659,13 +697,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -692,13 +732,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -723,13 +765,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -753,13 +797,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -787,13 +833,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -823,13 +871,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -857,13 +907,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -891,13 +943,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -922,13 +976,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -949,13 +1005,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -983,13 +1041,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1019,13 +1079,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1053,13 +1115,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1085,13 +1149,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1115,13 +1181,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1150,13 +1218,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1183,13 +1253,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg show_all: A boolean flag to include/exclude static nodes DN from final result. :arg source: The URL-encoded request definition. Useful for @@ -1210,13 +1282,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1235,13 +1309,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1263,13 +1339,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1291,13 +1369,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1316,16 +1396,18 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg mode: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1344,13 +1426,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1370,13 +1454,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1403,13 +1489,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1437,13 +1525,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1478,13 +1568,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: Indicates whether a verbose response should be @@ -1505,13 +1597,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1530,13 +1624,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1556,13 +1652,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1585,13 +1683,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1611,18 +1711,20 @@ async def create_allowlist( headers: Any = None, ) -> Any: """ - Creates or replaces the allowlisted APIs. Accessible via Super Admin + Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. :arg error_trace: Whether to include the stack trace of returned - errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1650,13 +1752,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1685,13 +1789,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1722,13 +1828,15 @@ async def delete_distinguished_name( :arg cluster_name: The cluster-name to delete from list of 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1757,13 +1865,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1789,13 +1899,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1824,13 +1936,15 @@ async def generate_user_token( :arg username: The name of the user for whom an auth token is to 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1860,13 +1974,15 @@ async def generate_user_token_legacy( :arg username: The name of the user for whom an auth token is to 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1891,13 +2007,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1916,13 +2034,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1945,13 +2065,15 @@ async def get_distinguished_name( :arg cluster_name: The cluster-name to retrieve nodes DN setting 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg show_all: A boolean flag to include/exclude static nodes DN from final result. :arg source: The URL-encoded request definition. Useful for @@ -1980,13 +2102,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2008,13 +2132,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg show_dn: A boolean flag to indicate whether all domain names should be returned. :arg source: The URL-encoded request definition. Useful for @@ -2036,13 +2162,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2066,13 +2194,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2097,13 +2227,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2122,13 +2254,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2148,13 +2282,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2184,13 +2320,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2218,13 +2356,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2244,13 +2384,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2275,13 +2417,15 @@ async def update_distinguished_name( :arg cluster_name: The cluster-name to create/update nodesDn 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2314,13 +2458,15 @@ async def validate( :arg accept_invalid: A boolean flag to indicate whether invalid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2339,13 +2485,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2366,13 +2514,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2401,13 +2551,15 @@ async def get_all_certificates( :arg cert_type: The type of certificates (HTTP, TRANSPORT, ALL) 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: The maximum duration, in seconds, to be spent to @@ -2443,13 +2595,15 @@ async def get_node_certificates( :arg cert_type: The type of certificates (HTTP, TRANSPORT, ALL) 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: The maximum duration, in seconds, to be spent to diff --git a/opensearchpy/_async/client/snapshot.py b/opensearchpy/_async/client/snapshot.py index 5a2da968..4c9c3fd1 100644 --- a/opensearchpy/_async/client/snapshot.py +++ b/opensearchpy/_async/client/snapshot.py @@ -69,17 +69,19 @@ async def create( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: If `true`, the request returns a @@ -123,16 +125,18 @@ async def delete( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -179,11 +183,13 @@ async def get( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_unavailable: If false, the request returns an error for any snapshots that are unavailable. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -191,7 +197,7 @@ async def get( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: If true, returns additional information about each @@ -235,16 +241,18 @@ async def delete_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -283,18 +291,20 @@ async def get_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -329,16 +339,18 @@ async def create_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -384,16 +396,18 @@ async def restore( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should this request wait until the @@ -437,11 +451,13 @@ async def status( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_unavailable: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown Default is false. @@ -449,7 +465,7 @@ async def status( use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -484,16 +500,18 @@ async def verify_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -532,16 +550,18 @@ async def cleanup_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. @@ -575,7 +595,7 @@ async def clone( headers: Any = None, ) -> Any: """ - Clones indices from one snapshot into another snapshot in the same repository. + Clones indexes from one snapshot into another snapshot in the same repository. :arg repository: A repository name @@ -585,16 +605,18 @@ async def clone( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/client/tasks.py b/opensearchpy/_async/client/tasks.py index cbf2b66d..98bede8e 100644 --- a/opensearchpy/_async/client/tasks.py +++ b/opensearchpy/_async/client/tasks.py @@ -69,13 +69,15 @@ async def list( :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg nodes: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all @@ -84,7 +86,7 @@ async def list( information. To return all tasks, omit this parameter or use a value of `-1`. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -122,16 +124,18 @@ async def cancel( :arg actions: Comma-separated list or wildcard expression of 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg nodes: Comma-separated list of node IDs or names used to limit the request. :arg parent_task_id: Parent task ID used to limit the tasks. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should the request block until the @@ -166,13 +170,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is diff --git a/opensearchpy/_async/client/wlm.py b/opensearchpy/_async/client/wlm.py new file mode 100644 index 00000000..2cf77e88 --- /dev/null +++ b/opensearchpy/_async/client/wlm.py @@ -0,0 +1,160 @@ +# 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 SKIP_IN_PATH, NamespacedClient, _make_path, query_params + + +class WlmClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def create_query_group( + self, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Creates a new query group and sets the resource limits for the new query group. + + + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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( + "PUT", "/_wlm/query_group", params=params, headers=headers, body=body + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def delete_query_group( + self, + name: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deletes the specified query group. + + + :arg name: The name of the query group. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if name in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'name'.") + + return await self.transport.perform_request( + "DELETE", + _make_path("_wlm", "query_group", name), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def get_query_group( + self, + name: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Retrieves the specified query group. If no query group is specified, all query + groups in the cluster are retrieved. + + + :arg name: The name of the query group. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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", + _make_path("_wlm", "query_group", name), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + async def update_query_group( + self, + name: Any, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Updates the specified query group. + + + :arg name: The name of the query group. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + for param in (name, body): + if param in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument.") + + return await self.transport.perform_request( + "PUT", + _make_path("_wlm", "query_group", name), + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/_async/plugins/asynchronous_search.py b/opensearchpy/_async/plugins/asynchronous_search.py new file mode 100644 index 00000000..ca4bb1fb --- /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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :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. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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..fd6931a6 --- /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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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..acd3e5a4 100644 --- a/opensearchpy/_async/plugins/knn.py +++ b/opensearchpy/_async/plugins/knn.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -153,9 +157,9 @@ async def search_models( returned _source field. :arg _source_includes: List of fields to extract and return from the _source field. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg allow_partial_search_results: Indicate if an error should be returned if there is a partial search failure or timeout. Default is True. @@ -177,20 +181,21 @@ async def search_models( :arg docvalue_fields: Comma-separated list of fields to return as the docvalue representation of a field for each hit. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. + statistics. Default is True. :arg ignore_throttled: Whether specified concrete, expanded or - aliased indices should be ignored when throttled. - :arg ignore_unavailable: Whether specified concrete indices + aliased indexes should be ignored when throttled. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg lenient: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. @@ -208,7 +213,7 @@ async def search_models( :arg preference: Specify the node or shard the operation should be performed on. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg request_cache: Specify if request cache should be used for this request or not, defaults to index level setting. @@ -280,13 +285,15 @@ async def stats( :arg stat: Comma-separated list of stats to retrieve; use `_all` 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. @@ -315,14 +322,16 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Preferred node to execute training. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -349,16 +358,18 @@ async def warmup( specified indexes. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. :arg error_trace: Whether to include the stack trace of returned - errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/plugins/ml.py b/opensearchpy/_async/plugins/ml.py index b48bf775..d4c10f54 100644 --- a/opensearchpy/_async/plugins/ml.py +++ b/opensearchpy/_async/plugins/ml.py @@ -34,13 +34,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -66,13 +68,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -100,13 +104,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -134,13 +140,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -166,13 +174,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -196,13 +206,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -226,13 +238,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -256,13 +270,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -288,13 +304,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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..3c4c624d 100644 --- a/opensearchpy/_async/plugins/notifications.py +++ b/opensearchpy/_async/plugins/notifications.py @@ -34,13 +34,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -110,13 +114,15 @@ async def delete_configs( :arg config_id_list: A comma-separated list of channel IDs 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -136,13 +142,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -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,17 +221,21 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -244,13 +258,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -270,13 +286,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -303,13 +321,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -336,13 +356,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/plugins/observability.py b/opensearchpy/_async/plugins/observability.py index 97d05b22..1242171d 100644 --- a/opensearchpy/_async/plugins/observability.py +++ b/opensearchpy/_async/plugins/observability.py @@ -34,13 +34,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -65,13 +67,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -104,17 +108,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg objectId: The ID of a single Observability Object to delete. :arg objectIdList: A comma-separated list of Observability Object IDs to delete. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -133,13 +139,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -163,13 +171,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -194,13 +204,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -222,13 +234,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/plugins/ppl.py b/opensearchpy/_async/plugins/ppl.py index 96237282..449a5986 100644 --- a/opensearchpy/_async/plugins/ppl.py +++ b/opensearchpy/_async/plugins/ppl.py @@ -36,15 +36,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for @@ -70,15 +72,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for @@ -103,15 +107,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for @@ -138,15 +144,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for diff --git a/opensearchpy/_async/plugins/query.py b/opensearchpy/_async/plugins/query.py index 7a208031..93f7db1c 100644 --- a/opensearchpy/_async/plugins/query.py +++ b/opensearchpy/_async/plugins/query.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -70,13 +72,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -104,13 +108,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -133,13 +139,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -159,13 +167,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/plugins/rollups.py b/opensearchpy/_async/plugins/rollups.py index 5a4f7091..d50918b8 100644 --- a/opensearchpy/_async/plugins/rollups.py +++ b/opensearchpy/_async/plugins/rollups.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -101,13 +105,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -143,17 +149,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -181,13 +189,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -214,13 +224,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/_async/plugins/sql.py b/opensearchpy/_async/plugins/sql.py index 625508b3..9aa05685 100644 --- a/opensearchpy/_async/plugins/sql.py +++ b/opensearchpy/_async/plugins/sql.py @@ -18,7 +18,7 @@ from typing import Any -from ..client.utils import SKIP_IN_PATH, NamespacedClient, query_params +from ..client.utils import NamespacedClient, query_params class SqlClient(NamespacedClient): @@ -27,7 +27,7 @@ class SqlClient(NamespacedClient): ) async def close( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -36,23 +36,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql/close", params=params, headers=headers, body=body ) @@ -62,7 +61,7 @@ async def close( ) async def explain( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -71,23 +70,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql/_explain", params=params, headers=headers, body=body ) @@ -105,15 +103,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :arg source: The URL-encoded request definition. Useful for @@ -128,7 +128,7 @@ async def get_stats( ) async def post_stats( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -138,23 +138,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql/stats", params=params, headers=headers, body=body ) @@ -164,7 +163,7 @@ async def post_stats( ) async def query( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -173,23 +172,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql", params=params, headers=headers, body=body ) @@ -197,7 +195,7 @@ async def query( @query_params("error_trace", "filter_path", "format", "human", "pretty", "source") async def settings( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -206,21 +204,20 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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( "PUT", "/_plugins/_query/settings", diff --git a/opensearchpy/_async/plugins/transforms.py b/opensearchpy/_async/plugins/transforms.py index 9559097f..5b53e070 100644 --- a/opensearchpy/_async/plugins/transforms.py +++ b/opensearchpy/_async/plugins/transforms.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -101,13 +105,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -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: @@ -132,18 +139,24 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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/_transform/_preview", params=params, headers=headers + "POST", + "/_plugins/_transform/_preview", + params=params, + headers=headers, + body=body, ) @query_params( @@ -169,17 +182,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -216,14 +231,16 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg search: The search term to use to filter results. :arg size: Specifies the number of transforms to return. Default is `10`. @@ -254,13 +271,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -287,13 +306,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/client/__init__.py b/opensearchpy/client/__init__.py index 8055eead..6793005e 100644 --- a/opensearchpy/client/__init__.py +++ b/opensearchpy/client/__init__.py @@ -46,6 +46,8 @@ from .http import HttpClient from .indices import IndicesClient from .ingest import IngestClient +from .insights import InsightsClient +from .list import ListClient from .nodes import NodesClient from .plugins import PluginsClient from .remote import RemoteClient @@ -55,6 +57,7 @@ from .snapshot import SnapshotClient from .tasks import TasksClient from .utils import SKIP_IN_PATH, _bulk_body, _make_path, query_params +from .wlm import WlmClient logger = logging.getLogger("opensearch") @@ -109,7 +112,7 @@ class OpenSearch(Client): ]) If using SSL, there are several parameters that control how we deal with - certificates (see :class:`~opensearchpy.Urllib3HttpConnection` for + certificates (see :class:`~opensearchpy.AIOHttpConnection` for detailed description of the options):: client = OpenSearch( @@ -123,7 +126,7 @@ class OpenSearch(Client): ) If using SSL, but don't verify the certs, a warning message is showed - optionally (see :class:`~opensearchpy.Urllib3HttpConnection` for + optionally (see :class:`~opensearchpy.AIOHttpConnection` for detailed description of the options):: client = OpenSearch( @@ -132,12 +135,14 @@ class OpenSearch(Client): use_ssl=True, # no verify SSL certificates verify_certs=False, + # don't verify the hostname in the certificate + ssl_assert_hostname=False, # don't show warnings about ssl certs verification ssl_show_warn=False ) SSL client authentication is supported - (see :class:`~opensearchpy.Urllib3HttpConnection` for + (see :class:`~opensearchpy.AIOHttpConnection` for detailed description of the options):: client = OpenSearch( @@ -214,6 +219,9 @@ 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.wlm = WlmClient(self) + self.list = ListClient(self) + self.insights = InsightsClient(self) self.search_pipeline = SearchPipelineClient(self) self.cat = CatClient(self) self.cluster = ClusterClient(self) @@ -267,13 +275,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -295,13 +305,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -344,18 +356,20 @@ def create( :arg id: Unique identifier for the document. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :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. + response. Default is false. :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 @@ -422,11 +436,13 @@ def index( :arg body: The document :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has @@ -443,7 +459,7 @@ def index( 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. + response. Default is false. :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 @@ -518,18 +534,20 @@ def bulk( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :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. + response. Default is false. :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 @@ -573,17 +591,19 @@ def clear_scroll( :arg body: Comma-separated list of scroll IDs to clear if none - was specified via the scroll_id parameter + was specified using the `scroll_id` parameter :arg scroll_id: Comma-separated list of scroll IDs to clear. To 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -632,13 +652,13 @@ def count( :arg body: Query to restrict the results specified with the Query DSL (optional) - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - and indices, omit this parameter or use `*` or `_all`. + and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg analyze_wildcard: If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the `q` query string parameter is specified. Default is false. @@ -652,18 +672,19 @@ def count( in the query string. This parameter can only be used when the `q` query string parameter is specified. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. + statistics. Default is True. :arg ignore_throttled: If `true`, concrete, expanded or aliased - indices are ignored when frozen. + indexes are ignored when frozen. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as @@ -673,7 +694,7 @@ def count( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg routing: Custom value used to route operations to a specific shard. @@ -720,17 +741,19 @@ def delete( :arg index: Name of the target 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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 @@ -810,9 +833,9 @@ def delete_by_query( Deletes documents matching the provided query. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - or indices, omit this parameter or use `*` or `_all`. + or indexes, omit this parameter or use `*` or `_all`. :arg body: The search definition using the Query DSL :arg _source: True or false to return the _source field or not, or a list of fields to return. @@ -822,8 +845,8 @@ def delete_by_query( the _source field. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg analyze_wildcard: If `true`, wildcard and prefix queries @@ -836,17 +859,19 @@ def delete_by_query( :arg df: Field to use as default where no field prefix is given in the query string. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as @@ -856,7 +881,7 @@ def delete_by_query( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg refresh: If `true`, OpenSearch refreshes all shards involved in the delete by query after the request completes. @@ -888,7 +913,7 @@ def delete_by_query( caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target - data streams with backing indices across multiple data tiers. + data streams with backing indexes across multiple data tiers. :arg timeout: Period each deletion request waits for active shards. :arg version: If `true`, returns the document version as part of @@ -932,13 +957,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg requests_per_second: The throttle for this request in sub- requests per second. :arg source: The URL-encoded request definition. Useful for @@ -978,17 +1005,19 @@ def delete_script( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1030,7 +1059,7 @@ def exists( Returns information about whether a document exists in an index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). :arg id: Identifier of the document. :arg _source: `true` or `false` to return the `_source` field or @@ -1040,15 +1069,17 @@ def exists( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If `true`, the request is real-time as opposed to near-real-time. :arg refresh: If `true`, OpenSearch refreshes all shards @@ -1102,7 +1133,7 @@ def exists_source( Returns information about whether a document source exists in an index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). :arg id: Identifier of the document. :arg _source: `true` or `false` to return the `_source` field or @@ -1112,15 +1143,17 @@ def exists_source( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If true, the request is real-time as opposed to near-real-time. :arg refresh: If `true`, OpenSearch refreshes all shards @@ -1196,17 +1229,19 @@ def explain( :arg df: Field to use as default where no field prefix is given 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg lenient: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg routing: Custom value used to route operations to a specific shard. @@ -1246,38 +1281,39 @@ def field_caps( ) -> Any: """ Returns the information about the capabilities of fields among multiple - indices. + indexes. :arg body: An index filter specified with the Query DSL - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all - data streams and indices, omit this parameter or use * or _all. + data streams and indexes, omit this parameter or use * or _all. :arg allow_no_indices: If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 + statistics. Default is True. + :arg ignore_unavailable: If `true`, missing or closed indexes are not included in the response. :arg include_unmapped: If true, unmapped fields are included in the response. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1326,15 +1362,17 @@ def get( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If `true`, the request is real-time as opposed to near-real-time. :arg refresh: If true, OpenSearch refreshes the affected shards @@ -1384,16 +1422,18 @@ def get_script( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1440,15 +1480,17 @@ def get_source( :arg _source_includes: A comma-separated list of source fields 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: Boolean) If true, the request is real-time as opposed to near-real-time. :arg refresh: If true, OpenSearch refreshes the affected shards @@ -1516,15 +1558,17 @@ def mget( using the `_source_excludes` query parameter. If the `_source` parameter 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If `true`, the request is real-time as opposed to near-real-time. :arg refresh: If `true`, the request refreshes relevant shards @@ -1574,17 +1618,19 @@ def msearch( :arg body: The request definitions (metadata-search request definition pairs), separated by newlines - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases to search. :arg ccs_minimize_roundtrips: If true, network roundtrips between the coordinating node and remote clusters are 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg max_concurrent_searches: Maximum number of concurrent searches the multi search API can execute. :arg max_concurrent_shard_requests: Maximum number of concurrent @@ -1598,7 +1644,7 @@ def msearch( on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg rest_total_hits_as_int: If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. Default is false. @@ -1647,21 +1693,23 @@ def msearch_template( :arg body: The request definitions (metadata-search request definition pairs), separated by newlines - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - and indices, omit this parameter or use `*`. + and indexes, omit this parameter or use `*`. :arg ccs_minimize_roundtrips: If `true`, network round-trips are 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg max_concurrent_searches: Maximum number of concurrent searches the API can run. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg rest_total_hits_as_int: If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object. Default is false. @@ -1720,7 +1768,7 @@ def mtermvectors( document ids. See documentation. :arg index: Name of the index that contains the documents. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :arg field_statistics: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Default is True. @@ -1728,10 +1776,12 @@ 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. + statistics. Default is True. :arg ids: A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body :arg offsets: If `true`, the response includes term offsets. @@ -1743,7 +1793,7 @@ def mtermvectors( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If true, the request is real-time as opposed to near-real-time. Default is True. :arg routing: Custom value used to route operations to a @@ -1794,17 +1844,19 @@ def put_script( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1848,30 +1900,32 @@ def rank_eval( :arg body: The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard (`*`) expressions are - supported. To target all data streams and indices in a cluster, omit + supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: If `true`, missing or closed indexes are not included in the response. :arg pretty: Whether to pretty format the returned JSON - response. - :arg search_type: Search operation type + response. Default is false. + :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. """ @@ -1916,15 +1970,17 @@ def reindex( :arg body: The search definition using the Query DSL and the 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg max_docs: Maximum number of documents to process. By default, all documents. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg refresh: If `true`, the request refreshes affected shards to make this operation visible to search. :arg requests_per_second: The throttle for this request in sub- @@ -1967,13 +2023,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg requests_per_second: The throttle for this request in sub- requests per second. :arg source: The URL-encoded request definition. Useful for @@ -2005,13 +2063,15 @@ def render_search_template( :arg id: ID of the search template to render. If no `source` is 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2036,13 +2096,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2078,13 +2140,15 @@ def scroll( parameter. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg rest_total_hits_as_int: If true, the API response's hit.total property is returned as an integer. If false, the API response's hit.total property is returned as an object. Default is @@ -2169,9 +2233,9 @@ def search( :arg body: The search definition using the Query DSL - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - and indices, omit this parameter or use `*` or `_all`. + and indexes, omit this parameter or use `*` or `_all`. :arg _source: Indicates which source fields are returned for matching documents. These fields are returned in the `hits._source` property of the search response. Valid values are: `true` to return the @@ -2189,8 +2253,8 @@ def search( is `false`, this parameter is ignored. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg allow_partial_search_results: If true, returns partial @@ -2222,24 +2286,25 @@ def search( :arg docvalue_fields: A comma-separated list of fields to return as the docvalue representation for each hit. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 `search_after` parameter. Default is 0. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_throttled: If `true`, concrete, expanded or aliased - indices will be ignored when frozen. + indexes will be ignored when frozen. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg include_named_queries_score: Indicates whether @@ -2285,7 +2350,7 @@ def search( `` to the same shards in the same order. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax using query parameter search. Query parameter searches do not support the full OpenSearch Query DSL but are handy for testing. @@ -2341,7 +2406,7 @@ def search( caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target - data streams with backing indices across multiple data tiers. If set to + data streams with backing indexes across multiple data tiers. If set to `0` (default), the query does not terminate early. :arg timeout: Specifies the period of time to wait for a response from each shard. If no response is received before the timeout @@ -2389,29 +2454,31 @@ def search_shards( headers: Any = None, ) -> Any: """ - Returns information about the indices and shards that a search request would be + Returns information about the indexes and shards that a search request would be executed against. - :arg index: Returns the indices and shards that a search request + :arg index: Returns the indexes and shards that a search request would be executed against. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg local: If `true`, the request retrieves information from @@ -2419,7 +2486,7 @@ def search_shards( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg routing: Custom value used to route operations to a specific shard. :arg source: The URL-encoded request definition. Useful for @@ -2461,18 +2528,18 @@ def search_template( :arg body: The search definition template and its params - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (*). :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg ccs_minimize_roundtrips: If `true`, network round-trips are minimized for cross-cluster search requests. Default is True. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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- @@ -2480,18 +2547,20 @@ 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. + statistics. Default is True. :arg ignore_throttled: If `true`, specified concrete, expanded, - or aliased indices are not included in the response when throttled. + or aliased indexes are not included in the response when throttled. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg profile: If `true`, the query execution is profiled. :arg rest_total_hits_as_int: If true, hits.total are rendered as an integer in the response. Default is false. @@ -2553,7 +2622,7 @@ def termvectors( termvectors for. See documentation. :arg id: Unique identifier of the document. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :arg field_statistics: If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Default is True. @@ -2561,10 +2630,12 @@ 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. + statistics. Default is True. :arg offsets: If `true`, the response includes term offsets. Default is True. :arg payloads: If `true`, the response includes term payloads. @@ -2574,7 +2645,7 @@ def termvectors( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg realtime: If true, the request is real-time as opposed to near-real-time. Default is True. :arg routing: Custom value used to route operations to a @@ -2639,18 +2710,20 @@ def update( :arg _source_includes: Specify the source fields you want 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg lang: The script language. Default is painless. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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 @@ -2736,9 +2809,9 @@ def update_by_query( for example to pick up a mapping change. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - or indices, omit this parameter or use `*` or `_all`. + or indexes, omit this parameter or use `*` or `_all`. :arg body: The search definition using the Query DSL :arg _source: True or false to return the _source field or not, or a list of fields to return. @@ -2748,8 +2821,8 @@ def update_by_query( the _source field. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg analyze_wildcard: If `true`, wildcard and prefix queries @@ -2762,17 +2835,19 @@ def update_by_query( :arg df: Field to use as default where no field prefix is given in the query string. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as @@ -2787,7 +2862,7 @@ def update_by_query( :arg preference: Specifies the node or shard the operation should be performed on. Random by default. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg refresh: If `true`, OpenSearch refreshes affected shards to make the operation visible to search. @@ -2818,7 +2893,7 @@ def update_by_query( caution. OpenSearch applies this parameter to each shard handling the request. When possible, let OpenSearch perform early termination automatically. Avoid specifying this parameter for requests that target - data streams with backing indices across multiple data tiers. + data streams with backing indexes across multiple data tiers. :arg timeout: Period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. :arg version: If `true`, returns the document version as part of @@ -2861,13 +2936,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg requests_per_second: The throttle for this request in sub- requests per second. :arg source: The URL-encoded request definition. Useful for @@ -2894,13 +2971,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2919,13 +2998,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2955,24 +3036,25 @@ def create_pit( Creates point in time context. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. :arg allow_partial_pit_creation: Allow if point in time can be created with partial failures. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. + statistics. Default is True. :arg keep_alive: Specify the keep alive for point in time. :arg preference: Specify the node or shard the operation should be performed on. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg routing: Comma-separated list of specific routing values. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. @@ -2998,13 +3080,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -3025,13 +3109,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -3054,16 +3140,108 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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", "/_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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :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. Default is false. + :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..3ee9a5c3 100644 --- a/opensearchpy/client/cat.py +++ b/opensearchpy/client/cat.py @@ -61,30 +61,31 @@ def aliases( headers: Any = None, ) -> Any: """ - Shows information about currently configured aliases to indices including - filter and routing infos. + Shows information about currently configured aliases to indexes including + filter and routing info. :arg name: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -120,17 +121,19 @@ def all_pit_segments( :arg bytes: The unit in which to display byte values. Valid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -175,22 +178,24 @@ def allocation( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -231,22 +236,24 @@ def cluster_manager( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -277,24 +284,26 @@ def count( ) -> Any: """ Provides quick access to the document count of the entire cluster, or - individual indices. + individual indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -334,17 +343,19 @@ def fielddata( :arg bytes: The unit used to display byte values. Valid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -382,17 +393,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -418,13 +431,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -460,32 +475,34 @@ def indices( headers: Any = None, ) -> Any: """ - Returns information about indices: number of primaries and replicas, document + Returns information about indexes: number of primaries and replicas, document counts, disk size, ... - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. - :arg health: The health status used to limit returned indices. - By default, the response includes indices of any health status. Valid + :arg health: The health status used to limit returned indexes. + By default, the response includes indexes of any health status. Valid choices are green, red, yellow. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_unloaded_segments: If true, the response includes information from segments that are not loaded into memory. Default is false. @@ -495,7 +512,7 @@ def indices( use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg pri: If true, the response only includes information from primary shards. Default is false. :arg s: Comma-separated list of column names or column aliases @@ -537,22 +554,24 @@ def master( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -595,22 +614,24 @@ def nodeattrs( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -653,9 +674,11 @@ def nodes( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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`, @@ -663,7 +686,7 @@ def nodes( :arg h: Comma-separated list of column names to display. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local (Deprecated: This parameter does not cause this API to act locally.): Return local information, do not retrieve the state from cluster-manager node. Default is false. @@ -671,7 +694,7 @@ def nodes( use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -712,22 +735,24 @@ def pending_tasks( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -766,17 +791,19 @@ def pit_segments( :arg bytes: The unit in which to display byte values. Valid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -814,22 +841,24 @@ def plugins( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -875,17 +904,19 @@ def recovery( :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -925,22 +956,24 @@ def repositories( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -989,9 +1022,9 @@ def segment_replication( names to limit the returned information. :arg active_only: If `true`, the response only includes ongoing segment replication events. Default is false. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg bytes: The unit in which to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg completed_only: If `true`, the response only includes @@ -999,24 +1032,25 @@ def segment_replication( :arg detailed: If `true`, the response includes detailed information about segment replications. Default is false. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_throttled: Whether specified concrete, expanded or - aliased indices should be ignored when throttled. - :arg ignore_unavailable: Whether specified concrete indices + aliased indexes should be ignored when throttled. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg shards: Comma-separated list of shards to display. @@ -1059,28 +1093,30 @@ def segments( Provides low-level information about the segments in the shards of an index. - :arg index: A comma-separated list of data streams, indices, and + :arg index: A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1118,30 +1154,32 @@ def shards( Provides a detailed view of shard allocation on nodes. - :arg index: A comma-separated list of data streams, indices, and + :arg index: A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg bytes: The unit used to display byte values. Valid choices are b, g, gb, k, kb, m, mb, p, pb, t, tb. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1186,22 +1224,24 @@ def thread_pool( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg size: The multiplier in which to display values. @@ -1249,22 +1289,24 @@ def snapshots( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_unavailable: If `true`, the response does not include information from unavailable snapshots. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1312,15 +1354,17 @@ def tasks( :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg nodes: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all @@ -1328,7 +1372,7 @@ def tasks( :arg parent_task_id: The parent task identifier, which is used to limit the response. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for @@ -1371,22 +1415,24 @@ def templates( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. :arg help: Return help information. Default is false. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg s: Comma-separated list of column names or column aliases to sort by. :arg source: The URL-encoded request definition. Useful for diff --git a/opensearchpy/client/cluster.py b/opensearchpy/client/cluster.py index 271ed4d3..f39d6a3f 100644 --- a/opensearchpy/client/cluster.py +++ b/opensearchpy/client/cluster.py @@ -70,24 +70,25 @@ def health( Returns basic information about the health of the cluster. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are - supported. To target all data streams and indices in a cluster, omit + supported. To target all data streams and indexes in a cluster, omit this parameter or use `_all` or `*`. :arg awareness_attribute: The awareness attribute for which the health is required. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg level: Can be one of cluster, indexes or shards. Controls the details level of the health information returned. Valid choices are awareness_attributes, cluster, indices, shards. :arg local: If true, the request retrieves information from the @@ -98,7 +99,7 @@ def health( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -158,11 +159,13 @@ def pending_tasks( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. Default is false. @@ -171,7 +174,7 @@ def pending_tasks( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -209,24 +212,25 @@ def state( :arg metric: Limit the information returned to the specified metrics :arg index: A comma-separated list of index names; use `_all` or - empty string to perform the operation on all indices - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified) + empty string to perform the operation on all indexes + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified) :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 - statistics. - :arg ignore_unavailable: Whether specified concrete indices + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed) :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. @@ -234,7 +238,7 @@ def state( use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg wait_for_metadata_version: Wait for the metadata version to @@ -263,6 +267,8 @@ def state( ) def stats( self, + metric: Any = None, + index_metric: Any = None, node_id: Any = None, params: Any = None, headers: Any = None, @@ -271,18 +277,25 @@ def stats( Returns high-level overview of cluster statistics. + :arg metric: Limit the information returned to the specified + metrics + :arg index_metric: Limit the information returned for indexes + metric to the specific index metrics. It can be used only if indexes (or + all) metric is specified. :arg node_id: Comma-separated list of node filters used to limit 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for each node to respond. If a node @@ -332,13 +345,15 @@ def reroute( :arg dry_run: If true, then the request simulates the operation only and returns the resulting state. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout @@ -346,7 +361,7 @@ def reroute( :arg metric: Limits the information returned to the specified metrics. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg retry_failed: If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. :arg source: The URL-encoded request definition. Useful for @@ -383,13 +398,15 @@ def get_settings( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg include_defaults: If `true`, returns default cluster settings from the local node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -397,7 +414,7 @@ def get_settings( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -434,18 +451,20 @@ def put_settings( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -468,13 +487,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -504,17 +525,19 @@ def allocation_explain( :arg body: The index, shard, and primary flag to explain. Empty 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_disk_info: If true, returns information about disk usage and shard sizes. Default is false. :arg include_yes_decisions: If true, returns YES decisions in explanation. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -551,17 +574,19 @@ def delete_component_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -603,11 +628,13 @@ def get_component_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. Default is false. @@ -616,7 +643,7 @@ def get_component_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -653,7 +680,7 @@ def put_component_template( includes the following built-in component templates: `logs-mappings`; 'logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics- mapping`; `synthetics-settings`. OpenSearch Agent uses these templates - to configure backing indices for its data streams. If you use OpenSearch + to configure backing indexes for its data streams. If you use OpenSearch Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. If you don't use OpenSearch Agent and want to disable all built-in component @@ -665,17 +692,19 @@ def put_component_template( :arg create: If `true`, this request cannot replace or update 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. @@ -717,11 +746,13 @@ def exists_component_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. Default is false. @@ -730,7 +761,7 @@ def exists_component_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -757,13 +788,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg wait_for_removal: Specifies whether to wait for all @@ -801,11 +834,13 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg node_ids: A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names. @@ -813,7 +848,7 @@ def post_voting_config_exclusions( nodes to exclude from the voting configuration. If specified, you may not also specify node_ids. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: When adding a voting configuration exclusion, the @@ -837,13 +872,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -854,6 +891,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: @@ -862,13 +900,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -877,6 +917,7 @@ def delete_weighted_routing( "/_cluster/routing/awareness/weights", params=params, headers=headers, + body=body, ) @query_params("error_trace", "filter_path", "human", "pretty", "source") @@ -892,13 +933,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -933,13 +976,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -968,13 +1013,15 @@ def put_decommission_awareness( :arg awareness_attribute_name: Awareness attribute name. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -999,6 +1046,7 @@ def put_decommission_awareness( def put_weighted_routing( self, attribute: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -1008,13 +1056,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1026,4 +1076,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..f6c43117 100644 --- a/opensearchpy/client/dangling_indices.py +++ b/opensearchpy/client/dangling_indices.py @@ -67,16 +67,18 @@ def delete_dangling_index( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -118,16 +120,18 @@ def import_dangling_index( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -146,17 +150,19 @@ def list_dangling_indices( headers: Any = None, ) -> Any: """ - Returns all dangling indices. + Returns all dangling indexes. :arg error_trace: Whether to include the stack trace of returned - errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/client/indices.py b/opensearchpy/client/indices.py index e4ed6fa5..2eaf3ddf 100644 --- a/opensearchpy/client/indices.py +++ b/opensearchpy/client/indices.py @@ -57,13 +57,15 @@ def analyze( which the analysis should be performed :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -92,31 +94,33 @@ def refresh( headers: Any = None, ) -> Any: """ - Performs the refresh operation in one or more indices. + Performs the refresh operation in one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -143,33 +147,35 @@ def flush( headers: Any = None, ) -> Any: """ - Performs the flush operation on one or more indices. + Performs the flush operation on one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to flush. Supports wildcards (`*`). To flush all data streams - and indices, omit this parameter or use `*` or `_all`. + and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg wait_if_ongoing: If `true`, the flush operation blocks @@ -209,17 +215,19 @@ def create( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -269,17 +277,19 @@ def clone( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -328,33 +338,34 @@ def get( headers: Any = None, ) -> Any: """ - Returns information about one or more indices. + Returns information about one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported. :arg allow_no_indices: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing - or closed indices. This behavior applies even if the request targets - other open indices. For example, a request targeting foo*,bar* returns + or closed indexes. This behavior applies even if the request targets + other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. Default is false. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If false, requests that target a missing index return an error. Default is false. :arg include_defaults: If true, return all default settings in @@ -367,7 +378,7 @@ def get( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -404,30 +415,32 @@ def open( Opens an index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). By default, - you must explicitly name the indices you using to limit the request. To + you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg master_timeout (Deprecated: To promote inclusive language, @@ -435,7 +448,7 @@ def open( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -485,21 +498,23 @@ def close( names used to limit the request. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg master_timeout (Deprecated: To promote inclusive language, @@ -507,7 +522,7 @@ def close( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -548,27 +563,29 @@ def delete( Deletes an index. - :arg index: Comma-separated list of indices to delete. You + :arg index: Comma-separated list of indexes to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. Default is false. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. Default is false. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -576,7 +593,7 @@ def delete( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -614,27 +631,29 @@ def exists( Returns information about whether a particular index exists. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases. Supports wildcards (`*`). :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. Default is false. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. Default is false. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. Default is false. :arg include_defaults: If `true`, return all default settings in @@ -642,7 +661,7 @@ def exists( :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -683,21 +702,23 @@ def put_mapping( string to perform the operation on all indices. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg master_timeout (Deprecated: To promote inclusive language, @@ -705,7 +726,7 @@ def put_mapping( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -748,29 +769,31 @@ def get_mapping( headers: Any = None, ) -> Any: """ - Returns mappings for one or more indices. + Returns mappings for one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg local: If `true`, the request retrieves information from @@ -780,7 +803,7 @@ def get_mapping( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -813,24 +836,26 @@ def get_field_mapping( :arg fields: Comma-separated list or wildcard expression of fields used to limit returned information. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg include_defaults: If `true`, return all default settings in @@ -838,7 +863,7 @@ def get_field_mapping( :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -876,31 +901,33 @@ def exists_alias( :arg name: Comma-separated list of aliases to check. Supports wildcards (`*`). - :arg index: Comma-separated list of data streams or indices used + :arg index: Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data - streams and indices, omit this parameter or use `*` or `_all`. + streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, requests that include a - missing data stream or index in the target indices or data streams + missing data stream or index in the target indexes or data streams return an error. :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -933,33 +960,35 @@ def get_alias( Returns an alias. - :arg index: Comma-separated list of data streams or indices used + :arg index: Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). To target all data - streams and indices, omit this parameter or use `*` or `_all`. + streams and indexes, omit this parameter or use `*` or `_all`. :arg name: Comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -991,17 +1020,19 @@ def update_aliases( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1036,24 +1067,26 @@ def delete_alias( Deletes an alias. - :arg index: Comma-separated list of data streams or indices used + :arg index: Comma-separated list of data streams or indexes used to limit the request. Supports wildcards (`*`). :arg name: Comma-separated list of aliases to remove. Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1097,11 +1130,13 @@ def put_template( :arg create: If true, this request cannot replace or update 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout @@ -1111,7 +1146,7 @@ def put_template( are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1152,20 +1187,22 @@ def exists_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1204,13 +1241,15 @@ def get_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: If `true`, the request retrieves information from the local node only. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -1218,7 +1257,7 @@ def get_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1251,17 +1290,19 @@ def delete_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1298,35 +1339,36 @@ def get_settings( headers: Any = None, ) -> Any: """ - Returns settings for one or more indices. + Returns settings for one or more indexes. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg name: Comma-separated list or wildcard expression of settings to retrieve. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 - statistics. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg include_defaults: If `true`, return all default settings in @@ -1339,7 +1381,7 @@ def get_settings( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1373,31 +1415,32 @@ def put_settings( Updates the index settings. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. For example, a request targeting `foo*,bar*` + missing or closed indexes. This behavior applies even if the request + targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 - statistics. - :arg ignore_unavailable: Whether specified concrete indices + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection @@ -1406,7 +1449,7 @@ def put_settings( :arg preserve_existing: If `true`, existing index settings remain unchanged. Default is false. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -1452,30 +1495,31 @@ def stats( :arg index: A comma-separated list of index names; use `_all` or - empty string to perform the operation on all indices + empty string to perform the operation on all indexes :arg metric: Limit the information returned the specific metrics. :arg completion_fields: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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. + collected from closed indexes. Default is True. :arg groups: Comma-separated list of search groups to include in the search statistics. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_segment_file_sizes: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Default is false. @@ -1486,7 +1530,7 @@ def stats( cluster, index, or shard level. Valid choices are cluster, indices, shards. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1515,28 +1559,30 @@ def segments( Provides low-level information about segments in a Lucene index. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: If `true`, the request returns a verbose response. @@ -1577,15 +1623,15 @@ def validate_query( :arg body: The query definition specified with the Query DSL - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams - or indices, omit this parameter or use `*` or `_all`. + or indexes, omit this parameter or use `*` or `_all`. :arg all_shards: If `true`, the validation is executed on all shards instead of one random shard per index. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg analyze_wildcard: If `true`, wildcard and prefix queries are analyzed. Default is false. :arg analyzer: Analyzer to use for the query string. This @@ -1597,7 +1643,7 @@ def validate_query( in the query string. This parameter can only be used when the `q` query string parameter is specified. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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- @@ -1605,16 +1651,18 @@ 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg lenient: If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg rewrite: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. @@ -1651,17 +1699,17 @@ def clear_cache( headers: Any = None, ) -> Any: """ - Clears all or specific caches for one or more indices. + Clears all or specific caches for one or more indexes. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. :arg allow_no_indices: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only - missing or closed indices. This behavior applies even if the request - targets other open indices. + missing or closed indexes. This behavior applies even if the request + targets other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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- @@ -1673,14 +1721,16 @@ 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. + statistics. Default is True. :arg ignore_unavailable: If `false`, the request returns an error if it targets a missing or closed index. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg query: If `true`, clears the query cache. :arg request: If `true`, clears the request cache. :arg source: The URL-encoded request definition. Useful for @@ -1709,21 +1759,23 @@ def recovery( Returns information about ongoing index shard recoveries. - :arg index: Comma-separated list of data streams, indices, and + :arg index: Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target - all data streams and indices, omit this parameter or use `*` or `_all`. + all data streams and indexes, omit this parameter or use `*` or `_all`. :arg active_only: If `true`, the response only includes ongoing shard recoveries. Default is false. :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1753,26 +1805,27 @@ def upgrade( The _upgrade API is no longer useful and will be removed. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg only_ancient_segments: If true, only ancient (an older Lucene major release) segments will be upgraded. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should this request wait until the @@ -1802,24 +1855,25 @@ def get_upgrade( The _upgrade API is no longer useful and will be removed. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1845,29 +1899,30 @@ def shard_stores( headers: Any = None, ) -> Any: """ - Provides store information for shard copies of indices. + Provides store information for shard copies of indexes. - :arg index: List of data streams, indices, and aliases used to + :arg index: List of data streams, indexes, and aliases used to limit the request. :arg allow_no_indices: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing - or closed indices. This behavior applies even if the request targets - other open indices. + or closed indexes. This behavior applies even if the request targets + other open indexes. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 + statistics. Default is True. + :arg ignore_unavailable: If true, missing or closed indexes are not included in the response. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg status: List of shard health statuses used to limit the @@ -1899,26 +1954,27 @@ def forcemerge( headers: Any = None, ) -> Any: """ - Performs the force merge operation on one or more indices. + Performs the force merge operation on one or more indexes. :arg index: A comma-separated list of index names; use `_all` or - empty string to perform the operation on all indices - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified) + empty string to perform the operation on all indexes + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified) :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 - statistics. - :arg ignore_unavailable: Whether specified concrete indices + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed) :arg max_num_segments: The number of larger segments into which smaller segments are merged. Set this parameter to 1 to merge all @@ -1927,7 +1983,7 @@ def forcemerge( :arg only_expunge_deletes: Specify whether the operation should only expunge deleted documents :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg primary_only: Specify whether the operation should only perform on primary shards. Defaults to false. Default is false. :arg source: The URL-encoded request definition. Useful for @@ -1974,17 +2030,19 @@ def shrink( :arg copy_settings: whether or not to copy settings from the 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -2047,17 +2105,19 @@ def split( :arg copy_settings: whether or not to copy settings from the 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg task_execution_timeout: Explicit task execution timeout, @@ -2120,17 +2180,19 @@ def rollover( satisfies the specified conditions but does not perform a 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -2172,13 +2234,15 @@ def create_data_stream( faster. :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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2207,13 +2271,15 @@ def delete_data_stream( :arg name: Comma-separated list of data streams to delete. 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2249,17 +2315,19 @@ def delete_index_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -2302,13 +2370,15 @@ def exists_index_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -2316,7 +2386,7 @@ def exists_index_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2353,13 +2423,15 @@ def get_index_template( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg local: If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. Default is false. @@ -2368,7 +2440,7 @@ def get_index_template( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2407,16 +2479,18 @@ def put_index_template( :arg create: If `true`, this request cannot replace or update 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Operation timeout for connection to master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2468,17 +2542,19 @@ def simulate_index_template( the template is not permanently added or updated in either case; it is 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2508,13 +2584,15 @@ def get_data_stream( limit the request. Wildcard (`*`) expressions are supported. If omitted, 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2557,17 +2635,19 @@ def simulate_template( the template is not permanently added or updated in either case; it is 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2589,25 +2669,27 @@ def resolve_index( headers: Any = None, ) -> Any: """ - Returns information about any matching indices, aliases, and data streams. + Returns information about any matching indexes, aliases, and data streams. :arg name: Comma-separated name(s) or index pattern(s) of the - indices, aliases, and data streams to resolve. Resources on remote + indexes, aliases, and data streams to resolve. Resources on remote clusters can be specified using the ``:`` syntax. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 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. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2642,30 +2724,31 @@ def add_block( Adds a block to an index. - :arg index: A comma separated list of indices to add a block to + :arg index: A comma separated list of indexes to add a block to :arg block: The block to add (one of read, write, read_only or metadata) - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified) + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified) :arg cluster_manager_timeout: Operation timeout for connection to cluster-manager node. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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 + statistics. Default is True. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed) :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Specify timeout for connection to master :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -2693,13 +2776,15 @@ def data_streams_stats( the request. Wildcard expressions (`*`) are supported. To target all 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2734,25 +2819,27 @@ def put_alias( :arg body: The settings for the alias, such as `routing` or `filter` - :arg index: Comma-separated list of data streams or indices to + :arg index: Comma-separated list of data streams or indexes to add. Supports wildcards (`*`). Wildcard patterns that match both data - streams and indices return an error. + streams and indexes return an error. :arg name: Alias to update. If the alias doesn't exist, the request creates it. Index alias names support date math. :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is diff --git a/opensearchpy/client/ingest.py b/opensearchpy/client/ingest.py index 7d070bff..08180661 100644 --- a/opensearchpy/client/ingest.py +++ b/opensearchpy/client/ingest.py @@ -65,17 +65,19 @@ def get_pipeline( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -109,17 +111,19 @@ def put_pipeline( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -164,17 +168,19 @@ def delete_pipeline( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -207,13 +213,15 @@ def simulate( :arg id: Pipeline to test. If you don't specify a `pipeline` in 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: If `true`, the response includes output data for @@ -241,13 +249,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/client/insights.py b/opensearchpy/client/insights.py new file mode 100644 index 00000000..46c8c203 --- /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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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/list.py b/opensearchpy/client/list.py new file mode 100644 index 00000000..2a359f44 --- /dev/null +++ b/opensearchpy/client/list.py @@ -0,0 +1,211 @@ +# 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, _make_path, query_params + + +class ListClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def help( + self, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Returns help for the List APIs. + + + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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", "/_list", params=params, headers=headers + ) + + @query_params( + "bytes", + "cluster_manager_timeout", + "error_trace", + "expand_wildcards", + "filter_path", + "format", + "h", + "health", + "help", + "human", + "include_unloaded_segments", + "local", + "master_timeout", + "next_token", + "pretty", + "pri", + "s", + "size", + "sort", + "source", + "time", + "v", + ) + def indices( + self, + index: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Returns paginated information about indexes including number of primaries and + replicas, document counts, disk size. + + + :arg index: Comma-separated list of data streams, indexes, and + aliases used to limit the request. Supports wildcards (`*`). To target + all data streams and indexes, omit this parameter or use `*` or `_all`. + :arg bytes: The unit used to display byte values. Valid choices + are b, g, gb, k, kb, m, mb, p, pb, t, tb. + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg expand_wildcards: The type of index that wildcard patterns + 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, such as + `JSON`, `YAML`. + :arg h: Comma-separated list of column names to display. + :arg health: The health status used to limit returned indexes. + By default, the response includes indexes of any health status. Valid + choices are green, red, yellow. + :arg help: Return help information. Default is false. + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg include_unloaded_segments: If true, the response includes + information from segments that are not loaded into memory. Default is + false. + :arg local: Return local information, do not retrieve the state + from cluster-manager node. Default is false. + :arg master_timeout (Deprecated: To promote inclusive language, + use `cluster_manager_timeout` instead.): Operation timeout for + connection to cluster manager node. + :arg next_token: Token to retrieve next page of indexes. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg pri: If true, the response only includes information from + primary shards. Default is false. + :arg s: Comma-separated list of column names or column aliases + to sort by. + :arg size: Maximum number of indexes to be displayed in a page. + :arg sort: Defines order in which indexes will be displayed. + Accepted values are `asc` and `desc`. If `desc`, most recently created + indexes would be displayed first. Valid choices are asc, desc. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg time: The unit used to display time values. Valid choices + are d, h, m, micros, ms, nanos, s. + :arg v: Verbose mode. Display column headers. Default is false. + """ + return self.transport.perform_request( + "GET", _make_path("_list", "indices", index), params=params, headers=headers + ) + + @query_params( + "bytes", + "cluster_manager_timeout", + "error_trace", + "filter_path", + "format", + "h", + "help", + "human", + "local", + "master_timeout", + "next_token", + "pretty", + "s", + "size", + "sort", + "source", + "time", + "v", + ) + def shards( + self, + index: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Returns paginated details of shard allocation on nodes. + + + :arg index: A comma-separated list of data streams, indexes, and + aliases used to limit the request. Supports wildcards (`*`). To target + all data streams and indexes, omit this parameter or use `*` or `_all`. + :arg bytes: The unit used to display byte values. Valid choices + are b, g, gb, k, kb, m, mb, p, pb, t, tb. + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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, such as + `JSON`, `YAML`. + :arg h: Comma-separated list of column names to display. + :arg help: Return help information. Default is false. + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg local: Return local information, do not retrieve the state + from cluster-manager node. Default is false. + :arg master_timeout (Deprecated: To promote inclusive language, + use 'cluster_manager_timeout' instead.): Operation timeout for + connection to cluster manager node. + :arg next_token: Token to retrieve next page of shards. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg s: Comma-separated list of column names or column aliases + to sort by. + :arg size: Maximum number of shards to be displayed in a page. + :arg sort: Defines order in which shards will be displayed. + Accepted values are `asc` and `desc`. If `desc`, most recently created + shards would be displayed first. Valid choices are asc, desc. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + :arg time: The unit in which to display time values. Valid + choices are d, h, m, micros, ms, nanos, s. + :arg v: Verbose mode. Display column headers. Default is false. + """ + return self.transport.perform_request( + "GET", _make_path("_list", "shards", index), params=params, headers=headers + ) diff --git a/opensearchpy/client/nodes.py b/opensearchpy/client/nodes.py index 0e264488..3d24a283 100644 --- a/opensearchpy/client/nodes.py +++ b/opensearchpy/client/nodes.py @@ -57,13 +57,15 @@ def reload_secure_settings( :arg node_id: The names of particular nodes in the cluster to 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -91,6 +93,7 @@ def info( self, node_id: Any = None, metric: Any = None, + node_id_or_metric: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -102,16 +105,21 @@ def info( limit returned information. :arg metric: Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + :arg node_id_or_metric: Limits the information returned to a + list of node IDs or specific metrics. Supports a comma-separated list, + such as node1,node2 or 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -153,23 +161,25 @@ def stats( limit returned information. :arg metric: Limit the information returned to the specified metrics - :arg index_metric: Limit the information returned for indices - metric to the specific index metrics. It can be used only if indices (or + :arg index_metric: Limit the information returned for indexes + metric to the specific index metrics. It can be used only if indexes (or all) metric is specified. :arg completion_fields: Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 groups: Comma-separated list of search groups to include in the search statistics. :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg include_segment_file_sizes: If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). Default is false. @@ -177,7 +187,7 @@ def stats( cluster, index, or shard level. Valid choices are cluster, indices, shards. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -223,17 +233,19 @@ def hot_threads( :arg doc_type: The type to sample. Valid choices are block, cpu, 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_idle_threads: Don't show threads that are in known- idle places, such as waiting on a socket select or pulling from an empty task queue. Default is True. :arg interval: The interval for the second sampling of threads. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg snapshots: Number of samples of thread stacktrace. Default is 10. :arg source: The URL-encoded request definition. Useful for @@ -273,13 +285,15 @@ def usage( metrics. A comma-separated list of the following options: `_all`, `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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is 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..1fb03c03 100644 --- a/opensearchpy/client/remote_store.py +++ b/opensearchpy/client/remote_store.py @@ -45,13 +45,15 @@ def restore( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should this request wait until the diff --git a/opensearchpy/client/search_pipeline.py b/opensearchpy/client/search_pipeline.py index bd764c3c..aa04c85e 100644 --- a/opensearchpy/client/search_pipeline.py +++ b/opensearchpy/client/search_pipeline.py @@ -45,13 +45,15 @@ def get( :arg cluster_manager_timeout: operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -82,13 +84,15 @@ def delete( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. @@ -127,13 +131,15 @@ def put( :arg cluster_manager_timeout: operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. diff --git a/opensearchpy/client/security.py b/opensearchpy/client/security.py index 0b2d63a4..ed2e3f57 100644 --- a/opensearchpy/client/security.py +++ b/opensearchpy/client/security.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -61,13 +63,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -95,13 +99,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -128,13 +134,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -158,13 +166,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -195,13 +205,15 @@ def create_action_group( :arg action_group: The name of the action group to create or 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -231,13 +243,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -265,13 +279,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -299,13 +315,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -330,13 +348,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -360,13 +380,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -394,13 +416,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -430,13 +454,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -464,13 +490,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -497,13 +525,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -528,13 +558,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -555,13 +587,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -589,13 +623,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -625,13 +661,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -659,13 +697,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -692,13 +732,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -723,13 +765,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -753,13 +797,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -787,13 +833,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -823,13 +871,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -857,13 +907,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -891,13 +943,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -922,13 +976,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -949,13 +1005,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -983,13 +1041,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1019,13 +1079,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1053,13 +1115,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1085,13 +1149,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1115,13 +1181,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1150,13 +1218,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1183,13 +1253,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg show_all: A boolean flag to include/exclude static nodes DN from final result. :arg source: The URL-encoded request definition. Useful for @@ -1210,13 +1282,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1235,13 +1309,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1263,13 +1339,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1291,13 +1369,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1316,16 +1396,18 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg mode: A flag to indicate whether service should consider security-plugin's status before returning health response. `strict` mode indicates service should check security plugin status. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1344,13 +1426,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1370,13 +1454,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1403,13 +1489,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1437,13 +1525,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1478,13 +1568,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: Indicates whether a verbose response should be @@ -1505,13 +1597,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1530,13 +1624,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1556,13 +1652,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1585,13 +1683,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1611,18 +1711,20 @@ def create_allowlist( headers: Any = None, ) -> Any: """ - Creates or replaces the allowlisted APIs. Accessible via Super Admin + Creates or replaces the permitted APIs. Accessible using Super Admin certificate or REST API permission. :arg error_trace: Whether to include the stack trace of returned - errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1650,13 +1752,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1685,13 +1789,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1722,13 +1828,15 @@ def delete_distinguished_name( :arg cluster_name: The cluster-name to delete from list of 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1757,13 +1865,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1789,13 +1899,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1824,13 +1936,15 @@ def generate_user_token( :arg username: The name of the user for whom an auth token is to 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1860,13 +1974,15 @@ def generate_user_token_legacy( :arg username: The name of the user for whom an auth token is to 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1891,13 +2007,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1916,13 +2034,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -1945,13 +2065,15 @@ def get_distinguished_name( :arg cluster_name: The cluster-name to retrieve nodes DN setting 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg show_all: A boolean flag to include/exclude static nodes DN from final result. :arg source: The URL-encoded request definition. Useful for @@ -1980,13 +2102,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2008,13 +2132,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg show_dn: A boolean flag to indicate whether all domain names should be returned. :arg source: The URL-encoded request definition. Useful for @@ -2036,13 +2162,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2066,13 +2194,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2097,13 +2227,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2122,13 +2254,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2148,13 +2282,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2184,13 +2320,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2218,13 +2356,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2244,13 +2384,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2275,13 +2417,15 @@ def update_distinguished_name( :arg cluster_name: The cluster-name to create/update nodesDn 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2314,13 +2458,15 @@ def validate( :arg accept_invalid: A boolean flag to indicate whether invalid 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2339,13 +2485,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2366,13 +2514,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -2401,13 +2551,15 @@ def get_all_certificates( :arg cert_type: The type of certificates (HTTP, TRANSPORT, ALL) 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: The maximum duration, in seconds, to be spent to @@ -2443,13 +2595,15 @@ def get_node_certificates( :arg cert_type: The type of certificates (HTTP, TRANSPORT, ALL) 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: The maximum duration, in seconds, to be spent to diff --git a/opensearchpy/client/snapshot.py b/opensearchpy/client/snapshot.py index 0c68d75c..18a5e04d 100644 --- a/opensearchpy/client/snapshot.py +++ b/opensearchpy/client/snapshot.py @@ -69,17 +69,19 @@ def create( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: If `true`, the request returns a @@ -123,16 +125,18 @@ def delete( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -179,11 +183,13 @@ def get( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_unavailable: If false, the request returns an error for any snapshots that are unavailable. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, @@ -191,7 +197,7 @@ def get( to the master node. If no response is received before the timeout expires, the request fails and returns an error. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg verbose: If true, returns additional information about each @@ -235,16 +241,18 @@ def delete_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -283,18 +291,20 @@ def get_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg local: Return local information, do not retrieve the state from cluster-manager node. Default is false. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -329,16 +339,18 @@ def create_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -384,16 +396,18 @@ def restore( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should this request wait until the @@ -437,11 +451,13 @@ def status( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg ignore_unavailable: Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown Default is false. @@ -449,7 +465,7 @@ def status( use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -484,16 +500,18 @@ def verify_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Explicit operation timeout @@ -532,16 +550,18 @@ def cleanup_repository( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Period to wait for a connection to the master node. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. @@ -575,7 +595,7 @@ def clone( headers: Any = None, ) -> Any: """ - Clones indices from one snapshot into another snapshot in the same repository. + Clones indexes from one snapshot into another snapshot in the same repository. :arg repository: A repository name @@ -585,16 +605,18 @@ def clone( :arg cluster_manager_timeout: Operation timeout for connection 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg master_timeout (Deprecated: To promote inclusive language, use 'cluster_manager_timeout' instead.): Explicit operation timeout for connection to master node :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/client/tasks.py b/opensearchpy/client/tasks.py index 2303bb7e..dcd80200 100644 --- a/opensearchpy/client/tasks.py +++ b/opensearchpy/client/tasks.py @@ -69,13 +69,15 @@ def list( :arg detailed: If `true`, the response includes detailed 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg nodes: Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all @@ -84,7 +86,7 @@ def list( information. To return all tasks, omit this parameter or use a value of `-1`. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is @@ -122,16 +124,18 @@ def cancel( :arg actions: Comma-separated list or wildcard expression of 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg nodes: Comma-separated list of node IDs or names used to limit the request. :arg parent_task_id: Parent task ID used to limit the tasks. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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: Should the request block until the @@ -166,13 +170,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Period to wait for a response. If no response is diff --git a/opensearchpy/client/wlm.py b/opensearchpy/client/wlm.py new file mode 100644 index 00000000..4047cda6 --- /dev/null +++ b/opensearchpy/client/wlm.py @@ -0,0 +1,160 @@ +# 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 SKIP_IN_PATH, NamespacedClient, _make_path, query_params + + +class WlmClient(NamespacedClient): + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def create_query_group( + self, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Creates a new query group and sets the resource limits for the new query group. + + + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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( + "PUT", "/_wlm/query_group", params=params, headers=headers, body=body + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def delete_query_group( + self, + name: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Deletes the specified query group. + + + :arg name: The name of the query group. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + if name in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'name'.") + + return self.transport.perform_request( + "DELETE", + _make_path("_wlm", "query_group", name), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def get_query_group( + self, + name: Any = None, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Retrieves the specified query group. If no query group is specified, all query + groups in the cluster are retrieved. + + + :arg name: The name of the query group. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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", + _make_path("_wlm", "query_group", name), + params=params, + headers=headers, + ) + + @query_params("error_trace", "filter_path", "human", "pretty", "source") + def update_query_group( + self, + name: Any, + body: Any, + params: Any = None, + headers: Any = None, + ) -> Any: + """ + Updates the specified query group. + + + :arg name: The name of the query group. + :arg error_trace: Whether to include the stack trace of returned + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :arg source: The URL-encoded request definition. Useful for + libraries that do not accept a request body for non-POST requests. + """ + for param in (name, body): + if param in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument.") + + return self.transport.perform_request( + "PUT", + _make_path("_wlm", "query_group", name), + params=params, + headers=headers, + body=body, + ) diff --git a/opensearchpy/plugins/asynchronous_search.py b/opensearchpy/plugins/asynchronous_search.py new file mode 100644 index 00000000..f155d902 --- /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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :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. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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..116af2db --- /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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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..7eca2971 100644 --- a/opensearchpy/plugins/knn.py +++ b/opensearchpy/plugins/knn.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -153,9 +157,9 @@ def search_models( returned _source field. :arg _source_includes: List of fields to extract and return from the _source field. - :arg allow_no_indices: Whether to ignore if a wildcard indices - expression resolves into no concrete indices. (This includes `_all` - string or when no indices have been specified). + :arg allow_no_indices: Whether to ignore if a wildcard indexes + expression resolves into no concrete indexes. (This includes `_all` + string or when no indexes have been specified). :arg allow_partial_search_results: Indicate if an error should be returned if there is a partial search failure or timeout. Default is True. @@ -177,20 +181,21 @@ def search_models( :arg docvalue_fields: Comma-separated list of fields to return as the docvalue representation of a field for each hit. :arg error_trace: Whether to include the stack trace of returned - errors. + errors. Default is false. :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 indexes 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. + statistics. Default is True. :arg ignore_throttled: Whether specified concrete, expanded or - aliased indices should be ignored when throttled. - :arg ignore_unavailable: Whether specified concrete indices + aliased indexes should be ignored when throttled. + :arg ignore_unavailable: Whether specified concrete indexes should be ignored when unavailable (missing or closed). :arg lenient: Specify whether format-based query failures (such as providing text to a numeric field) should be ignored. @@ -208,7 +213,7 @@ def search_models( :arg preference: Specify the node or shard the operation should be performed on. Default is random. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg q: Query in the Lucene query string syntax. :arg request_cache: Specify if request cache should be used for this request or not, defaults to index level setting. @@ -280,13 +285,15 @@ def stats( :arg stat: Comma-separated list of stats to retrieve; use `_all` 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. :arg timeout: Operation timeout. @@ -315,14 +322,16 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg preference: Preferred node to execute training. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -349,16 +358,18 @@ def warmup( specified indexes. - :arg index: Comma-separated list of indices; use `_all` or empty - string to perform the operation on all indices. + :arg index: Comma-separated list of indexes; use `_all` or empty + string to perform the operation on all indexes. :arg error_trace: Whether to include the stack trace of returned - errors. - :arg filter_path: Comma-separated list of filters used to reduce - the response. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/plugins/ml.py b/opensearchpy/plugins/ml.py index 1183bf5e..cfb58405 100644 --- a/opensearchpy/plugins/ml.py +++ b/opensearchpy/plugins/ml.py @@ -34,13 +34,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -66,13 +68,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -100,13 +104,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -134,13 +140,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -166,13 +174,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -196,13 +206,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -226,13 +238,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -256,13 +270,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -288,13 +304,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". + :arg human: Whether to return human readable values for + statistics. Default is True. + :arg pretty: Whether to pretty format the returned JSON + response. Default is false. + :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..8976b5fe 100644 --- a/opensearchpy/plugins/notifications.py +++ b/opensearchpy/plugins/notifications.py @@ -34,13 +34,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -110,13 +114,15 @@ def delete_configs( :arg config_id_list: A comma-separated list of channel IDs 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -136,13 +142,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -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,17 +221,21 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -244,13 +258,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -270,13 +286,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -303,13 +321,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -336,13 +356,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/plugins/observability.py b/opensearchpy/plugins/observability.py index 1bf02b4a..2bf9e03f 100644 --- a/opensearchpy/plugins/observability.py +++ b/opensearchpy/plugins/observability.py @@ -34,13 +34,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -65,13 +67,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -104,17 +108,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg objectId: The ID of a single Observability Object to delete. :arg objectIdList: A comma-separated list of Observability Object IDs to delete. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -133,13 +139,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -163,13 +171,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -194,13 +204,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -222,13 +234,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/plugins/ppl.py b/opensearchpy/plugins/ppl.py index a18f1690..ccec49c5 100644 --- a/opensearchpy/plugins/ppl.py +++ b/opensearchpy/plugins/ppl.py @@ -36,15 +36,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for @@ -70,15 +72,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for @@ -103,15 +107,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for @@ -138,15 +144,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results. Default is True. :arg source: The URL-encoded request definition. Useful for diff --git a/opensearchpy/plugins/query.py b/opensearchpy/plugins/query.py index 7bb3a5b6..ab368d85 100644 --- a/opensearchpy/plugins/query.py +++ b/opensearchpy/plugins/query.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -70,13 +72,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -104,13 +108,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -133,13 +139,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -159,13 +167,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/plugins/rollups.py b/opensearchpy/plugins/rollups.py index b33d8a00..90b16e53 100644 --- a/opensearchpy/plugins/rollups.py +++ b/opensearchpy/plugins/rollups.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -101,13 +105,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -143,17 +149,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -181,13 +189,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -214,13 +224,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ diff --git a/opensearchpy/plugins/sql.py b/opensearchpy/plugins/sql.py index 67cdd99e..da6244cd 100644 --- a/opensearchpy/plugins/sql.py +++ b/opensearchpy/plugins/sql.py @@ -18,7 +18,7 @@ from typing import Any -from ..client.utils import SKIP_IN_PATH, NamespacedClient, query_params +from ..client.utils import NamespacedClient, query_params class SqlClient(NamespacedClient): @@ -27,7 +27,7 @@ class SqlClient(NamespacedClient): ) def close( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -36,23 +36,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql/close", params=params, headers=headers, body=body ) @@ -62,7 +61,7 @@ def close( ) def explain( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -71,23 +70,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql/_explain", params=params, headers=headers, body=body ) @@ -105,15 +103,17 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :arg source: The URL-encoded request definition. Useful for @@ -128,7 +128,7 @@ def get_stats( ) def post_stats( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -138,23 +138,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql/stats", params=params, headers=headers, body=body ) @@ -164,7 +163,7 @@ def post_stats( ) def query( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -173,23 +172,22 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg sanitize: Specifies whether to escape special characters in the results Default is True. :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/_sql", params=params, headers=headers, body=body ) @@ -197,7 +195,7 @@ def query( @query_params("error_trace", "filter_path", "format", "human", "pretty", "source") def settings( self, - body: Any, + body: Any = None, params: Any = None, headers: Any = None, ) -> Any: @@ -206,21 +204,20 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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 - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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( "PUT", "/_plugins/_query/settings", diff --git a/opensearchpy/plugins/transforms.py b/opensearchpy/plugins/transforms.py index 3b619278..2ade8c45 100644 --- a/opensearchpy/plugins/transforms.py +++ b/opensearchpy/plugins/transforms.py @@ -35,13 +35,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -68,13 +70,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -101,13 +105,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -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: @@ -132,18 +139,24 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :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/_transform/_preview", params=params, headers=headers + "POST", + "/_plugins/_transform/_preview", + params=params, + headers=headers, + body=body, ) @query_params( @@ -169,17 +182,19 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg if_primary_term: Only perform the operation if the document has this primary term. :arg if_seq_no: Only perform the operation if the document has this sequence number. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -216,14 +231,16 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list 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. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg search: The search term to use to filter results. :arg size: Specifies the number of transforms to return. Default is `10`. @@ -254,13 +271,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """ @@ -287,13 +306,15 @@ 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. + errors. Default is false. + :arg filter_path: Used to reduce the response. This parameter + takes a comma-separated list of filters. It supports using wildcards to + match any field or part of a field’s name. You can also exclude fields + with "-". :arg human: Whether to return human readable values for - statistics. + statistics. Default is True. :arg pretty: Whether to pretty format the returned JSON - response. + response. Default is false. :arg source: The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. """