actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Updated dependencies, generated API. (#793)

Browse Source 
* Updated dependencies.

Signed-off-by: dblock <dblock@amazon.com>

* Lock setuptools at 71.1.0.

Newer version seems to cause UserWarning: Unknown distribution option: 'test_suite'.

Signed-off-by: dblock <dblock@amazon.com>

* Updated opensearch-py APIs to reflect opensearch-api-specification@9d3bc34.

Signed-off-by: dblock <dblock@amazon.com>

* Do not test against flaky 2.0.

Signed-off-by: dblock <dblock@amazon.com>

* Reduce test matrix and add 2.16.

Signed-off-by: dblock <dblock@amazon.com>

* Fix missing spaces in generated descriptions.

Signed-off-by: dblock <dblock@amazon.com>

* Removed 2.2.1.

Signed-off-by: dblock <dblock@amazon.com>

---------

Signed-off-by: dblock <dblock@amazon.com>
This commit is contained in:
Daniel (dB.) Doubrovkine
2024-08-14 18:25:01 -04:00
committed by GitHub
parent 581cbbaf10
commit 2d6ae74211
47 changed files with 3817 additions and 1621 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/integration-unreleased.yml
+1 -1
View File
@@ -8,7 +8,7 @@ jobs:
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
opensearch_ref: [ '1.x', '2.x', '2.0', 'main' ] opensearch_ref: [ '1.x', '2.x', 'main' ]
steps: steps:
- name: Checkout OpenSearch - name: Checkout OpenSearch
.github/workflows/integration.yml
+2 -8
View File
@@ -9,14 +9,8 @@ jobs:
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
opensearch_version: [ '1.0.1', '1.1.0', '1.2.4', '1.3.7', '2.0.1', '2.1.0', '2.2.1', '2.3.0', '2.4.0', '2.5.0', '2.6.0', '2.7.0', '2.8.0', '2.9.0', '2.10.0', '2.11.1' ] opensearch_version: [ '1.0.1', '1.3.7' ]
secured: [ "true", "false" ] secured: [ "true", "false" ]
exclude:
# https://github.com/opensearch-project/opensearch-py/issues/612
- opensearch_version: 2.0.1
secured: "true"
- opensearch_version: 2.1.0
secured: "true"
steps: steps:
- name: Checkout - name: Checkout
uses: actions/checkout@v4 uses: actions/checkout@v4
@@ -32,7 +26,7 @@ jobs:
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
opensearch_version: [ '2.12.0', '2.13.0', '2.14.0' ] opensearch_version: [ '2.14.0', '2.16.0' ]
secured: [ "true", "false" ] secured: [ "true", "false" ]
steps: steps:
CHANGELOG.md
+4 -6
View File
@@ -13,16 +13,14 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
- Fixed Search helper to ensure proper retention of the _collapse attribute in chained operations. ([#771](https://github.com/opensearch-project/opensearch-py/pull/771)) - Fixed Search helper to ensure proper retention of the _collapse attribute in chained operations. ([#771](https://github.com/opensearch-project/opensearch-py/pull/771))
- 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 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))
### Updated APIs ### Updated APIs
- Updated opensearch-py APIs to reflect [opensearch-api-specification@0453dbe](https://github.com/opensearch-project/opensearch-api-specification/commit/0453dbe35080bf31eebac1d75f8022667d019e9f) - Updated opensearch-py APIs to reflect [opensearch-api-specification@9d3bc34](https://github.com/opensearch-project/opensearch-api-specification/commit/9d3bc340ccd7d049e7d6e14a4aff2293780cb446)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@0b033a9](https://github.com/opensearch-project/opensearch-api-specification/commit/0b033a92cac4cb20ec3fb51350c139afc753b089)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@d5ca873](https://github.com/opensearch-project/opensearch-api-specification/commit/d5ca873d20ff54be16ec48e7bd629cda7c4a6332)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@7452827](https://github.com/opensearch-project/opensearch-api-specification/commit/745282767026703ea27967d2705633c3e2661c97)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@f2afd71](https://github.com/opensearch-project/opensearch-api-specification/commit/f2afd7171406c7477fbd644d74087bb0e2948c75)
- Updated opensearch-py APIs to reflect [opensearch-api-specification@49cd814](https://github.com/opensearch-project/opensearch-api-specification/commit/49cd8140663f32f7c8b638ddc295683344edba61)
### Security ### Security
### Dependencies ### Dependencies
- Bump `pytest-asyncio` from <=0.23.7 to <=0.23.8 ([#787](https://github.com/opensearch-project/opensearch-py/pull/787)) - Bump `pytest-asyncio` from <=0.23.7 to <=0.23.8 ([#787](https://github.com/opensearch-project/opensearch-py/pull/787))
- Bump `sphinx` from <7.4 to <7.5 ([#788](https://github.com/opensearch-project/opensearch-py/pull/788)) - Bump `sphinx` from <7.4 to <7.5 ([#788](https://github.com/opensearch-project/opensearch-py/pull/788))
- Bump `urllib3` from >=1.26.18 to >=1.26.19 ([#793](https://github.com/opensearch-project/opensearch-py/pull/793))
- Bump `requests` from >=2.4.0 to >=2.32.0 ([#793](https://github.com/opensearch-project/opensearch-py/pull/793))
- Bump `certifi` from >=2022.12.07 to >=2024.07.04 ([#793](https://github.com/opensearch-project/opensearch-py/pull/793))
## [2.6.0] ## [2.6.0]
### Added ### Added
benchmarks/poetry.lock
Generated
+497 -418
View File
File diff suppressed because it is too large Load Diff
dev-requirements.txt
+1 -1
View File
@@ -8,7 +8,7 @@ jinja2
pytz pytz
deepmerge deepmerge
Events Events
setuptools setuptools==71.1.0
numpy; python_version<="3.12" numpy; python_version<="3.12"
pandas; python_version<="3.12" pandas; python_version<="3.12"
opensearchpy/_async/client/__init__.py
+199 -199
View File
@@ -350,16 +350,16 @@ class AsyncOpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -367,14 +367,14 @@ class AsyncOpenSearch(Client):
:arg timeout: Period the request waits for the following :arg timeout: Period the request waits for the following
operations: automatic index creation, dynamic mapping updates, waiting operations: automatic index creation, dynamic mapping updates, waiting
for active shards. for active shards.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -432,22 +432,22 @@ class AsyncOpenSearch(Client):
:arg if_seq_no: Only perform the operation if the document has :arg if_seq_no: Only perform the operation if the document has
this sequence number. this sequence number.
:arg op_type: Set to create to only index the document if it :arg op_type: Set to create to only index the document if it
does not already exist (put if absent).If a document with the specified does not already exist (put if absent). If a document with the specified
`_id` already exists, the indexing operation will fail.Same as using the `_id` already exists, the indexing operation will fail. Same as using
`<index>/_create` endpoint.Valid values: `index`, `create`.If document the `<index>/_create` endpoint. Valid values: `index`, `create`. If
id is specified, it defaults to `index`.Otherwise, it defaults to document id is specified, it defaults to `index`. Otherwise, it defaults
`create`. to `create`.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg require_alias: If `true`, the destination must be an index :arg require_alias: If `true`, the destination must be an index
alias. Default is false. alias. Default is false.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -457,14 +457,14 @@ class AsyncOpenSearch(Client):
:arg timeout: Period the request waits for the following :arg timeout: Period the request waits for the following
operations: automatic index creation, dynamic mapping updates, waiting operations: automatic index creation, dynamic mapping updates, waiting
for active shards. for active shards.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -524,16 +524,16 @@ class AsyncOpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg require_alias: If `true`, the request's actions must target :arg require_alias: If `true`, the request's actions must target
an index alias. Default is false. an index alias. Default is false.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -544,7 +544,7 @@ class AsyncOpenSearch(Client):
operations: automatic index creation, dynamic mapping updates, waiting operations: automatic index creation, dynamic mapping updates, waiting
for active shards. for active shards.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -637,25 +637,25 @@ class AsyncOpenSearch(Client):
and indices, omit this parameter or use `*` or `_all`. and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
are analyzed.This parameter can only be used when the `q` query string are analyzed. This parameter can only be used when the `q` query string
parameter is specified. Default is false. parameter is specified. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the `q` query string parameter is parameter can only be used when the `q` query string parameter is
specified. specified.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
query: `AND` or `OR`.This parameter can only be used when the `q` query query: `AND` or `OR`. This parameter can only be used when the `q` query
string parameter is specified. Valid choices are and, or. string parameter is specified. Valid choices are and, or.
:arg df: Field to use as default where no field prefix is given :arg df: Field to use as default where no field prefix is given
in the query string.This parameter can only be used when the `q` query in the query string. This parameter can only be used when the `q` query
string parameter is specified. string parameter is specified.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -671,7 +671,7 @@ class AsyncOpenSearch(Client):
:arg min_score: Sets the minimum `_score` value that documents :arg min_score: Sets the minimum `_score` value that documents
must have to be included in the result. must have to be included in the result.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
@@ -680,8 +680,8 @@ class AsyncOpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting. query early. OpenSearch collects documents before sorting.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
"POST", "POST",
@@ -734,20 +734,20 @@ class AsyncOpenSearch(Client):
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for active shards. :arg timeout: Period to wait for active shards.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -822,8 +822,8 @@ class AsyncOpenSearch(Client):
the _source field. the _source field.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
@@ -838,8 +838,8 @@ class AsyncOpenSearch(Client):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid values are: `all`, separated values, such as `open,hidden`. Valid values are: `all`,
`open`, `closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -851,17 +851,17 @@ class AsyncOpenSearch(Client):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be ignored. providing text to a numeric field) in the query string will be ignored.
:arg max_docs: Maximum number of documents to process.Defaults :arg max_docs: Maximum number of documents to process. Defaults
to all documents. to all documents.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
:arg refresh: If `true`, OpenSearch refreshes all shards :arg refresh: If `true`, OpenSearch refreshes all shards
involved in the delete by query after the request completes. involved in the delete by query after the request completes.
:arg request_cache: If `true`, the request cache is used for :arg request_cache: If `true`, the request cache is used for
this request.Defaults to the index-level setting. this request. Defaults to the index-level setting.
:arg requests_per_second: The throttle for this request in sub- :arg requests_per_second: The throttle for this request in sub-
requests per second. Default is 0. requests per second. Default is 0.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -869,9 +869,9 @@ class AsyncOpenSearch(Client):
:arg scroll: Period to retain the search context for scrolling. :arg scroll: Period to retain the search context for scrolling.
:arg scroll_size: Size of the scroll request that powers the :arg scroll_size: Size of the scroll request that powers the
operation. Default is 100. operation. Default is 100.
:arg search_timeout: Explicit timeout for each search :arg search_timeout: Explicit timeout for each search request.
request.Defaults to no timeout. Defaults to no timeout.
:arg search_type: The type of the search operation.Available :arg search_type: The type of the search operation. Available
options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are
dfs_query_then_fetch, query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg size: Deprecated, please use `max_docs` instead. :arg size: Deprecated, please use `max_docs` instead.
@@ -883,18 +883,18 @@ class AsyncOpenSearch(Client):
:arg stats: Specific `tag` of the request for logging and :arg stats: Specific `tag` of the request for logging and
statistical purposes. statistical purposes.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting.Use with query early. OpenSearch collects documents before sorting. Use with
caution.OpenSearch applies this parameter to each shard handling the caution. OpenSearch applies this parameter to each shard handling the
request.When possible, let OpenSearch perform early termination request. When possible, let OpenSearch perform early termination
automatically.Avoid specifying this parameter for requests that target automatically. Avoid specifying this parameter for requests that target
data streams with backing indices across multiple data tiers. data streams with backing indices across multiple data tiers.
:arg timeout: Period each deletion request waits for active :arg timeout: Period each deletion request waits for active
shards. shards.
:arg version: If `true`, returns the document version as part of :arg version: If `true`, returns the document version as part of
a hit. a hit.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
@@ -985,13 +985,13 @@ class AsyncOpenSearch(Client):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1046,7 +1046,7 @@ class AsyncOpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If `true`, the request is real-time as opposed to :arg realtime: If `true`, the request is real-time as opposed to
@@ -1057,12 +1057,12 @@ class AsyncOpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg stored_fields: List of stored fields to return as part of a :arg stored_fields: List of stored fields to return as part of a
hit.If no fields are specified, no stored fields are included in the hit. If no fields are specified, no stored fields are included in the
response.If this field is specified, the `_source` parameter defaults to response. If this field is specified, the `_source` parameter defaults
false. to false.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
@@ -1118,7 +1118,7 @@ class AsyncOpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If true, the request is real-time as opposed to :arg realtime: If true, the request is real-time as opposed to
@@ -1128,9 +1128,9 @@ class AsyncOpenSearch(Client):
:arg routing: Target the specified primary shard. :arg routing: Target the specified primary shard.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
@@ -1188,7 +1188,7 @@ class AsyncOpenSearch(Client):
to include in the response. to include in the response.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
are analyzed. Default is false. are analyzed. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the `q` query string parameter is parameter can only be used when the `q` query string parameter is
specified. specified.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
@@ -1204,7 +1204,7 @@ class AsyncOpenSearch(Client):
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be ignored. providing text to a numeric field) in the query string will be ignored.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
@@ -1254,9 +1254,9 @@ class AsyncOpenSearch(Client):
aliases used to limit the request. Supports wildcards (*). To target all 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 indices, omit this parameter or use * or _all.
:arg allow_no_indices: If false, the request returns an error if :arg allow_no_indices: If false, the request returns an error if
any wildcard expression, index alias,or `_all` value targets only any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. For example, a requesttargeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with foo but no index starts with returns an error if an index starts with foo but no index starts with
bar. bar.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
@@ -1344,9 +1344,9 @@ class AsyncOpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg stored_fields: List of stored fields to return as part of a :arg stored_fields: List of stored fields to return as part of a
hit.If no fields are specified, no stored fields are included in the hit. If no fields are specified, no stored fields are included in the
response.If this field is specified, the `_source` parameter defaults to response. If this field is specified, the `_source` parameter defaults
false. to false.
:arg version: Explicit version number for concurrency control. :arg version: Explicit version number for concurrency control.
The specified version must match the current version of the document for The specified version must match the current version of the document for
the request to succeed. the request to succeed.
@@ -1508,12 +1508,12 @@ class AsyncOpenSearch(Client):
:arg _source: True or false to return the `_source` field or :arg _source: True or false to return the `_source` field or
not, or a list of fields to return. not, or a list of fields to return.
:arg _source_excludes: A comma-separated list of source fields :arg _source_excludes: A comma-separated list of source fields
to exclude from the response.You can also use this parameter to exclude to exclude from the response. You can also use this parameter to exclude
fields from the subset specified in `_source_includes` query parameter. fields from the subset specified in `_source_includes` query parameter.
:arg _source_includes: A comma-separated list of source fields :arg _source_includes: A comma-separated list of source fields
to include in the response.If this parameter is specified, only these to include in the response. If this parameter is specified, only these
source fields are returned. You can exclude fields from this subset source fields are returned. You can exclude fields from this subset
using the `_source_excludes` query parameter.If the `_source` parameter using the `_source_excludes` query parameter. If the `_source` parameter
is `false`, this parameter is ignored. is `false`, this parameter is ignored.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
@@ -1663,9 +1663,9 @@ class AsyncOpenSearch(Client):
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg rest_total_hits_as_int: If `true`, the response returns :arg rest_total_hits_as_int: If `true`, the response returns
`hits.total` as an integer.If `false`, it returns `hits.total` as an `hits.total` as an integer. If `false`, it returns `hits.total` as an
object. Default is false. object. Default is false.
:arg search_type: The type of the search operation.Available :arg search_type: The type of the search operation. Available
options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are
dfs_query_then_fetch, query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1725,7 +1725,7 @@ class AsyncOpenSearch(Client):
document count, sum of document frequencies, and sum of total term document count, sum of document frequencies, and sum of total term
frequencies. Default is True. frequencies. Default is True.
:arg fields: Comma-separated list or wildcard expressions of :arg fields: Comma-separated list or wildcard expressions of
fields to include in the statistics.Used as the default list unless a fields to include in the statistics. Used as the default list unless a
specific field list is provided in the `completion_fields` or specific field list is provided in the `completion_fields` or
`fielddata_fields` parameters. `fielddata_fields` parameters.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1741,7 +1741,7 @@ class AsyncOpenSearch(Client):
:arg positions: If `true`, the response includes term positions. :arg positions: If `true`, the response includes term positions.
Default is True. Default is True.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If true, the request is real-time as opposed to :arg realtime: If true, the request is real-time as opposed to
@@ -1801,13 +1801,13 @@ class AsyncOpenSearch(Client):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1928,18 +1928,18 @@ class AsyncOpenSearch(Client):
:arg refresh: If `true`, the request refreshes affected shards :arg refresh: If `true`, the request refreshes affected shards
to make this operation visible to search. to make this operation visible to search.
:arg requests_per_second: The throttle for this request in sub- :arg requests_per_second: The throttle for this request in sub-
requests per second.Defaults to no throttle. Default is 0. requests per second. Defaults to no throttle. Default is 0.
:arg scroll: Specifies how long a consistent view of the index :arg scroll: Specifies how long a consistent view of the index
should be maintained for scrolled search. should be maintained for scrolled search.
:arg slices: The number of slices this task should be divided :arg slices: The number of slices this task should be divided
into.Defaults to 1 slice, meaning the task isn't sliced into subtasks. into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.
Valid choices are auto. Valid choices are auto.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period each indexing waits for automatic index :arg timeout: Period each indexing waits for automatic index
creation, dynamic mapping updates, and waiting for active shards. creation, dynamic mapping updates, and waiting for active shards.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
@@ -2173,70 +2173,69 @@ class AsyncOpenSearch(Client):
aliases to search. Supports wildcards (`*`). To search all data streams aliases to search. Supports wildcards (`*`). To search all data streams
and indices, omit this parameter or use `*` or `_all`. and indices, omit this parameter or use `*` or `_all`.
:arg _source: Indicates which source fields are returned for :arg _source: Indicates which source fields are returned for
matching documents.These fields are returned in the `hits._source` matching documents. These fields are returned in the `hits._source`
property of the search response.Valid values are:`true` to return the property of the search response. Valid values are: `true` to return the
entire document source;`false` to not return the document entire document source; `false` to not return the document source;
source;`<string>` to return the source fields that are specified as a `<string>` to return the source fields that are specified as a comma-
comma-separated list (supports wildcard (`*`) patterns). separated list (supports wildcard (`*`) patterns).
:arg _source_excludes: A comma-separated list of source fields :arg _source_excludes: A comma-separated list of source fields
to exclude from the response.You can also use this parameter to exclude to exclude from the response. You can also use this parameter to exclude
fields from the subset specified in `_source_includes` query fields from the subset specified in `_source_includes` query parameter.
parameter.If the `_source` parameter is `false`, this parameter is If the `_source` parameter is `false`, this parameter is ignored.
ignored.
:arg _source_includes: A comma-separated list of source fields :arg _source_includes: A comma-separated list of source fields
to include in the response.If this parameter is specified, only these to include in the response. If this parameter is specified, only these
source fields are returned.You can exclude fields from this subset using source fields are returned. You can exclude fields from this subset
the `_source_excludes` query parameter.If the `_source` parameter is using the `_source_excludes` query parameter. If the `_source` parameter
`false`, this parameter is ignored. is `false`, this parameter is ignored.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg allow_partial_search_results: If true, returns partial :arg allow_partial_search_results: If true, returns partial
results if there are shard request timeouts or shard failures. If false, results if there are shard request timeouts or shard failures. If false,
returns an error with no partial results. Default is True. returns an error with no partial results. Default is True.
:arg analyze_wildcard: If true, wildcard and prefix queries are :arg analyze_wildcard: If true, wildcard and prefix queries are
analyzed.This parameter can only be used when the q query string analyzed. This parameter can only be used when the q query string
parameter is specified. Default is false. parameter is specified. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the q query string parameter is parameter can only be used when the q query string parameter is
specified. specified.
:arg batched_reduce_size: The number of shard results that :arg batched_reduce_size: The number of shard results that
should be reduced at once on the coordinating node.This value should be should be reduced at once on the coordinating node. This value should be
used as a protection mechanism to reduce the memory overhead per search used as a protection mechanism to reduce the memory overhead per search
request if the potential number of shards in the request can be large. request if the potential number of shards in the request can be large.
Default is 512. Default is 512.
:arg cancel_after_time_interval: The time after which the search :arg cancel_after_time_interval: The time after which the search
request will be canceled.Request-level parameter takes precedence over request will be canceled. Request-level parameter takes precedence over
`cancel_after_time_interval` cluster setting. `cancel_after_time_interval` cluster setting.
:arg ccs_minimize_roundtrips: If true, network round-trips :arg ccs_minimize_roundtrips: If true, network round-trips
between the coordinating node and the remote clusters are minimized when between the coordinating node and the remote clusters are minimized when
executing cross-cluster search (CCS) requests. Default is True. executing cross-cluster search (CCS) requests. Default is True.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
query: AND or OR.This parameter can only be used when the `q` query query: AND or OR. This parameter can only be used when the `q` query
string parameter is specified. Valid choices are and, or. string parameter is specified. Valid choices are and, or.
:arg df: Field to use as default where no field prefix is given :arg df: Field to use as default where no field prefix is given
in the query string.This parameter can only be used when the q query in the query string. This parameter can only be used when the q query
string parameter is specified. string parameter is specified.
:arg docvalue_fields: A comma-separated list of fields to return :arg docvalue_fields: A comma-separated list of fields to return
as the docvalue representation for each hit. as the docvalue representation for each hit.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg explain: If `true`, returns detailed information about :arg explain: If `true`, returns detailed information about
score computation as part of a hit. score computation as part of a hit.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg from_: Starting document offset.Needs to be non-negative.By :arg from_: Starting document offset. Needs to be non-negative.
default, you cannot page through more than 10,000 hits using the `from` By default, you cannot page through more than 10,000 hits using the
and `size` parameters.To page through more hits, use the `search_after` `from` and `size` parameters. To page through more hits, use the
parameter. Default is 0. `search_after` parameter. Default is 0.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg ignore_throttled: If `true`, concrete, expanded or aliased :arg ignore_throttled: If `true`, concrete, expanded or aliased
@@ -2248,50 +2247,50 @@ class AsyncOpenSearch(Client):
of the matched query associated with its score (true) or as an array of the matched query associated with its score (true) or as an array
containing the name of the matched queries (false) Default is false. containing the name of the matched queries (false) Default is false.
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be providing text to a numeric field) in the query string will be ignored.
ignored.This parameter can only be used when the `q` query string This parameter can only be used when the `q` query string parameter is
parameter is specified. specified.
:arg max_concurrent_shard_requests: Defines the number of :arg max_concurrent_shard_requests: Defines the number of
concurrent shard requests per node this search executes concurrent shard requests per node this search executes concurrently.
concurrently.This value should be used to limit the impact of the search This value should be used to limit the impact of the search on the
on the cluster in order to limit the number of concurrent shard cluster in order to limit the number of concurrent shard requests.
requests. Default is 5. Default is 5.
:arg phase_took: Indicates whether to return phase-level `took` :arg phase_took: Indicates whether to return phase-level `took`
time values in the response. Default is false. time values in the response. Default is false.
:arg pre_filter_shard_size: Defines a threshold that enforces a :arg pre_filter_shard_size: Defines a threshold that enforces a
pre-filter roundtrip to prefilter search shards based on query rewriting pre-filter roundtrip to prefilter search shards based on query rewriting
if the number of shards the search request expands to exceeds the if the number of shards the search request expands to exceeds the
threshold.This filter roundtrip can limit the number of shards threshold. This filter roundtrip can limit the number of shards
significantly if for instance a shard can not match any documents based significantly if for instance a shard can not match any documents based
on its rewrite method (if date filters are mandatory to match but the on its rewrite method (if date filters are mandatory to match but the
shard bounds and the query are disjoint).When unspecified, the pre- shard bounds and the query are disjoint). When unspecified, the pre-
filter phase is executed if any of these conditions is met:the request filter phase is executed if any of these conditions is met: the request
targets more than 128 shards;the request targets one or more read-only targets more than 128 shards; the request targets one or more read-only
index;the primary sort of the query targets an indexed field. index; the primary sort of the query targets an indexed field.
:arg preference: Nodes and shards used for the search.By :arg preference: Nodes and shards used for the search. By
default, OpenSearch selects from eligible nodes and shards using default, OpenSearch selects from eligible nodes and shards using
adaptive replica selection, accounting for allocation awareness. Valid adaptive replica selection, accounting for allocation awareness. Valid
values are:`_only_local` to run the search only on shards on the local values are: `_only_local` to run the search only on shards on the local
node;`_local` to, if possible, run the search on shards on the local node; `_local` to, if possible, run the search on shards on the local
node, or if not, select shards using the default node, or if not, select shards using the default method;
method;`_only_nodes:<node-id>,<node-id>` to run the search on only the `_only_nodes:<node-id>,<node-id>` to run the search on only the
specified nodes IDs, where, if suitable shards exist on more than one specified nodes IDs, where, if suitable shards exist on more than one
selected node, use shards on those nodes using the default method, or if selected node, use shards on those nodes using the default method, or if
none of the specified nodes are available, select shards from any none of the specified nodes are available, select shards from any
available node using the default method;`_prefer_nodes:<node-id>,<node- available node using the default method; `_prefer_nodes:<node-id>,<node-
id>` to if possible, run the search on the specified nodes IDs, or if id>` to if possible, run the search on the specified nodes IDs, or if
not, select shards using the default method;`_shards:<shard>,<shard>` to not, select shards using the default method; `_shards:<shard>,<shard>`
run the search only on the specified shards;`<custom-string>` (any to run the search only on the specified shards; `<custom-string>` (any
string that does not start with `_`) to route searches with the same string that does not start with `_`) to route searches with the same
`<custom-string>` to the same shards in the same order. Default is `<custom-string>` to the same shards in the same order. Default is
random. random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax using query :arg q: Query in the Lucene query string syntax using query
parameter search.Query parameter searches do not support the full parameter search. Query parameter searches do not support the full
OpenSearch Query DSL but are handy for testing. OpenSearch Query DSL but are handy for testing.
:arg request_cache: If `true`, the caching of search results is :arg request_cache: If `true`, the caching of search results is
enabled for requests where `size` is `0`.Defaults to index level enabled for requests where `size` is `0`. Defaults to index level
settings. settings.
:arg rest_total_hits_as_int: Indicates whether `hits.total` :arg rest_total_hits_as_int: Indicates whether `hits.total`
should be rendered as an integer or an object in the rest search should be rendered as an integer or an object in the rest search
@@ -2299,8 +2298,8 @@ class AsyncOpenSearch(Client):
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg scroll: Period to retain the search context for scrolling. :arg scroll: Period to retain the search context for scrolling.
See Scroll search results.By default, this value cannot exceed `1d` (24 See Scroll search results. By default, this value cannot exceed `1d` (24
hours).You can change this limit using the `search.max_keep_alive` hours). You can change this limit using the `search.max_keep_alive`
cluster-level setting. cluster-level setting.
:arg search_pipeline: Customizable sequence of processing stages :arg search_pipeline: Customizable sequence of processing stages
applied to search queries. applied to search queries.
@@ -2309,9 +2308,9 @@ class AsyncOpenSearch(Client):
dfs_query_then_fetch, query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg seq_no_primary_term: If `true`, returns sequence number and :arg seq_no_primary_term: If `true`, returns sequence number and
primary term of the last modification of each hit. primary term of the last modification of each hit.
:arg size: Defines the number of hits to return.By default, you :arg size: Defines the number of hits to return. By default, you
cannot page through more than 10,000 hits using the `from` and `size` cannot page through more than 10,000 hits using the `from` and `size`
parameters.To page through more hits, use the `search_after` parameter. parameters. To page through more hits, use the `search_after` parameter.
Default is 10. Default is 10.
:arg sort: A comma-separated list of <field>:<direction> pairs. :arg sort: A comma-separated list of <field>:<direction> pairs.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -2319,38 +2318,39 @@ class AsyncOpenSearch(Client):
:arg stats: Specific `tag` of the request for logging and :arg stats: Specific `tag` of the request for logging and
statistical purposes. statistical purposes.
:arg stored_fields: A comma-separated list of stored fields to :arg stored_fields: A comma-separated list of stored fields to
return as part of a hit.If no fields are specified, no stored fields are return as part of a hit. If no fields are specified, no stored fields
included in the response.If this field is specified, the `_source` are included in the response. If this field is specified, the `_source`
parameter defaults to `false`.You can pass `_source: true` to return parameter defaults to `false`. You can pass `_source: true` to return
both source fields and stored fields in the search response. both source fields and stored fields in the search response.
:arg suggest_field: Specifies which field to use for :arg suggest_field: Specifies which field to use for
suggestions. suggestions.
:arg suggest_mode: Specifies the suggest mode.This parameter can :arg suggest_mode: Specifies the suggest mode. This parameter
only be used when the `suggest_field` and `suggest_text` query string can only be used when the `suggest_field` and `suggest_text` query
parameters are specified. Valid choices are always, missing, popular. string parameters are specified. Valid choices are always, missing,
:arg suggest_size: Number of suggestions to return.This popular.
:arg suggest_size: Number of suggestions to return. This
parameter can only be used when the `suggest_field` and `suggest_text` parameter can only be used when the `suggest_field` and `suggest_text`
query string parameters are specified. query string parameters are specified.
:arg suggest_text: The source text for which the suggestions :arg suggest_text: The source text for which the suggestions
should be returned.This parameter can only be used when the should be returned. This parameter can only be used when the
`suggest_field` and `suggest_text` query string parameters are `suggest_field` and `suggest_text` query string parameters are
specified. specified.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting.Use with query early. OpenSearch collects documents before sorting. Use with
caution.OpenSearch applies this parameter to each shard handling the caution. OpenSearch applies this parameter to each shard handling the
request.When possible, let OpenSearch perform early termination request. When possible, let OpenSearch perform early termination
automatically.Avoid specifying this parameter for requests that target 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 indices across multiple data tiers. If set to
`0` (default), the query does not terminate early. `0` (default), the query does not terminate early.
:arg timeout: Specifies the period of time to wait for a :arg timeout: Specifies the period of time to wait for a
response from each shard.If no response is received before the timeout response from each shard. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg track_scores: If `true`, calculate and return document :arg track_scores: If `true`, calculate and return document
scores, even if the scores are not used for sorting. scores, even if the scores are not used for sorting.
:arg track_total_hits: Number of hits matching the query to :arg track_total_hits: Number of hits matching the query to
count accurately.If `true`, the exact number of hits is returned at the count accurately. If `true`, the exact number of hits is returned at the
cost of some performance.If `false`, the response does not include the cost of some performance. If `false`, the response does not include the
total number of hits matching the query. total number of hits matching the query.
:arg typed_keys: If `true`, aggregation and suggester names are :arg typed_keys: If `true`, aggregation and suggester names are
be prefixed by their respective types in the response. be prefixed by their respective types in the response.
@@ -2397,17 +2397,17 @@ class AsyncOpenSearch(Client):
would be executed against. would be executed against.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -2417,7 +2417,7 @@ class AsyncOpenSearch(Client):
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. Default is false. the local node only. Default is false.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -2465,8 +2465,8 @@ class AsyncOpenSearch(Client):
aliases to search. Supports wildcards (*). aliases to search. Supports wildcards (*).
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg ccs_minimize_roundtrips: If `true`, network round-trips are :arg ccs_minimize_roundtrips: If `true`, network round-trips are
@@ -2474,10 +2474,10 @@ class AsyncOpenSearch(Client):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg explain: If `true`, the response includes additional :arg explain: If `true`, the response includes additional
details about score computation as part of a hit. details about score computation as part of a hit.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2489,7 +2489,7 @@ class AsyncOpenSearch(Client):
:arg ignore_unavailable: If `false`, the request returns an :arg ignore_unavailable: If `false`, the request returns an
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg profile: If `true`, the query execution is profiled. :arg profile: If `true`, the query execution is profiled.
@@ -2497,8 +2497,8 @@ class AsyncOpenSearch(Client):
an integer in the response. Default is false. an integer in the response. Default is false.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg scroll: Specifies how long a consistent view of the :arg scroll: Specifies how long a consistent view of the index
indexshould be maintained for scrolled search. should be maintained for scrolled search.
:arg search_type: The type of the search operation. Valid :arg search_type: The type of the search operation. Valid
choices are dfs_query_then_fetch, query_then_fetch. choices are dfs_query_then_fetch, query_then_fetch.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -2558,7 +2558,7 @@ class AsyncOpenSearch(Client):
document count, sum of document frequencies, and sum of total term document count, sum of document frequencies, and sum of total term
frequencies. Default is True. frequencies. Default is True.
:arg fields: Comma-separated list or wildcard expressions of :arg fields: Comma-separated list or wildcard expressions of
fields to include in the statistics.Used as the default list unless a fields to include in the statistics. Used as the default list unless a
specific field list is provided in the `completion_fields` or specific field list is provided in the `completion_fields` or
`fielddata_fields` parameters. `fielddata_fields` parameters.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2572,7 +2572,7 @@ class AsyncOpenSearch(Client):
:arg positions: If `true`, the response includes term positions. :arg positions: If `true`, the response includes term positions.
Default is True. Default is True.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If true, the request is real-time as opposed to :arg realtime: If true, the request is real-time as opposed to
@@ -2633,7 +2633,7 @@ class AsyncOpenSearch(Client):
:arg body: The request definition requires either `script` or :arg body: The request definition requires either `script` or
partial `doc` partial `doc`
:arg _source: Set to false to disable source retrieval. You can :arg _source: Set to false to disable source retrieval. You can
also specify a comma-separatedlist of the fields you want to retrieve. also specify a comma-separated list of the fields you want to retrieve.
:arg _source_excludes: Specify the source fields you want to :arg _source_excludes: Specify the source fields you want to
exclude. exclude.
:arg _source_includes: Specify the source fields you want to :arg _source_includes: Specify the source fields you want to
@@ -2652,8 +2652,8 @@ class AsyncOpenSearch(Client):
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If 'true', OpenSearch refreshes the affected :arg refresh: If 'true', OpenSearch refreshes the affected
shards to make this operationvisible to search, if 'wait_for' then wait shards to make this operation visible to search, if 'wait_for' then wait
for a refresh to make this operationvisible to search, if 'false' do for a refresh to make this operation visible to search, if 'false' do
nothing with refreshes. Valid choices are false, true, wait_for. nothing with refreshes. Valid choices are false, true, wait_for.
:arg require_alias: If true, the destination must be an index :arg require_alias: If true, the destination must be an index
alias. Default is false. alias. Default is false.
@@ -2664,14 +2664,14 @@ class AsyncOpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for dynamic mapping updates and :arg timeout: Period to wait for dynamic mapping updates and
active shards.This guarantees OpenSearch waits for at least the timeout active shards. This guarantees OpenSearch waits for at least the timeout
before failing.The actual wait time could be longer, particularly when before failing. The actual wait time could be longer, particularly when
multiple waits occur. multiple waits occur.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operations.Set to 'all' or any must be active before proceeding with the operations. Set to 'all' or
positive integer up to the total number of shards in the any positive integer up to the total number of shards in the index
index(number_of_replicas+1). Defaults to 1 meaning the primary shard. (number_of_replicas+1). Defaults to 1 meaning the primary shard. Valid
Valid choices are all, index-setting. choices are all, index-setting.
""" """
for param in (index, id, body): for param in (index, id, body):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -2748,8 +2748,8 @@ class AsyncOpenSearch(Client):
the _source field. the _source field.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
@@ -2764,10 +2764,10 @@ class AsyncOpenSearch(Client):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg from_: Starting offset. Default is 0. :arg from_: Starting offset. Default is 0.
@@ -2777,15 +2777,15 @@ class AsyncOpenSearch(Client):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be ignored. providing text to a numeric field) in the query string will be ignored.
:arg max_docs: Maximum number of documents to process.Defaults :arg max_docs: Maximum number of documents to process. Defaults
to all documents. to all documents.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
@@ -2813,18 +2813,18 @@ class AsyncOpenSearch(Client):
:arg stats: Specific `tag` of the request for logging and :arg stats: Specific `tag` of the request for logging and
statistical purposes. statistical purposes.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting.Use with query early. OpenSearch collects documents before sorting. Use with
caution.OpenSearch applies this parameter to each shard handling the caution. OpenSearch applies this parameter to each shard handling the
request.When possible, let OpenSearch perform early termination request. When possible, let OpenSearch perform early termination
automatically.Avoid specifying this parameter for requests that target automatically. Avoid specifying this parameter for requests that target
data streams with backing indices across multiple data tiers. data streams with backing indices across multiple data tiers.
:arg timeout: Period each update request waits for the following :arg timeout: Period each update request waits for the following
operations: dynamic mapping updates, waiting for active shards. operations: dynamic mapping updates, waiting for active shards.
:arg version: If `true`, returns the document version as part of :arg version: If `true`, returns the document version as part of
a hit. a hit.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
opensearchpy/_async/client/cluster.py
+29 -29
View File
@@ -164,11 +164,11 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only.If `false`, information is retrieved from the master the local node only. If `false`, information is retrieved from the
node. Default is false. master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -285,9 +285,9 @@ class ClusterClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg timeout: Period to wait for each node to respond. If a node
does not respond before its timeout expires, the response does not does not respond before its timeout expires, the response does not
include its stats.However, timed out nodes are included in the include its stats. However, timed out nodes are included in the
response's `_nodes.failed` property. Defaults to no timeout. response's `_nodes.failed` property. Defaults to no timeout.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -394,13 +394,13 @@ class ClusterClient(NamespacedClient):
settings from the local node. Default is false. settings from the local node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -558,13 +558,13 @@ class ClusterClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -609,11 +609,11 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only.If `false`, information is retrieved from the master the local node only. If `false`, information is retrieved from the
node. Default is false. master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -672,7 +672,7 @@ class ClusterClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -723,12 +723,12 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg local: If true, the request retrieves information from the :arg local: If true, the request retrieves information from the
local node only.Defaults to false, which means information is retrieved local node only. Defaults to false, which means information is retrieved
from the master node. Default is false. from the master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response isreceived before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns anerror. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -767,12 +767,12 @@ class ClusterClient(NamespacedClient):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_removal: Specifies whether to wait for all :arg wait_for_removal: Specifies whether to wait for all
excluded nodes to be removed from thecluster before clearing the voting excluded nodes to be removed from the cluster before clearing the voting
configuration exclusions list.Defaults to true, meaning that all configuration exclusions list. Defaults to true, meaning that all
excluded nodes must be removed fromthe cluster before this API takes any excluded nodes must be removed from the cluster before this API takes
action. If set to false then thevoting configuration exclusions list is any action. If set to false then the voting configuration exclusions
cleared even if some excludednodes are still in the cluster. Default is list is cleared even if some excluded nodes are still in the cluster.
True. Default is True.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
"DELETE", "DELETE",
@@ -807,19 +807,19 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg node_ids: A comma-separated list of the persistent ids of :arg node_ids: A comma-separated list of the persistent ids of
the nodes to excludefrom the voting configuration. If specified, you may the nodes to exclude from the voting configuration. If specified, you
not also specify node_names. may not also specify node_names.
:arg node_names: A comma-separated list of the names of the :arg node_names: A comma-separated list of the names of the
nodes to exclude from thevoting configuration. If specified, you may not nodes to exclude from the voting configuration. If specified, you may
also specify node_ids. not also specify node_ids.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: When adding a voting configuration exclusion, the :arg timeout: When adding a voting configuration exclusion, the
API waits for thespecified nodes to be excluded from the voting API waits for the specified nodes to be excluded from the voting
configuration beforereturning. If the timeout expires before the configuration before returning. If the timeout expires before the
appropriate conditionis satisfied, the request fails and returns an appropriate condition is satisfied, the request fails and returns an
error. error.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
opensearchpy/_async/client/indices.py
+159 -159
View File
@@ -100,15 +100,15 @@ class IndicesClient(NamespacedClient):
all data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -151,15 +151,15 @@ class IndicesClient(NamespacedClient):
and indices, omit this parameter or use `*` or `_all`. and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg force: If `true`, the request forces a flush even if there :arg force: If `true`, the request forces a flush even if there
@@ -173,7 +173,7 @@ class IndicesClient(NamespacedClient):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_if_ongoing: If `true`, the flush operation blocks :arg wait_if_ongoing: If `true`, the flush operation blocks
until execution when another flush operation is running.If `false`, until execution when another flush operation is running. If `false`,
OpenSearch returns an error if you request a flush when another flush OpenSearch returns an error if you request a flush when another flush
operation is running. Default is True. operation is running. Default is True.
""" """
@@ -216,18 +216,18 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation. Set to `all` or any must be active before proceeding with the operation. Set to `all` or
positive integer up to the total number of shards in the index any positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
if index in SKIP_IN_PATH: if index in SKIP_IN_PATH:
@@ -276,7 +276,7 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -284,11 +284,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -335,20 +335,20 @@ class IndicesClient(NamespacedClient):
index aliases used to limit the request. Wildcard expressions (*) are index aliases used to limit the request. Wildcard expressions (*) are
supported. supported.
:arg allow_no_indices: If false, the request returns an error if :arg allow_no_indices: If false, the request returns an error if
any wildcard expression, index alias, or _all value targets onlymissing any wildcard expression, index alias, or _all value targets only missing
or closed indices. This behavior applies even if the request targets or closed indices. This behavior applies even if the request targets
other open indices. For example,a request targeting foo*,bar* returns an other open indices. For example, a request targeting foo*,bar* returns
error if an index starts with foo but no index starts with bar. Default an error if an index starts with foo but no index starts with bar.
is false. Default is false.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard expressions :arg expand_wildcards: Type of index that wildcard expressions
can match. If the request can target data streams, this can match. If the request can target data streams, this argument
argumentdetermines whether wildcard expressions match hidden data determines whether wildcard expressions match hidden data streams.
streams. Supports comma-separated values,such as open,hidden. Valid Supports comma-separated values, such as open,hidden. Valid choices are
choices are all, closed, hidden, none, open. all, closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg flat_settings: If true, returns settings in flat format. :arg flat_settings: If true, returns settings in flat format.
@@ -413,17 +413,17 @@ class IndicesClient(NamespacedClient):
settings API. settings API.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -432,7 +432,7 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -440,11 +440,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -485,17 +485,17 @@ class IndicesClient(NamespacedClient):
names used to limit the request. names used to limit the request.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -504,17 +504,17 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -554,17 +554,17 @@ class IndicesClient(NamespacedClient):
`action.destructive_requires_name` cluster setting to `false`. `action.destructive_requires_name` cluster setting to `false`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. Default is false. targets other open indices. Default is false.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -573,13 +573,13 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. Default is false. error if it targets a missing or closed index. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -618,17 +618,17 @@ class IndicesClient(NamespacedClient):
aliases. Supports wildcards (`*`). aliases. Supports wildcards (`*`).
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. Default is false. targets other open indices. Default is false.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg flat_settings: If `true`, returns settings in flat format. :arg flat_settings: If `true`, returns settings in flat format.
@@ -683,17 +683,17 @@ class IndicesClient(NamespacedClient):
string to perform the operation on all indices. string to perform the operation on all indices.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -702,13 +702,13 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg write_index_only: If `true`, the mappings are applied only :arg write_index_only: If `true`, the mappings are applied only
@@ -752,21 +752,21 @@ class IndicesClient(NamespacedClient):
:arg index: Comma-separated list of data streams, indices, and :arg index: Comma-separated list of data streams, indices, and
aliases used to limit the request.Supports wildcards (`*`).To target all aliases used to limit the request. Supports wildcards (`*`). To target
data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -777,7 +777,7 @@ class IndicesClient(NamespacedClient):
the local node only. Default is false. the local node only. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -818,15 +818,15 @@ class IndicesClient(NamespacedClient):
all data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -891,13 +891,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -938,15 +938,15 @@ class IndicesClient(NamespacedClient):
streams and indices, omit this parameter or use `*` or `_all`. streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -998,15 +998,15 @@ class IndicesClient(NamespacedClient):
or `_all`. or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1055,13 +1055,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1107,13 +1107,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1161,11 +1161,11 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response isreceived before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg order: Order in which OpenSearch applies this template if :arg order: Order in which OpenSearch applies this template if
indexmatches multiple templates.Templates with lower 'order' values are index matches multiple templates. Templates with lower 'order' values
merged first. Templates with higher'order' values are merged later, are merged first. Templates with higher 'order' values are merged later,
overriding templates with lower values. overriding templates with lower values.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -1272,7 +1272,7 @@ class IndicesClient(NamespacedClient):
the local node only. Default is false. the local node only. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -1315,13 +1315,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1364,18 +1364,18 @@ class IndicesClient(NamespacedClient):
:arg name: Comma-separated list or wildcard expression of :arg name: Comma-separated list or wildcard expression of
settings to retrieve. settings to retrieve.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, indexalias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. Thisbehavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. Forexample, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an indexstarts with foo but no index starts with returns an error if an index starts with foo but no index starts with
`bar`. `bar`.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1389,12 +1389,12 @@ class IndicesClient(NamespacedClient):
:arg include_defaults: If `true`, return all default settings in :arg include_defaults: If `true`, return all default settings in
the response. Default is false. the response. Default is false.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. If`false`, information is retrieved from the master the local node only. If `false`, information is retrieved from the
node. Default is false. master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response isreceived before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns anerror. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1434,19 +1434,19 @@ class IndicesClient(NamespacedClient):
aliases used to limit the request. Supports wildcards (`*`). To target 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 indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, indexalias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. Thisbehavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. Forexample, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an indexstarts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match. If the request can targetdata streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions matchhidden data streams. Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as`open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
@@ -1458,8 +1458,8 @@ class IndicesClient(NamespacedClient):
should be ignored when unavailable (missing or closed). should be ignored when unavailable (missing or closed).
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response isreceived before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns anerror. expires, the request fails and returns an error.
:arg preserve_existing: If `true`, existing index settings :arg preserve_existing: If `true`, existing index settings
remain unchanged. Default is false. remain unchanged. Default is false.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
@@ -1467,7 +1467,7 @@ class IndicesClient(NamespacedClient):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
if body in SKIP_IN_PATH: if body in SKIP_IN_PATH:
@@ -1517,9 +1517,9 @@ class IndicesClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match. If the request can target data streams, this argumentdetermines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values,such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg fielddata_fields: Comma-separated list or wildcard :arg fielddata_fields: Comma-separated list or wildcard
expressions of fields to include in fielddata statistics. expressions of fields to include in fielddata statistics.
@@ -1577,15 +1577,15 @@ class IndicesClient(NamespacedClient):
all data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1641,25 +1641,25 @@ class IndicesClient(NamespacedClient):
shards instead of one random shard per index. shards instead of one random shard per index.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
are analyzed. Default is false. are analyzed. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the `q` query string parameter is parameter can only be used when the `q` query string parameter is
specified. specified.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
query: `AND` or `OR`. Valid choices are and, or. query: `AND` or `OR`. Valid choices are and, or.
:arg df: Field to use as default where no field prefix is given :arg df: Field to use as default where no field prefix is given
in the query string.This parameter can only be used when the `q` query in the query string. This parameter can only be used when the `q` query
string parameter is specified. string parameter is specified.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg explain: If `true`, the response returns detailed :arg explain: If `true`, the response returns detailed
information if an error has occurred. information if an error has occurred.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1715,16 +1715,16 @@ class IndicesClient(NamespacedClient):
string to perform the operation on all indices. string to perform the operation on all indices.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg fielddata: If `true`, clears the fields cache.Use the :arg fielddata: If `true`, clears the fields cache. Use the
`fields` parameter to clear the cache of specific fields only. `fields` parameter to clear the cache of specific fields only.
:arg fields: Comma-separated list of field names used to limit :arg fields: Comma-separated list of field names used to limit
the `fielddata` parameter. the `fielddata` parameter.
@@ -1908,13 +1908,13 @@ class IndicesClient(NamespacedClient):
:arg index: List of data streams, indices, and aliases used to :arg index: List of data streams, indices, and aliases used to
limit the request. limit the request.
:arg allow_no_indices: If false, the request returns an error if :arg allow_no_indices: If false, the request returns an error if
any wildcard expression, index alias, or _allvalue targets only missing any wildcard expression, index alias, or _all value targets only missing
or closed indices. This behavior applies even if the requesttargets or closed indices. This behavior applies even if the request targets
other open indices. other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match. If the request can target data streams,this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Valid choices whether wildcard expressions match hidden data streams. Valid choices
are all, closed, hidden, none, open. are all, closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1978,8 +1978,8 @@ class IndicesClient(NamespacedClient):
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indices
should be ignored when unavailable (missing or closed) should be ignored when unavailable (missing or closed)
:arg max_num_segments: The number of larger segments into which :arg max_num_segments: The number of larger segments into which
smaller segments are merged.Set this parameter to 1 to merge all smaller segments are merged. Set this parameter to 1 to merge all
segments into one segment.The default behavior is to perform the merge segments into one segment. The default behavior is to perform the merge
as necessary. as necessary.
:arg only_expunge_deletes: Specify whether the operation should :arg only_expunge_deletes: Specify whether the operation should
only expunge deleted documents only expunge deleted documents
@@ -2038,7 +2038,7 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -2046,11 +2046,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -2111,7 +2111,7 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -2119,11 +2119,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -2184,17 +2184,17 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -2520,10 +2520,10 @@ class IndicesClient(NamespacedClient):
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg create: If `true`, the template passed in the body is only :arg create: If `true`, the template passed in the body is only
used if no existingtemplates match the same index patterns. If `false`, used if no existing templates match the same index patterns. If `false`,
the simulation usesthe template with the highest priority. Note that the the simulation uses the template with the highest priority. Note that
template is notpermanently added or updated in either case; it is only the template is not permanently added or updated in either case; it is
used for thesimulation. Default is false. only used for the simulation. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2532,7 +2532,7 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is receivedbefore the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -2655,10 +2655,10 @@ class IndicesClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
opensearchpy/_async/client/ingest.py
+3 -3
View File
@@ -72,7 +72,7 @@ class IngestClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -171,13 +171,13 @@ class IngestClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
opensearchpy/_async/client/nodes.py
+2 -2
View File
@@ -66,7 +66,7 @@ class NodesClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -282,7 +282,7 @@ class NodesClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
opensearchpy/_async/client/plugins.py
+14 -10
View File
@@ -15,7 +15,11 @@ from ..plugins.index_management import IndexManagementClient
from ..plugins.knn import KnnClient from ..plugins.knn import KnnClient
from ..plugins.ml import MlClient from ..plugins.ml import MlClient
from ..plugins.notifications import NotificationsClient from ..plugins.notifications import NotificationsClient
from ..plugins.observability import ObservabilityClient
from ..plugins.ppl import PplClient
from ..plugins.query import QueryClient
from ..plugins.rollups import RollupsClient from ..plugins.rollups import RollupsClient
from ..plugins.sql import SqlClient
from ..plugins.transforms import TransformsClient from ..plugins.transforms import TransformsClient
from .client import Client from .client import Client
from .utils import NamespacedClient from .utils import NamespacedClient
@@ -27,18 +31,18 @@ class PluginsClient(NamespacedClient):
def __init__(self, client: Client) -> None: def __init__(self, client: Client) -> None:
super().__init__(client) super().__init__(client)
self.ml = MlClient(client)
self.transforms = TransformsClient(client)
self.rollups = RollupsClient(client)
self.notifications = NotificationsClient(client)
self.knn = KnnClient(client)
# self.query_workbench = QueryWorkbenchClient(client)
# self.reporting = ReportingClient(client)
# self.notebooks = NotebooksClient(client)
self.alerting = AlertingClient(client) self.alerting = AlertingClient(client)
# self.anomaly_detection = AnomalyDetectionClient(client)
# self.trace_analytics = TraceAnalyticsClient(client)
self.index_management = IndexManagementClient(client) self.index_management = IndexManagementClient(client)
self.knn = KnnClient(client)
self.ml = MlClient(client)
self.notifications = NotificationsClient(client)
self.observability = ObservabilityClient(client)
self.ppl = PplClient(client)
self.query = QueryClient(client)
self.rollups = RollupsClient(client)
self.sql = SqlClient(client)
self.transforms = TransformsClient(client)
self._dynamic_lookup(client) self._dynamic_lookup(client)
opensearchpy/_async/client/security.py
+134 -12
View File
@@ -93,7 +93,7 @@ class SecurityClient(NamespacedClient):
Retrieves one action group. Retrieves one action group.
:arg action_group: Action group to retrieve. :arg action_group: The name of the action group to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -156,7 +156,7 @@ class SecurityClient(NamespacedClient):
Delete a specified action group. Delete a specified action group.
:arg action_group: Action group to delete. :arg action_group: The name of the action group to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -229,6 +229,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of an action group. Updates individual attributes of an action group.
:arg action_group: The name of the action group to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -296,6 +297,7 @@ class SecurityClient(NamespacedClient):
Retrieve one internal user. Retrieve one internal user.
:arg username: The name of the user to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -356,6 +358,7 @@ class SecurityClient(NamespacedClient):
Delete the specified user. Delete the specified user.
:arg username: The name of the user to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -389,6 +392,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified user. Creates or replaces the specified user.
:arg username: The name of the user to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -424,6 +428,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of an internal user. Updates individual attributes of an internal user.
:arg username: The name of the user to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -548,6 +553,7 @@ class SecurityClient(NamespacedClient):
Delete the specified role. Delete the specified role.
:arg role: The name of the role to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -581,6 +587,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified role. Creates or replaces the specified role.
:arg role: The name of the role to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -616,6 +623,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of a role. Updates individual attributes of a role.
:arg role: The name of the role to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -743,6 +751,7 @@ class SecurityClient(NamespacedClient):
Deletes the specified role mapping. Deletes the specified 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -776,6 +785,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified role mapping. Creates or replaces the specified 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -811,6 +821,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of a role mapping. Updates individual attributes of a 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -878,6 +889,7 @@ class SecurityClient(NamespacedClient):
Retrieves one tenant. Retrieves one tenant.
:arg tenant: The name of the tenant to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -935,6 +947,7 @@ class SecurityClient(NamespacedClient):
Delete the specified tenant. Delete the specified tenant.
:arg tenant: The name of the tenant to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -968,6 +981,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified tenant. Creates or replaces the specified tenant.
:arg tenant: The name of the tenant to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1003,6 +1017,7 @@ class SecurityClient(NamespacedClient):
Add, delete, or modify a single tenant. Add, delete, or modify a single tenant.
:arg tenant: The name of the tenant to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1175,6 +1190,8 @@ class SecurityClient(NamespacedClient):
statistics. statistics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg show_all: A boolean flag to include/exclude static nodes DN
from final result.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -1304,6 +1321,9 @@ class SecurityClient(NamespacedClient):
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
: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 :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1547,7 +1567,10 @@ class SecurityClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
"GET", "/_plugins/_security/_upgrade_check", params=params, headers=headers "GET",
"/_plugins/_security/api/_upgrade_check",
params=params,
headers=headers,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
@@ -1574,7 +1597,7 @@ class SecurityClient(NamespacedClient):
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
"POST", "POST",
"/_plugins/_security/_upgrade_perform", "/_plugins/_security/api/_upgrade_perform",
params=params, params=params,
headers=headers, headers=headers,
body=body, body=body,
@@ -1660,6 +1683,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified user. Legacy API. Creates or replaces the specified user. Legacy API.
:arg username: The name of the user to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1695,6 +1719,8 @@ class SecurityClient(NamespacedClient):
Only accessible to super-admins and with rest-api permissions when enabled. Only accessible to super-admins and with rest-api permissions when enabled.
:arg cluster_name: The cluster-name to delete from list of
distinguished names.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1729,6 +1755,7 @@ class SecurityClient(NamespacedClient):
Delete the specified user. Legacy API. Delete the specified user. Legacy API.
:arg username: The name of the user to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1794,6 +1821,8 @@ class SecurityClient(NamespacedClient):
Generates authorization token for the given user. Generates authorization token for the given user.
: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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1825,9 +1854,11 @@ class SecurityClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Generates authorization token for the given user. Legacy API. Generates authorization token for the given user. Legacy API. Not Implemented.
: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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1911,6 +1942,8 @@ class SecurityClient(NamespacedClient):
api permissions when enabled. api permissions when enabled.
:arg cluster_name: The cluster-name to retrieve nodes DN setting
for.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1919,6 +1952,8 @@ class SecurityClient(NamespacedClient):
statistics. statistics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg show_all: A boolean flag to include/exclude static nodes DN
from final result.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -1980,7 +2015,8 @@ class SecurityClient(NamespacedClient):
statistics. statistics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg show_dn: The domain names from all certificates. :arg show_dn: A boolean flag to indicate whether all domain
names should be returned.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -2028,6 +2064,7 @@ class SecurityClient(NamespacedClient):
Retrieve one user. Legacy API. Retrieve one user. Legacy API.
:arg username: The name of the user to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2145,6 +2182,7 @@ class SecurityClient(NamespacedClient):
super-admins and with rest-api permissions when enabled. super-admins and with rest-api permissions when enabled.
:arg cluster_name: The cluster-name to update nodesDn value.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2172,7 +2210,6 @@ class SecurityClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
async def post_dashboards_info( async def post_dashboards_info(
self, self,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -2192,11 +2229,7 @@ class SecurityClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
"POST", "POST", "/_plugins/_security/dashboardsinfo", params=params, headers=headers
"/_plugins/_security/dashboardsinfo",
params=params,
headers=headers,
body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
@@ -2239,6 +2272,8 @@ class SecurityClient(NamespacedClient):
enabled. enabled.
:arg cluster_name: The cluster-name to create/update nodesDn
value for.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2276,6 +2311,8 @@ class SecurityClient(NamespacedClient):
to v7. to v7.
: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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2342,3 +2379,88 @@ class SecurityClient(NamespacedClient):
return await self.transport.perform_request( return await self.transport.perform_request(
"GET", "/_plugins/_security/whoamiprotected", params=params, headers=headers "GET", "/_plugins/_security/whoamiprotected", params=params, headers=headers
) )
@query_params(
"cert_type",
"error_trace",
"filter_path",
"human",
"pretty",
"source",
"timeout",
)
async def get_all_certificates(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves the cluster security 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.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
:arg timeout: The maximum duration, in seconds, to be spent to
retrieve certificates from all nodes.
"""
return await self.transport.perform_request(
"GET",
"/_plugins/_security/api/certificates",
params=params,
headers=headers,
)
@query_params(
"cert_type",
"error_trace",
"filter_path",
"human",
"pretty",
"source",
"timeout",
)
async def get_node_certificates(
self,
node_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves the given node's security certificates.
:arg node_id: The full-id of the node to retrieve 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.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
:arg timeout: The maximum duration, in seconds, to be spent to
retrieve a node's certificates.
"""
if node_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'node_id'.")
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "certificates", node_id),
params=params,
headers=headers,
)
opensearchpy/_async/client/tasks.py
+1 -1
View File
@@ -175,7 +175,7 @@ class TasksClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
opensearchpy/_async/plugins/ml.py
+64
View File
@@ -243,3 +243,67 @@ class MlClient(NamespacedClient):
headers=headers, headers=headers,
body=body, body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def deploy_model(
self,
model_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deploys a model.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if model_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'model_id'.")
return await self.transport.perform_request(
"POST",
_make_path("_plugins", "_ml", "models", model_id, "_deploy"),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def undeploy_model(
self,
model_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Undeploys a model.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if model_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'model_id'.")
return await self.transport.perform_request(
"POST",
_make_path("_plugins", "_ml", "models", model_id, "_undeploy"),
params=params,
headers=headers,
)
opensearchpy/_async/plugins/observability.py
+244
View File
@@ -0,0 +1,244 @@
# 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 ObservabilityClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def create_object(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Creates a new observability object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return await self.transport.perform_request(
"POST",
"/_plugins/_observability/object",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def delete_object(
self,
object_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes specific observability object specified by ID.
:arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if object_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'object_id'.")
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_observability", "object", object_id),
params=params,
headers=headers,
)
@query_params(
"error_trace",
"filter_path",
"human",
"objectId",
"objectIdList",
"pretty",
"source",
)
async def delete_objects(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes specific observability objects specified by ID or a list of IDs.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
: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.
: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(
"DELETE", "/_plugins/_observability/object", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def get_localstats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves Local Stats of all observability objects.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return await self.transport.perform_request(
"GET",
"/_plugins/_observability/_local/stats",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def get_object(
self,
object_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves specific observability object specified by ID.
:arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if object_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'object_id'.")
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_observability", "object", object_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def list_objects(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves list of all observability objects.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return await self.transport.perform_request(
"GET", "/_plugins/_observability/object", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def update_object(
self,
object_id: Any,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Updates an existing observability object.
:arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if object_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'object_id'.")
return await self.transport.perform_request(
"PUT",
_make_path("_plugins", "_observability", "object", object_id),
params=params,
headers=headers,
body=body,
)
opensearchpy/_async/plugins/ppl.py
+160
View File
@@ -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 ..client.utils import SKIP_IN_PATH, NamespacedClient, query_params
class PplClient(NamespacedClient):
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def explain(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Shows how a query is executed against OpenSearch.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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/_ppl/_explain", params=params, headers=headers, body=body
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def get_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Collect metrics for the plugin within the interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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.
"""
return await self.transport.perform_request(
"GET", "/_plugins/_ppl/stats", params=params, headers=headers
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def post_stats(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
By a stats endpoint, you are able to collect metrics for the plugin within the
interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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/_ppl/stats", params=params, headers=headers, body=body
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def query(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Send a PPL query to the PPL plugin.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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/_ppl", params=params, headers=headers, body=body
)
opensearchpy/_async/plugins/query.py
+178
View File
@@ -0,0 +1,178 @@
# 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 QueryClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def datasource_delete(
self,
datasource_name: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes specific datasource specified by name.
:arg datasource_name: The Name of the DataSource to delete.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if datasource_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'datasource_name'."
)
return await self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_query", "_datasources", datasource_name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def datasource_retrieve(
self,
datasource_name: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves specific datasource specified by name.
:arg datasource_name: The Name of the DataSource to retrieve.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if datasource_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'datasource_name'."
)
return await self.transport.perform_request(
"GET",
_make_path("_plugins", "_query", "_datasources", datasource_name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def datasources_create(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Creates a new query datasource.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return await self.transport.perform_request(
"POST",
"/_plugins/_query/_datasources",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def datasources_list(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves list of all datasources.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return await self.transport.perform_request(
"GET", "/_plugins/_query/_datasources", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
async def datasources_update(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Updates an existing query datasource.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return await self.transport.perform_request(
"PUT",
"/_plugins/_query/_datasources",
params=params,
headers=headers,
body=body,
)
opensearchpy/_async/plugins/sql.py
+230
View File
@@ -0,0 +1,230 @@
# 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, query_params
class SqlClient(NamespacedClient):
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def close(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Clear the cursor context.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def explain(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Shows how a query is executed against OpenSearch.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def get_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Collect metrics for the plugin within the interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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.
"""
return await self.transport.perform_request(
"GET", "/_plugins/_sql/stats", params=params, headers=headers
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def post_stats(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
By a stats endpoint, you are able to collect metrics for the plugin within the
interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
async def query(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Send a SQL/PPL query to the SQL plugin.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params("error_trace", "filter_path", "format", "human", "pretty", "source")
async def settings(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Adds SQL settings to the standard OpenSearch cluster settings.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return await self.transport.perform_request(
"PUT",
"/_plugins/_query/settings",
params=params,
headers=headers,
body=body,
)
opensearchpy/_async/plugins/transforms.py
+1 -1
View File
@@ -282,7 +282,7 @@ class TransformsClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
stop transform. Stop transform.
:arg id: Transform to stop :arg id: Transform to stop
opensearchpy/client/__init__.py
+199 -199
View File
@@ -350,16 +350,16 @@ class OpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -367,14 +367,14 @@ class OpenSearch(Client):
:arg timeout: Period the request waits for the following :arg timeout: Period the request waits for the following
operations: automatic index creation, dynamic mapping updates, waiting operations: automatic index creation, dynamic mapping updates, waiting
for active shards. for active shards.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -432,22 +432,22 @@ class OpenSearch(Client):
:arg if_seq_no: Only perform the operation if the document has :arg if_seq_no: Only perform the operation if the document has
this sequence number. this sequence number.
:arg op_type: Set to create to only index the document if it :arg op_type: Set to create to only index the document if it
does not already exist (put if absent).If a document with the specified does not already exist (put if absent). If a document with the specified
`_id` already exists, the indexing operation will fail.Same as using the `_id` already exists, the indexing operation will fail. Same as using
`<index>/_create` endpoint.Valid values: `index`, `create`.If document the `<index>/_create` endpoint. Valid values: `index`, `create`. If
id is specified, it defaults to `index`.Otherwise, it defaults to document id is specified, it defaults to `index`. Otherwise, it defaults
`create`. to `create`.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg require_alias: If `true`, the destination must be an index :arg require_alias: If `true`, the destination must be an index
alias. Default is false. alias. Default is false.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -457,14 +457,14 @@ class OpenSearch(Client):
:arg timeout: Period the request waits for the following :arg timeout: Period the request waits for the following
operations: automatic index creation, dynamic mapping updates, waiting operations: automatic index creation, dynamic mapping updates, waiting
for active shards. for active shards.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -524,16 +524,16 @@ class OpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg require_alias: If `true`, the request's actions must target :arg require_alias: If `true`, the request's actions must target
an index alias. Default is false. an index alias. Default is false.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -544,7 +544,7 @@ class OpenSearch(Client):
operations: automatic index creation, dynamic mapping updates, waiting operations: automatic index creation, dynamic mapping updates, waiting
for active shards. for active shards.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -637,25 +637,25 @@ class OpenSearch(Client):
and indices, omit this parameter or use `*` or `_all`. and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
are analyzed.This parameter can only be used when the `q` query string are analyzed. This parameter can only be used when the `q` query string
parameter is specified. Default is false. parameter is specified. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the `q` query string parameter is parameter can only be used when the `q` query string parameter is
specified. specified.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
query: `AND` or `OR`.This parameter can only be used when the `q` query query: `AND` or `OR`. This parameter can only be used when the `q` query
string parameter is specified. Valid choices are and, or. string parameter is specified. Valid choices are and, or.
:arg df: Field to use as default where no field prefix is given :arg df: Field to use as default where no field prefix is given
in the query string.This parameter can only be used when the `q` query in the query string. This parameter can only be used when the `q` query
string parameter is specified. string parameter is specified.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -671,7 +671,7 @@ class OpenSearch(Client):
:arg min_score: Sets the minimum `_score` value that documents :arg min_score: Sets the minimum `_score` value that documents
must have to be included in the result. must have to be included in the result.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
@@ -680,8 +680,8 @@ class OpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting. query early. OpenSearch collects documents before sorting.
""" """
return self.transport.perform_request( return self.transport.perform_request(
"POST", "POST",
@@ -734,20 +734,20 @@ class OpenSearch(Client):
:arg refresh: If `true`, OpenSearch refreshes the affected :arg refresh: If `true`, OpenSearch refreshes the affected
shards to make this operation visible to search, if `wait_for` then wait 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 for a refresh to make this operation visible to search, if `false` do
nothing with refreshes.Valid values: `true`, `false`, `wait_for`. nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for active shards. :arg timeout: Period to wait for active shards.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -822,8 +822,8 @@ class OpenSearch(Client):
the _source field. the _source field.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
@@ -838,8 +838,8 @@ class OpenSearch(Client):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid values are: `all`, separated values, such as `open,hidden`. Valid values are: `all`,
`open`, `closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -851,17 +851,17 @@ class OpenSearch(Client):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be ignored. providing text to a numeric field) in the query string will be ignored.
:arg max_docs: Maximum number of documents to process.Defaults :arg max_docs: Maximum number of documents to process. Defaults
to all documents. to all documents.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
:arg refresh: If `true`, OpenSearch refreshes all shards :arg refresh: If `true`, OpenSearch refreshes all shards
involved in the delete by query after the request completes. involved in the delete by query after the request completes.
:arg request_cache: If `true`, the request cache is used for :arg request_cache: If `true`, the request cache is used for
this request.Defaults to the index-level setting. this request. Defaults to the index-level setting.
:arg requests_per_second: The throttle for this request in sub- :arg requests_per_second: The throttle for this request in sub-
requests per second. Default is 0. requests per second. Default is 0.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -869,9 +869,9 @@ class OpenSearch(Client):
:arg scroll: Period to retain the search context for scrolling. :arg scroll: Period to retain the search context for scrolling.
:arg scroll_size: Size of the scroll request that powers the :arg scroll_size: Size of the scroll request that powers the
operation. Default is 100. operation. Default is 100.
:arg search_timeout: Explicit timeout for each search :arg search_timeout: Explicit timeout for each search request.
request.Defaults to no timeout. Defaults to no timeout.
:arg search_type: The type of the search operation.Available :arg search_type: The type of the search operation. Available
options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are
dfs_query_then_fetch, query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg size: Deprecated, please use `max_docs` instead. :arg size: Deprecated, please use `max_docs` instead.
@@ -883,18 +883,18 @@ class OpenSearch(Client):
:arg stats: Specific `tag` of the request for logging and :arg stats: Specific `tag` of the request for logging and
statistical purposes. statistical purposes.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting.Use with query early. OpenSearch collects documents before sorting. Use with
caution.OpenSearch applies this parameter to each shard handling the caution. OpenSearch applies this parameter to each shard handling the
request.When possible, let OpenSearch perform early termination request. When possible, let OpenSearch perform early termination
automatically.Avoid specifying this parameter for requests that target automatically. Avoid specifying this parameter for requests that target
data streams with backing indices across multiple data tiers. data streams with backing indices across multiple data tiers.
:arg timeout: Period each deletion request waits for active :arg timeout: Period each deletion request waits for active
shards. shards.
:arg version: If `true`, returns the document version as part of :arg version: If `true`, returns the document version as part of
a hit. a hit.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
@@ -985,13 +985,13 @@ class OpenSearch(Client):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1046,7 +1046,7 @@ class OpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If `true`, the request is real-time as opposed to :arg realtime: If `true`, the request is real-time as opposed to
@@ -1057,12 +1057,12 @@ class OpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg stored_fields: List of stored fields to return as part of a :arg stored_fields: List of stored fields to return as part of a
hit.If no fields are specified, no stored fields are included in the hit. If no fields are specified, no stored fields are included in the
response.If this field is specified, the `_source` parameter defaults to response. If this field is specified, the `_source` parameter defaults
false. to false.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
@@ -1118,7 +1118,7 @@ class OpenSearch(Client):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If true, the request is real-time as opposed to :arg realtime: If true, the request is real-time as opposed to
@@ -1128,9 +1128,9 @@ class OpenSearch(Client):
:arg routing: Target the specified primary shard. :arg routing: Target the specified primary shard.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg version: Explicit version number for concurrency :arg version: Explicit version number for concurrency control.
control.The specified version must match the current version of the The specified version must match the current version of the document for
document for the request to succeed. the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are external, external_gte, force, `external_gte`. Valid choices are external, external_gte, force,
internal. internal.
@@ -1188,7 +1188,7 @@ class OpenSearch(Client):
to include in the response. to include in the response.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
are analyzed. Default is false. are analyzed. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the `q` query string parameter is parameter can only be used when the `q` query string parameter is
specified. specified.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
@@ -1204,7 +1204,7 @@ class OpenSearch(Client):
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be ignored. providing text to a numeric field) in the query string will be ignored.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
@@ -1254,9 +1254,9 @@ class OpenSearch(Client):
aliases used to limit the request. Supports wildcards (*). To target all 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 indices, omit this parameter or use * or _all.
:arg allow_no_indices: If false, the request returns an error if :arg allow_no_indices: If false, the request returns an error if
any wildcard expression, index alias,or `_all` value targets only any wildcard expression, index alias, or `_all` value targets only
missing or closed indices. This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. For example, a requesttargeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with foo but no index starts with returns an error if an index starts with foo but no index starts with
bar. bar.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
@@ -1344,9 +1344,9 @@ class OpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg stored_fields: List of stored fields to return as part of a :arg stored_fields: List of stored fields to return as part of a
hit.If no fields are specified, no stored fields are included in the hit. If no fields are specified, no stored fields are included in the
response.If this field is specified, the `_source` parameter defaults to response. If this field is specified, the `_source` parameter defaults
false. to false.
:arg version: Explicit version number for concurrency control. :arg version: Explicit version number for concurrency control.
The specified version must match the current version of the document for The specified version must match the current version of the document for
the request to succeed. the request to succeed.
@@ -1508,12 +1508,12 @@ class OpenSearch(Client):
:arg _source: True or false to return the `_source` field or :arg _source: True or false to return the `_source` field or
not, or a list of fields to return. not, or a list of fields to return.
:arg _source_excludes: A comma-separated list of source fields :arg _source_excludes: A comma-separated list of source fields
to exclude from the response.You can also use this parameter to exclude to exclude from the response. You can also use this parameter to exclude
fields from the subset specified in `_source_includes` query parameter. fields from the subset specified in `_source_includes` query parameter.
:arg _source_includes: A comma-separated list of source fields :arg _source_includes: A comma-separated list of source fields
to include in the response.If this parameter is specified, only these to include in the response. If this parameter is specified, only these
source fields are returned. You can exclude fields from this subset source fields are returned. You can exclude fields from this subset
using the `_source_excludes` query parameter.If the `_source` parameter using the `_source_excludes` query parameter. If the `_source` parameter
is `false`, this parameter is ignored. is `false`, this parameter is ignored.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
@@ -1663,9 +1663,9 @@ class OpenSearch(Client):
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg rest_total_hits_as_int: If `true`, the response returns :arg rest_total_hits_as_int: If `true`, the response returns
`hits.total` as an integer.If `false`, it returns `hits.total` as an `hits.total` as an integer. If `false`, it returns `hits.total` as an
object. Default is false. object. Default is false.
:arg search_type: The type of the search operation.Available :arg search_type: The type of the search operation. Available
options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are options: `query_then_fetch`, `dfs_query_then_fetch`. Valid choices are
dfs_query_then_fetch, query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1725,7 +1725,7 @@ class OpenSearch(Client):
document count, sum of document frequencies, and sum of total term document count, sum of document frequencies, and sum of total term
frequencies. Default is True. frequencies. Default is True.
:arg fields: Comma-separated list or wildcard expressions of :arg fields: Comma-separated list or wildcard expressions of
fields to include in the statistics.Used as the default list unless a fields to include in the statistics. Used as the default list unless a
specific field list is provided in the `completion_fields` or specific field list is provided in the `completion_fields` or
`fielddata_fields` parameters. `fielddata_fields` parameters.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1741,7 +1741,7 @@ class OpenSearch(Client):
:arg positions: If `true`, the response includes term positions. :arg positions: If `true`, the response includes term positions.
Default is True. Default is True.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If true, the request is real-time as opposed to :arg realtime: If true, the request is real-time as opposed to
@@ -1801,13 +1801,13 @@ class OpenSearch(Client):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1928,18 +1928,18 @@ class OpenSearch(Client):
:arg refresh: If `true`, the request refreshes affected shards :arg refresh: If `true`, the request refreshes affected shards
to make this operation visible to search. to make this operation visible to search.
:arg requests_per_second: The throttle for this request in sub- :arg requests_per_second: The throttle for this request in sub-
requests per second.Defaults to no throttle. Default is 0. requests per second. Defaults to no throttle. Default is 0.
:arg scroll: Specifies how long a consistent view of the index :arg scroll: Specifies how long a consistent view of the index
should be maintained for scrolled search. should be maintained for scrolled search.
:arg slices: The number of slices this task should be divided :arg slices: The number of slices this task should be divided
into.Defaults to 1 slice, meaning the task isn't sliced into subtasks. into. Defaults to 1 slice, meaning the task isn't sliced into subtasks.
Valid choices are auto. Valid choices are auto.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period each indexing waits for automatic index :arg timeout: Period each indexing waits for automatic index
creation, dynamic mapping updates, and waiting for active shards. creation, dynamic mapping updates, and waiting for active shards.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
@@ -2173,70 +2173,69 @@ class OpenSearch(Client):
aliases to search. Supports wildcards (`*`). To search all data streams aliases to search. Supports wildcards (`*`). To search all data streams
and indices, omit this parameter or use `*` or `_all`. and indices, omit this parameter or use `*` or `_all`.
:arg _source: Indicates which source fields are returned for :arg _source: Indicates which source fields are returned for
matching documents.These fields are returned in the `hits._source` matching documents. These fields are returned in the `hits._source`
property of the search response.Valid values are:`true` to return the property of the search response. Valid values are: `true` to return the
entire document source;`false` to not return the document entire document source; `false` to not return the document source;
source;`<string>` to return the source fields that are specified as a `<string>` to return the source fields that are specified as a comma-
comma-separated list (supports wildcard (`*`) patterns). separated list (supports wildcard (`*`) patterns).
:arg _source_excludes: A comma-separated list of source fields :arg _source_excludes: A comma-separated list of source fields
to exclude from the response.You can also use this parameter to exclude to exclude from the response. You can also use this parameter to exclude
fields from the subset specified in `_source_includes` query fields from the subset specified in `_source_includes` query parameter.
parameter.If the `_source` parameter is `false`, this parameter is If the `_source` parameter is `false`, this parameter is ignored.
ignored.
:arg _source_includes: A comma-separated list of source fields :arg _source_includes: A comma-separated list of source fields
to include in the response.If this parameter is specified, only these to include in the response. If this parameter is specified, only these
source fields are returned.You can exclude fields from this subset using source fields are returned. You can exclude fields from this subset
the `_source_excludes` query parameter.If the `_source` parameter is using the `_source_excludes` query parameter. If the `_source` parameter
`false`, this parameter is ignored. is `false`, this parameter is ignored.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg allow_partial_search_results: If true, returns partial :arg allow_partial_search_results: If true, returns partial
results if there are shard request timeouts or shard failures. If false, results if there are shard request timeouts or shard failures. If false,
returns an error with no partial results. Default is True. returns an error with no partial results. Default is True.
:arg analyze_wildcard: If true, wildcard and prefix queries are :arg analyze_wildcard: If true, wildcard and prefix queries are
analyzed.This parameter can only be used when the q query string analyzed. This parameter can only be used when the q query string
parameter is specified. Default is false. parameter is specified. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the q query string parameter is parameter can only be used when the q query string parameter is
specified. specified.
:arg batched_reduce_size: The number of shard results that :arg batched_reduce_size: The number of shard results that
should be reduced at once on the coordinating node.This value should be should be reduced at once on the coordinating node. This value should be
used as a protection mechanism to reduce the memory overhead per search used as a protection mechanism to reduce the memory overhead per search
request if the potential number of shards in the request can be large. request if the potential number of shards in the request can be large.
Default is 512. Default is 512.
:arg cancel_after_time_interval: The time after which the search :arg cancel_after_time_interval: The time after which the search
request will be canceled.Request-level parameter takes precedence over request will be canceled. Request-level parameter takes precedence over
`cancel_after_time_interval` cluster setting. `cancel_after_time_interval` cluster setting.
:arg ccs_minimize_roundtrips: If true, network round-trips :arg ccs_minimize_roundtrips: If true, network round-trips
between the coordinating node and the remote clusters are minimized when between the coordinating node and the remote clusters are minimized when
executing cross-cluster search (CCS) requests. Default is True. executing cross-cluster search (CCS) requests. Default is True.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
query: AND or OR.This parameter can only be used when the `q` query query: AND or OR. This parameter can only be used when the `q` query
string parameter is specified. Valid choices are and, or. string parameter is specified. Valid choices are and, or.
:arg df: Field to use as default where no field prefix is given :arg df: Field to use as default where no field prefix is given
in the query string.This parameter can only be used when the q query in the query string. This parameter can only be used when the q query
string parameter is specified. string parameter is specified.
:arg docvalue_fields: A comma-separated list of fields to return :arg docvalue_fields: A comma-separated list of fields to return
as the docvalue representation for each hit. as the docvalue representation for each hit.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg explain: If `true`, returns detailed information about :arg explain: If `true`, returns detailed information about
score computation as part of a hit. score computation as part of a hit.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg from_: Starting document offset.Needs to be non-negative.By :arg from_: Starting document offset. Needs to be non-negative.
default, you cannot page through more than 10,000 hits using the `from` By default, you cannot page through more than 10,000 hits using the
and `size` parameters.To page through more hits, use the `search_after` `from` and `size` parameters. To page through more hits, use the
parameter. Default is 0. `search_after` parameter. Default is 0.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg ignore_throttled: If `true`, concrete, expanded or aliased :arg ignore_throttled: If `true`, concrete, expanded or aliased
@@ -2248,50 +2247,50 @@ class OpenSearch(Client):
of the matched query associated with its score (true) or as an array of the matched query associated with its score (true) or as an array
containing the name of the matched queries (false) Default is false. containing the name of the matched queries (false) Default is false.
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be providing text to a numeric field) in the query string will be ignored.
ignored.This parameter can only be used when the `q` query string This parameter can only be used when the `q` query string parameter is
parameter is specified. specified.
:arg max_concurrent_shard_requests: Defines the number of :arg max_concurrent_shard_requests: Defines the number of
concurrent shard requests per node this search executes concurrent shard requests per node this search executes concurrently.
concurrently.This value should be used to limit the impact of the search This value should be used to limit the impact of the search on the
on the cluster in order to limit the number of concurrent shard cluster in order to limit the number of concurrent shard requests.
requests. Default is 5. Default is 5.
:arg phase_took: Indicates whether to return phase-level `took` :arg phase_took: Indicates whether to return phase-level `took`
time values in the response. Default is false. time values in the response. Default is false.
:arg pre_filter_shard_size: Defines a threshold that enforces a :arg pre_filter_shard_size: Defines a threshold that enforces a
pre-filter roundtrip to prefilter search shards based on query rewriting pre-filter roundtrip to prefilter search shards based on query rewriting
if the number of shards the search request expands to exceeds the if the number of shards the search request expands to exceeds the
threshold.This filter roundtrip can limit the number of shards threshold. This filter roundtrip can limit the number of shards
significantly if for instance a shard can not match any documents based significantly if for instance a shard can not match any documents based
on its rewrite method (if date filters are mandatory to match but the on its rewrite method (if date filters are mandatory to match but the
shard bounds and the query are disjoint).When unspecified, the pre- shard bounds and the query are disjoint). When unspecified, the pre-
filter phase is executed if any of these conditions is met:the request filter phase is executed if any of these conditions is met: the request
targets more than 128 shards;the request targets one or more read-only targets more than 128 shards; the request targets one or more read-only
index;the primary sort of the query targets an indexed field. index; the primary sort of the query targets an indexed field.
:arg preference: Nodes and shards used for the search.By :arg preference: Nodes and shards used for the search. By
default, OpenSearch selects from eligible nodes and shards using default, OpenSearch selects from eligible nodes and shards using
adaptive replica selection, accounting for allocation awareness. Valid adaptive replica selection, accounting for allocation awareness. Valid
values are:`_only_local` to run the search only on shards on the local values are: `_only_local` to run the search only on shards on the local
node;`_local` to, if possible, run the search on shards on the local node; `_local` to, if possible, run the search on shards on the local
node, or if not, select shards using the default node, or if not, select shards using the default method;
method;`_only_nodes:<node-id>,<node-id>` to run the search on only the `_only_nodes:<node-id>,<node-id>` to run the search on only the
specified nodes IDs, where, if suitable shards exist on more than one specified nodes IDs, where, if suitable shards exist on more than one
selected node, use shards on those nodes using the default method, or if selected node, use shards on those nodes using the default method, or if
none of the specified nodes are available, select shards from any none of the specified nodes are available, select shards from any
available node using the default method;`_prefer_nodes:<node-id>,<node- available node using the default method; `_prefer_nodes:<node-id>,<node-
id>` to if possible, run the search on the specified nodes IDs, or if id>` to if possible, run the search on the specified nodes IDs, or if
not, select shards using the default method;`_shards:<shard>,<shard>` to not, select shards using the default method; `_shards:<shard>,<shard>`
run the search only on the specified shards;`<custom-string>` (any to run the search only on the specified shards; `<custom-string>` (any
string that does not start with `_`) to route searches with the same string that does not start with `_`) to route searches with the same
`<custom-string>` to the same shards in the same order. Default is `<custom-string>` to the same shards in the same order. Default is
random. random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax using query :arg q: Query in the Lucene query string syntax using query
parameter search.Query parameter searches do not support the full parameter search. Query parameter searches do not support the full
OpenSearch Query DSL but are handy for testing. OpenSearch Query DSL but are handy for testing.
:arg request_cache: If `true`, the caching of search results is :arg request_cache: If `true`, the caching of search results is
enabled for requests where `size` is `0`.Defaults to index level enabled for requests where `size` is `0`. Defaults to index level
settings. settings.
:arg rest_total_hits_as_int: Indicates whether `hits.total` :arg rest_total_hits_as_int: Indicates whether `hits.total`
should be rendered as an integer or an object in the rest search should be rendered as an integer or an object in the rest search
@@ -2299,8 +2298,8 @@ class OpenSearch(Client):
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg scroll: Period to retain the search context for scrolling. :arg scroll: Period to retain the search context for scrolling.
See Scroll search results.By default, this value cannot exceed `1d` (24 See Scroll search results. By default, this value cannot exceed `1d` (24
hours).You can change this limit using the `search.max_keep_alive` hours). You can change this limit using the `search.max_keep_alive`
cluster-level setting. cluster-level setting.
:arg search_pipeline: Customizable sequence of processing stages :arg search_pipeline: Customizable sequence of processing stages
applied to search queries. applied to search queries.
@@ -2309,9 +2308,9 @@ class OpenSearch(Client):
dfs_query_then_fetch, query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg seq_no_primary_term: If `true`, returns sequence number and :arg seq_no_primary_term: If `true`, returns sequence number and
primary term of the last modification of each hit. primary term of the last modification of each hit.
:arg size: Defines the number of hits to return.By default, you :arg size: Defines the number of hits to return. By default, you
cannot page through more than 10,000 hits using the `from` and `size` cannot page through more than 10,000 hits using the `from` and `size`
parameters.To page through more hits, use the `search_after` parameter. parameters. To page through more hits, use the `search_after` parameter.
Default is 10. Default is 10.
:arg sort: A comma-separated list of <field>:<direction> pairs. :arg sort: A comma-separated list of <field>:<direction> pairs.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -2319,38 +2318,39 @@ class OpenSearch(Client):
:arg stats: Specific `tag` of the request for logging and :arg stats: Specific `tag` of the request for logging and
statistical purposes. statistical purposes.
:arg stored_fields: A comma-separated list of stored fields to :arg stored_fields: A comma-separated list of stored fields to
return as part of a hit.If no fields are specified, no stored fields are return as part of a hit. If no fields are specified, no stored fields
included in the response.If this field is specified, the `_source` are included in the response. If this field is specified, the `_source`
parameter defaults to `false`.You can pass `_source: true` to return parameter defaults to `false`. You can pass `_source: true` to return
both source fields and stored fields in the search response. both source fields and stored fields in the search response.
:arg suggest_field: Specifies which field to use for :arg suggest_field: Specifies which field to use for
suggestions. suggestions.
:arg suggest_mode: Specifies the suggest mode.This parameter can :arg suggest_mode: Specifies the suggest mode. This parameter
only be used when the `suggest_field` and `suggest_text` query string can only be used when the `suggest_field` and `suggest_text` query
parameters are specified. Valid choices are always, missing, popular. string parameters are specified. Valid choices are always, missing,
:arg suggest_size: Number of suggestions to return.This popular.
:arg suggest_size: Number of suggestions to return. This
parameter can only be used when the `suggest_field` and `suggest_text` parameter can only be used when the `suggest_field` and `suggest_text`
query string parameters are specified. query string parameters are specified.
:arg suggest_text: The source text for which the suggestions :arg suggest_text: The source text for which the suggestions
should be returned.This parameter can only be used when the should be returned. This parameter can only be used when the
`suggest_field` and `suggest_text` query string parameters are `suggest_field` and `suggest_text` query string parameters are
specified. specified.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting.Use with query early. OpenSearch collects documents before sorting. Use with
caution.OpenSearch applies this parameter to each shard handling the caution. OpenSearch applies this parameter to each shard handling the
request.When possible, let OpenSearch perform early termination request. When possible, let OpenSearch perform early termination
automatically.Avoid specifying this parameter for requests that target 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 indices across multiple data tiers. If set to
`0` (default), the query does not terminate early. `0` (default), the query does not terminate early.
:arg timeout: Specifies the period of time to wait for a :arg timeout: Specifies the period of time to wait for a
response from each shard.If no response is received before the timeout response from each shard. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg track_scores: If `true`, calculate and return document :arg track_scores: If `true`, calculate and return document
scores, even if the scores are not used for sorting. scores, even if the scores are not used for sorting.
:arg track_total_hits: Number of hits matching the query to :arg track_total_hits: Number of hits matching the query to
count accurately.If `true`, the exact number of hits is returned at the count accurately. If `true`, the exact number of hits is returned at the
cost of some performance.If `false`, the response does not include the cost of some performance. If `false`, the response does not include the
total number of hits matching the query. total number of hits matching the query.
:arg typed_keys: If `true`, aggregation and suggester names are :arg typed_keys: If `true`, aggregation and suggester names are
be prefixed by their respective types in the response. be prefixed by their respective types in the response.
@@ -2397,17 +2397,17 @@ class OpenSearch(Client):
would be executed against. would be executed against.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -2417,7 +2417,7 @@ class OpenSearch(Client):
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. Default is false. the local node only. Default is false.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
@@ -2465,8 +2465,8 @@ class OpenSearch(Client):
aliases to search. Supports wildcards (*). aliases to search. Supports wildcards (*).
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg ccs_minimize_roundtrips: If `true`, network round-trips are :arg ccs_minimize_roundtrips: If `true`, network round-trips are
@@ -2474,10 +2474,10 @@ class OpenSearch(Client):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg explain: If `true`, the response includes additional :arg explain: If `true`, the response includes additional
details about score computation as part of a hit. details about score computation as part of a hit.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2489,7 +2489,7 @@ class OpenSearch(Client):
:arg ignore_unavailable: If `false`, the request returns an :arg ignore_unavailable: If `false`, the request returns an
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg profile: If `true`, the query execution is profiled. :arg profile: If `true`, the query execution is profiled.
@@ -2497,8 +2497,8 @@ class OpenSearch(Client):
an integer in the response. Default is false. an integer in the response. Default is false.
:arg routing: Custom value used to route operations to a :arg routing: Custom value used to route operations to a
specific shard. specific shard.
:arg scroll: Specifies how long a consistent view of the :arg scroll: Specifies how long a consistent view of the index
indexshould be maintained for scrolled search. should be maintained for scrolled search.
:arg search_type: The type of the search operation. Valid :arg search_type: The type of the search operation. Valid
choices are dfs_query_then_fetch, query_then_fetch. choices are dfs_query_then_fetch, query_then_fetch.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -2558,7 +2558,7 @@ class OpenSearch(Client):
document count, sum of document frequencies, and sum of total term document count, sum of document frequencies, and sum of total term
frequencies. Default is True. frequencies. Default is True.
:arg fields: Comma-separated list or wildcard expressions of :arg fields: Comma-separated list or wildcard expressions of
fields to include in the statistics.Used as the default list unless a fields to include in the statistics. Used as the default list unless a
specific field list is provided in the `completion_fields` or specific field list is provided in the `completion_fields` or
`fielddata_fields` parameters. `fielddata_fields` parameters.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2572,7 +2572,7 @@ class OpenSearch(Client):
:arg positions: If `true`, the response includes term positions. :arg positions: If `true`, the response includes term positions.
Default is True. Default is True.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg realtime: If true, the request is real-time as opposed to :arg realtime: If true, the request is real-time as opposed to
@@ -2633,7 +2633,7 @@ class OpenSearch(Client):
:arg body: The request definition requires either `script` or :arg body: The request definition requires either `script` or
partial `doc` partial `doc`
:arg _source: Set to false to disable source retrieval. You can :arg _source: Set to false to disable source retrieval. You can
also specify a comma-separatedlist of the fields you want to retrieve. also specify a comma-separated list of the fields you want to retrieve.
:arg _source_excludes: Specify the source fields you want to :arg _source_excludes: Specify the source fields you want to
exclude. exclude.
:arg _source_includes: Specify the source fields you want to :arg _source_includes: Specify the source fields you want to
@@ -2652,8 +2652,8 @@ class OpenSearch(Client):
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg refresh: If 'true', OpenSearch refreshes the affected :arg refresh: If 'true', OpenSearch refreshes the affected
shards to make this operationvisible to search, if 'wait_for' then wait shards to make this operation visible to search, if 'wait_for' then wait
for a refresh to make this operationvisible to search, if 'false' do for a refresh to make this operation visible to search, if 'false' do
nothing with refreshes. Valid choices are false, true, wait_for. nothing with refreshes. Valid choices are false, true, wait_for.
:arg require_alias: If true, the destination must be an index :arg require_alias: If true, the destination must be an index
alias. Default is false. alias. Default is false.
@@ -2664,14 +2664,14 @@ class OpenSearch(Client):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for dynamic mapping updates and :arg timeout: Period to wait for dynamic mapping updates and
active shards.This guarantees OpenSearch waits for at least the timeout active shards. This guarantees OpenSearch waits for at least the timeout
before failing.The actual wait time could be longer, particularly when before failing. The actual wait time could be longer, particularly when
multiple waits occur. multiple waits occur.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operations.Set to 'all' or any must be active before proceeding with the operations. Set to 'all' or
positive integer up to the total number of shards in the any positive integer up to the total number of shards in the index
index(number_of_replicas+1). Defaults to 1 meaning the primary shard. (number_of_replicas+1). Defaults to 1 meaning the primary shard. Valid
Valid choices are all, index-setting. choices are all, index-setting.
""" """
for param in (index, id, body): for param in (index, id, body):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -2748,8 +2748,8 @@ class OpenSearch(Client):
the _source field. the _source field.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices.For example, a request targeting `foo*,bar*` targets other open indices. For example, a request targeting `foo*,bar*`
returns an error if an index starts with `foo` but no index starts with returns an error if an index starts with `foo` but no index starts with
`bar`. `bar`.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
@@ -2764,10 +2764,10 @@ class OpenSearch(Client):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg from_: Starting offset. Default is 0. :arg from_: Starting offset. Default is 0.
@@ -2777,15 +2777,15 @@ class OpenSearch(Client):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg lenient: If `true`, format-based query failures (such as :arg lenient: If `true`, format-based query failures (such as
providing text to a numeric field) in the query string will be ignored. providing text to a numeric field) in the query string will be ignored.
:arg max_docs: Maximum number of documents to process.Defaults :arg max_docs: Maximum number of documents to process. Defaults
to all documents. to all documents.
:arg pipeline: ID of the pipeline to use to preprocess incoming :arg pipeline: ID of the pipeline to use to preprocess incoming
documents.If the index has a default ingest pipeline specified, then documents. If the index has a default ingest pipeline specified, then
setting the value to `_none` disables the default ingest pipeline for setting the value to `_none` disables the default ingest pipeline for
this request.If a final pipeline is configured it will always run, this request. If a final pipeline is configured it will always run,
regardless of the value of this parameter. regardless of the value of this parameter.
:arg preference: Specifies the node or shard the operation :arg preference: Specifies the node or shard the operation
should be performed on.Random by default. Default is random. should be performed on. Random by default. Default is random.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg q: Query in the Lucene query string syntax. :arg q: Query in the Lucene query string syntax.
@@ -2813,18 +2813,18 @@ class OpenSearch(Client):
:arg stats: Specific `tag` of the request for logging and :arg stats: Specific `tag` of the request for logging and
statistical purposes. statistical purposes.
:arg terminate_after: Maximum number of documents to collect for :arg terminate_after: Maximum number of documents to collect for
each shard.If a query reaches this limit, OpenSearch terminates the each shard. If a query reaches this limit, OpenSearch terminates the
query early.OpenSearch collects documents before sorting.Use with query early. OpenSearch collects documents before sorting. Use with
caution.OpenSearch applies this parameter to each shard handling the caution. OpenSearch applies this parameter to each shard handling the
request.When possible, let OpenSearch perform early termination request. When possible, let OpenSearch perform early termination
automatically.Avoid specifying this parameter for requests that target automatically. Avoid specifying this parameter for requests that target
data streams with backing indices across multiple data tiers. data streams with backing indices across multiple data tiers.
:arg timeout: Period each update request waits for the following :arg timeout: Period each update request waits for the following
operations: dynamic mapping updates, waiting for active shards. operations: dynamic mapping updates, waiting for active shards.
:arg version: If `true`, returns the document version as part of :arg version: If `true`, returns the document version as part of
a hit. a hit.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
opensearchpy/client/cluster.py
+29 -29
View File
@@ -164,11 +164,11 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only.If `false`, information is retrieved from the master the local node only. If `false`, information is retrieved from the
node. Default is false. master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -285,9 +285,9 @@ class ClusterClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. 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 :arg timeout: Period to wait for each node to respond. If a node
does not respond before its timeout expires, the response does not does not respond before its timeout expires, the response does not
include its stats.However, timed out nodes are included in the include its stats. However, timed out nodes are included in the
response's `_nodes.failed` property. Defaults to no timeout. response's `_nodes.failed` property. Defaults to no timeout.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -394,13 +394,13 @@ class ClusterClient(NamespacedClient):
settings from the local node. Default is false. settings from the local node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -558,13 +558,13 @@ class ClusterClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -609,11 +609,11 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only.If `false`, information is retrieved from the master the local node only. If `false`, information is retrieved from the
node. Default is false. master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -672,7 +672,7 @@ class ClusterClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -723,12 +723,12 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg local: If true, the request retrieves information from the :arg local: If true, the request retrieves information from the
local node only.Defaults to false, which means information is retrieved local node only. Defaults to false, which means information is retrieved
from the master node. Default is false. from the master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response isreceived before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns anerror. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -767,12 +767,12 @@ class ClusterClient(NamespacedClient):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_for_removal: Specifies whether to wait for all :arg wait_for_removal: Specifies whether to wait for all
excluded nodes to be removed from thecluster before clearing the voting excluded nodes to be removed from the cluster before clearing the voting
configuration exclusions list.Defaults to true, meaning that all configuration exclusions list. Defaults to true, meaning that all
excluded nodes must be removed fromthe cluster before this API takes any excluded nodes must be removed from the cluster before this API takes
action. If set to false then thevoting configuration exclusions list is any action. If set to false then the voting configuration exclusions
cleared even if some excludednodes are still in the cluster. Default is list is cleared even if some excluded nodes are still in the cluster.
True. Default is True.
""" """
return self.transport.perform_request( return self.transport.perform_request(
"DELETE", "DELETE",
@@ -807,19 +807,19 @@ class ClusterClient(NamespacedClient):
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg node_ids: A comma-separated list of the persistent ids of :arg node_ids: A comma-separated list of the persistent ids of
the nodes to excludefrom the voting configuration. If specified, you may the nodes to exclude from the voting configuration. If specified, you
not also specify node_names. may not also specify node_names.
:arg node_names: A comma-separated list of the names of the :arg node_names: A comma-separated list of the names of the
nodes to exclude from thevoting configuration. If specified, you may not nodes to exclude from the voting configuration. If specified, you may
also specify node_ids. not also specify node_ids.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: When adding a voting configuration exclusion, the :arg timeout: When adding a voting configuration exclusion, the
API waits for thespecified nodes to be excluded from the voting API waits for the specified nodes to be excluded from the voting
configuration beforereturning. If the timeout expires before the configuration before returning. If the timeout expires before the
appropriate conditionis satisfied, the request fails and returns an appropriate condition is satisfied, the request fails and returns an
error. error.
""" """
return self.transport.perform_request( return self.transport.perform_request(
opensearchpy/client/indices.py
+139 -139
View File
@@ -100,15 +100,15 @@ class IndicesClient(NamespacedClient):
all data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -151,15 +151,15 @@ class IndicesClient(NamespacedClient):
and indices, omit this parameter or use `*` or `_all`. and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg force: If `true`, the request forces a flush even if there :arg force: If `true`, the request forces a flush even if there
@@ -173,7 +173,7 @@ class IndicesClient(NamespacedClient):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg wait_if_ongoing: If `true`, the flush operation blocks :arg wait_if_ongoing: If `true`, the flush operation blocks
until execution when another flush operation is running.If `false`, until execution when another flush operation is running. If `false`,
OpenSearch returns an error if you request a flush when another flush OpenSearch returns an error if you request a flush when another flush
operation is running. Default is True. operation is running. Default is True.
""" """
@@ -216,18 +216,18 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation. Set to `all` or any must be active before proceeding with the operation. Set to `all` or
positive integer up to the total number of shards in the index any positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
if index in SKIP_IN_PATH: if index in SKIP_IN_PATH:
@@ -276,7 +276,7 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -284,11 +284,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -337,18 +337,18 @@ class IndicesClient(NamespacedClient):
:arg allow_no_indices: If false, the request returns an error if :arg allow_no_indices: If false, the request returns an error if
any wildcard expression, index alias, or _all value targets only missing any wildcard expression, index alias, or _all value targets only missing
or closed indices. This behavior applies even if the request targets or closed indices. This behavior applies even if the request targets
other open indices. For example,a request targeting foo*,bar* returns an other open indices. For example, a request targeting foo*,bar* returns
error if an index starts with foo but no index starts with bar. Default an error if an index starts with foo but no index starts with bar.
is false. Default is false.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard expressions :arg expand_wildcards: Type of index that wildcard expressions
can match. If the request can target data streams, this can match. If the request can target data streams, this argument
argument determines whether wildcard expressions match hidden data determines whether wildcard expressions match hidden data streams.
streams. Supports comma-separated values,such as open,hidden. Valid Supports comma-separated values, such as open,hidden. Valid choices are
choices are all, closed, hidden, none, open. all, closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg flat_settings: If true, returns settings in flat format. :arg flat_settings: If true, returns settings in flat format.
@@ -413,17 +413,17 @@ class IndicesClient(NamespacedClient):
settings API. settings API.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -432,7 +432,7 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -440,11 +440,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -485,17 +485,17 @@ class IndicesClient(NamespacedClient):
names used to limit the request. names used to limit the request.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -504,17 +504,17 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -554,17 +554,17 @@ class IndicesClient(NamespacedClient):
`action.destructive_requires_name` cluster setting to `false`. `action.destructive_requires_name` cluster setting to `false`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. Default is false. targets other open indices. Default is false.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -573,13 +573,13 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. Default is false. error if it targets a missing or closed index. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -618,17 +618,17 @@ class IndicesClient(NamespacedClient):
aliases. Supports wildcards (`*`). aliases. Supports wildcards (`*`).
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. Default is false. targets other open indices. Default is false.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg flat_settings: If `true`, returns settings in flat format. :arg flat_settings: If `true`, returns settings in flat format.
@@ -683,17 +683,17 @@ class IndicesClient(NamespacedClient):
string to perform the operation on all indices. string to perform the operation on all indices.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -702,13 +702,13 @@ class IndicesClient(NamespacedClient):
error if it targets a missing or closed index. error if it targets a missing or closed index.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg write_index_only: If `true`, the mappings are applied only :arg write_index_only: If `true`, the mappings are applied only
@@ -752,21 +752,21 @@ class IndicesClient(NamespacedClient):
:arg index: Comma-separated list of data streams, indices, and :arg index: Comma-separated list of data streams, indices, and
aliases used to limit the request.Supports wildcards (`*`).To target all aliases used to limit the request. Supports wildcards (`*`). To target
data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg cluster_manager_timeout: Operation timeout for connection :arg cluster_manager_timeout: Operation timeout for connection
to cluster-manager node. to cluster-manager node.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -777,7 +777,7 @@ class IndicesClient(NamespacedClient):
the local node only. Default is false. the local node only. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -818,15 +818,15 @@ class IndicesClient(NamespacedClient):
all data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -891,13 +891,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -938,15 +938,15 @@ class IndicesClient(NamespacedClient):
streams and indices, omit this parameter or use `*` or `_all`. streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -998,15 +998,15 @@ class IndicesClient(NamespacedClient):
or `_all`. or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1055,13 +1055,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1107,13 +1107,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1164,8 +1164,8 @@ class IndicesClient(NamespacedClient):
to the master node. If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg order: Order in which OpenSearch applies this template if :arg order: Order in which OpenSearch applies this template if
index matches multiple templates.Templates with lower 'order' values are index matches multiple templates. Templates with lower 'order' values
merged first. Templates with higher'order' values are merged later, are merged first. Templates with higher 'order' values are merged later,
overriding templates with lower values. overriding templates with lower values.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -1272,7 +1272,7 @@ class IndicesClient(NamespacedClient):
the local node only. Default is false. the local node only. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -1315,13 +1315,13 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -1374,8 +1374,8 @@ class IndicesClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1389,8 +1389,8 @@ class IndicesClient(NamespacedClient):
:arg include_defaults: If `true`, return all default settings in :arg include_defaults: If `true`, return all default settings in
the response. Default is false. the response. Default is false.
:arg local: If `true`, the request retrieves information from :arg local: If `true`, the request retrieves information from
the local node only. If`false`, information is retrieved from the master the local node only. If `false`, information is retrieved from the
node. Default is false. master node. Default is false.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node. If no response is received before the timeout to the master node. If no response is received before the timeout
@@ -1446,7 +1446,7 @@ class IndicesClient(NamespacedClient):
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match. If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as`open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
@@ -1467,7 +1467,7 @@ class IndicesClient(NamespacedClient):
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response. If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
if body in SKIP_IN_PATH: if body in SKIP_IN_PATH:
@@ -1519,7 +1519,7 @@ class IndicesClient(NamespacedClient):
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match. If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values,such as `open,hidden`. Valid choices are all, closed, separated values, such as `open,hidden`. Valid choices are all, closed,
hidden, none, open. hidden, none, open.
:arg fielddata_fields: Comma-separated list or wildcard :arg fielddata_fields: Comma-separated list or wildcard
expressions of fields to include in fielddata statistics. expressions of fields to include in fielddata statistics.
@@ -1577,15 +1577,15 @@ class IndicesClient(NamespacedClient):
all data streams and indices, omit this parameter or use `*` or `_all`. all data streams and indices, omit this parameter or use `*` or `_all`.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1641,25 +1641,25 @@ class IndicesClient(NamespacedClient):
shards instead of one random shard per index. shards instead of one random shard per index.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg analyze_wildcard: If `true`, wildcard and prefix queries :arg analyze_wildcard: If `true`, wildcard and prefix queries
are analyzed. Default is false. are analyzed. Default is false.
:arg analyzer: Analyzer to use for the query string.This :arg analyzer: Analyzer to use for the query string. This
parameter can only be used when the `q` query string parameter is parameter can only be used when the `q` query string parameter is
specified. specified.
:arg default_operator: The default operator for query string :arg default_operator: The default operator for query string
query: `AND` or `OR`. Valid choices are and, or. query: `AND` or `OR`. Valid choices are and, or.
:arg df: Field to use as default where no field prefix is given :arg df: Field to use as default where no field prefix is given
in the query string.This parameter can only be used when the `q` query in the query string. This parameter can only be used when the `q` query
string parameter is specified. string parameter is specified.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg explain: If `true`, the response returns detailed :arg explain: If `true`, the response returns detailed
information if an error has occurred. information if an error has occurred.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1715,16 +1715,16 @@ class IndicesClient(NamespacedClient):
string to perform the operation on all indices. string to perform the operation on all indices.
:arg allow_no_indices: If `false`, the request returns an error :arg allow_no_indices: If `false`, the request returns an error
if any wildcard expression, index alias, or `_all` value targets only if any wildcard expression, index alias, or `_all` value targets only
missing or closed indices.This behavior applies even if the request missing or closed indices. This behavior applies even if the request
targets other open indices. targets other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg fielddata: If `true`, clears the fields cache.Use the :arg fielddata: If `true`, clears the fields cache. Use the
`fields` parameter to clear the cache of specific fields only. `fields` parameter to clear the cache of specific fields only.
:arg fields: Comma-separated list of field names used to limit :arg fields: Comma-separated list of field names used to limit
the `fielddata` parameter. the `fielddata` parameter.
@@ -1908,13 +1908,13 @@ class IndicesClient(NamespacedClient):
:arg index: List of data streams, indices, and aliases used to :arg index: List of data streams, indices, and aliases used to
limit the request. limit the request.
:arg allow_no_indices: If false, the request returns an error if :arg allow_no_indices: If false, the request returns an error if
any wildcard expression, index alias, or _allvalue targets only missing any wildcard expression, index alias, or _all value targets only missing
or closed indices. This behavior applies even if the request targets or closed indices. This behavior applies even if the request targets
other open indices. other open indices.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match. If the request can target data streams,this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams. Valid choices whether wildcard expressions match hidden data streams. Valid choices
are all, closed, hidden, none, open. are all, closed, hidden, none, open.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1978,8 +1978,8 @@ class IndicesClient(NamespacedClient):
:arg ignore_unavailable: Whether specified concrete indices :arg ignore_unavailable: Whether specified concrete indices
should be ignored when unavailable (missing or closed) should be ignored when unavailable (missing or closed)
:arg max_num_segments: The number of larger segments into which :arg max_num_segments: The number of larger segments into which
smaller segments are merged.Set this parameter to 1 to merge all smaller segments are merged. Set this parameter to 1 to merge all
segments into one segment.The default behavior is to perform the merge segments into one segment. The default behavior is to perform the merge
as necessary. as necessary.
:arg only_expunge_deletes: Specify whether the operation should :arg only_expunge_deletes: Specify whether the operation should
only expunge deleted documents only expunge deleted documents
@@ -2038,7 +2038,7 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -2046,11 +2046,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -2111,7 +2111,7 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -2119,11 +2119,11 @@ class IndicesClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg task_execution_timeout: Explicit task execution timeout, :arg task_execution_timeout: Explicit task execution timeout,
only useful when wait_for_completion is false, defaults to 1h. only useful when wait_for_completion is false, defaults to 1h.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to `all` or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
:arg wait_for_completion: Should this request wait until the :arg wait_for_completion: Should this request wait until the
@@ -2184,17 +2184,17 @@ class IndicesClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_active_shards: The number of shard copies that :arg wait_for_active_shards: The number of shard copies that
must be active before proceeding with the operation.Set to all or any 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 positive integer up to the total number of shards in the index
(`number_of_replicas+1`). Valid choices are all, index-setting. (`number_of_replicas+1`). Valid choices are all, index-setting.
""" """
@@ -2521,9 +2521,9 @@ class IndicesClient(NamespacedClient):
to cluster-manager node. to cluster-manager node.
:arg create: If `true`, the template passed in the body is only :arg create: If `true`, the template passed in the body is only
used if no existing templates match the same index patterns. If `false`, used if no existing templates match the same index patterns. If `false`,
the simulation uses the template with the highest priority. Note that the the simulation uses the template with the highest priority. Note that
template is not permanently added or updated in either case; it is only the template is not permanently added or updated in either case; it is
used for the simulation. Default is false. only used for the simulation. Default is false.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2655,10 +2655,10 @@ class IndicesClient(NamespacedClient):
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg expand_wildcards: Type of index that wildcard patterns can :arg expand_wildcards: Type of index that wildcard patterns can
match.If the request can target data streams, this argument determines match. If the request can target data streams, this argument determines
whether wildcard expressions match hidden data streams.Supports comma- whether wildcard expressions match hidden data streams. Supports comma-
separated values, such as `open,hidden`.Valid values are: `all`, `open`, separated values, such as `open,hidden`. Valid values are: `all`,
`closed`, `hidden`, `none`. `open`, `closed`, `hidden`, `none`.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
opensearchpy/client/ingest.py
+3 -3
View File
@@ -72,7 +72,7 @@ class IngestClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
@@ -171,13 +171,13 @@ class IngestClient(NamespacedClient):
statistics. statistics.
:arg master_timeout (Deprecated: To promote inclusive language, :arg master_timeout (Deprecated: To promote inclusive language,
use 'cluster_manager_timeout' instead.): Period to wait for a connection use 'cluster_manager_timeout' instead.): Period to wait for a connection
to the master node.If no response is received before the timeout to the master node. If no response is received before the timeout
expires, the request fails and returns an error. expires, the request fails and returns an error.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
opensearchpy/client/nodes.py
+2 -2
View File
@@ -66,7 +66,7 @@ class NodesClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
@@ -282,7 +282,7 @@ class NodesClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
""" """
opensearchpy/client/plugins.py
+14 -10
View File
@@ -15,7 +15,11 @@ from ..plugins.index_management import IndexManagementClient
from ..plugins.knn import KnnClient from ..plugins.knn import KnnClient
from ..plugins.ml import MlClient from ..plugins.ml import MlClient
from ..plugins.notifications import NotificationsClient from ..plugins.notifications import NotificationsClient
from ..plugins.observability import ObservabilityClient
from ..plugins.ppl import PplClient
from ..plugins.query import QueryClient
from ..plugins.rollups import RollupsClient from ..plugins.rollups import RollupsClient
from ..plugins.sql import SqlClient
from ..plugins.transforms import TransformsClient from ..plugins.transforms import TransformsClient
from .client import Client from .client import Client
from .utils import NamespacedClient from .utils import NamespacedClient
@@ -27,18 +31,18 @@ class PluginsClient(NamespacedClient):
def __init__(self, client: Client) -> None: def __init__(self, client: Client) -> None:
super().__init__(client) super().__init__(client)
self.ml = MlClient(client)
self.transforms = TransformsClient(client)
self.rollups = RollupsClient(client)
self.notifications = NotificationsClient(client)
self.knn = KnnClient(client)
# self.query_workbench = QueryWorkbenchClient(client)
# self.reporting = ReportingClient(client)
# self.notebooks = NotebooksClient(client)
self.alerting = AlertingClient(client) self.alerting = AlertingClient(client)
# self.anomaly_detection = AnomalyDetectionClient(client)
# self.trace_analytics = TraceAnalyticsClient(client)
self.index_management = IndexManagementClient(client) self.index_management = IndexManagementClient(client)
self.knn = KnnClient(client)
self.ml = MlClient(client)
self.notifications = NotificationsClient(client)
self.observability = ObservabilityClient(client)
self.ppl = PplClient(client)
self.query = QueryClient(client)
self.rollups = RollupsClient(client)
self.sql = SqlClient(client)
self.transforms = TransformsClient(client)
self._dynamic_lookup(client) self._dynamic_lookup(client)
opensearchpy/client/security.py
+134 -12
View File
@@ -93,7 +93,7 @@ class SecurityClient(NamespacedClient):
Retrieves one action group. Retrieves one action group.
:arg action_group: Action group to retrieve. :arg action_group: The name of the action group to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -156,7 +156,7 @@ class SecurityClient(NamespacedClient):
Delete a specified action group. Delete a specified action group.
:arg action_group: Action group to delete. :arg action_group: The name of the action group to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -229,6 +229,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of an action group. Updates individual attributes of an action group.
:arg action_group: The name of the action group to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -296,6 +297,7 @@ class SecurityClient(NamespacedClient):
Retrieve one internal user. Retrieve one internal user.
:arg username: The name of the user to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -356,6 +358,7 @@ class SecurityClient(NamespacedClient):
Delete the specified user. Delete the specified user.
:arg username: The name of the user to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -389,6 +392,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified user. Creates or replaces the specified user.
:arg username: The name of the user to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -424,6 +428,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of an internal user. Updates individual attributes of an internal user.
:arg username: The name of the user to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -548,6 +553,7 @@ class SecurityClient(NamespacedClient):
Delete the specified role. Delete the specified role.
:arg role: The name of the role to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -581,6 +587,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified role. Creates or replaces the specified role.
:arg role: The name of the role to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -616,6 +623,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of a role. Updates individual attributes of a role.
:arg role: The name of the role to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -743,6 +751,7 @@ class SecurityClient(NamespacedClient):
Deletes the specified role mapping. Deletes the specified 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -776,6 +785,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified role mapping. Creates or replaces the specified 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -811,6 +821,7 @@ class SecurityClient(NamespacedClient):
Updates individual attributes of a role mapping. Updates individual attributes of a 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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -878,6 +889,7 @@ class SecurityClient(NamespacedClient):
Retrieves one tenant. Retrieves one tenant.
:arg tenant: The name of the tenant to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -935,6 +947,7 @@ class SecurityClient(NamespacedClient):
Delete the specified tenant. Delete the specified tenant.
:arg tenant: The name of the tenant to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -968,6 +981,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified tenant. Creates or replaces the specified tenant.
:arg tenant: The name of the tenant to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1003,6 +1017,7 @@ class SecurityClient(NamespacedClient):
Add, delete, or modify a single tenant. Add, delete, or modify a single tenant.
:arg tenant: The name of the tenant to update.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1175,6 +1190,8 @@ class SecurityClient(NamespacedClient):
statistics. statistics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg show_all: A boolean flag to include/exclude static nodes DN
from final result.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -1304,6 +1321,9 @@ class SecurityClient(NamespacedClient):
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
: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 :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
@@ -1547,7 +1567,10 @@ class SecurityClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
return self.transport.perform_request( return self.transport.perform_request(
"GET", "/_plugins/_security/_upgrade_check", params=params, headers=headers "GET",
"/_plugins/_security/api/_upgrade_check",
params=params,
headers=headers,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
@@ -1574,7 +1597,7 @@ class SecurityClient(NamespacedClient):
""" """
return self.transport.perform_request( return self.transport.perform_request(
"POST", "POST",
"/_plugins/_security/_upgrade_perform", "/_plugins/_security/api/_upgrade_perform",
params=params, params=params,
headers=headers, headers=headers,
body=body, body=body,
@@ -1660,6 +1683,7 @@ class SecurityClient(NamespacedClient):
Creates or replaces the specified user. Legacy API. Creates or replaces the specified user. Legacy API.
:arg username: The name of the user to be created.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1695,6 +1719,8 @@ class SecurityClient(NamespacedClient):
Only accessible to super-admins and with rest-api permissions when enabled. Only accessible to super-admins and with rest-api permissions when enabled.
:arg cluster_name: The cluster-name to delete from list of
distinguished names.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1729,6 +1755,7 @@ class SecurityClient(NamespacedClient):
Delete the specified user. Legacy API. Delete the specified user. Legacy API.
:arg username: The name of the user to delete.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1794,6 +1821,8 @@ class SecurityClient(NamespacedClient):
Generates authorization token for the given user. Generates authorization token for the given user.
: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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1825,9 +1854,11 @@ class SecurityClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
Generates authorization token for the given user. Legacy API. Generates authorization token for the given user. Legacy API. Not Implemented.
: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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1911,6 +1942,8 @@ class SecurityClient(NamespacedClient):
api permissions when enabled. api permissions when enabled.
:arg cluster_name: The cluster-name to retrieve nodes DN setting
for.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1919,6 +1952,8 @@ class SecurityClient(NamespacedClient):
statistics. statistics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg show_all: A boolean flag to include/exclude static nodes DN
from final result.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -1980,7 +2015,8 @@ class SecurityClient(NamespacedClient):
statistics. statistics.
:arg pretty: Whether to pretty format the returned JSON :arg pretty: Whether to pretty format the returned JSON
response. response.
:arg show_dn: The domain names from all certificates. :arg show_dn: A boolean flag to indicate whether all domain
names should be returned.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
@@ -2028,6 +2064,7 @@ class SecurityClient(NamespacedClient):
Retrieve one user. Legacy API. Retrieve one user. Legacy API.
:arg username: The name of the user to retrieve.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2145,6 +2182,7 @@ class SecurityClient(NamespacedClient):
super-admins and with rest-api permissions when enabled. super-admins and with rest-api permissions when enabled.
:arg cluster_name: The cluster-name to update nodesDn value.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2172,7 +2210,6 @@ class SecurityClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
def post_dashboards_info( def post_dashboards_info(
self, self,
body: Any = None,
params: Any = None, params: Any = None,
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
@@ -2192,11 +2229,7 @@ class SecurityClient(NamespacedClient):
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
""" """
return self.transport.perform_request( return self.transport.perform_request(
"POST", "POST", "/_plugins/_security/dashboardsinfo", params=params, headers=headers
"/_plugins/_security/dashboardsinfo",
params=params,
headers=headers,
body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source") @query_params("error_trace", "filter_path", "human", "pretty", "source")
@@ -2239,6 +2272,8 @@ class SecurityClient(NamespacedClient):
enabled. enabled.
:arg cluster_name: The cluster-name to create/update nodesDn
value for.
:arg error_trace: Whether to include the stack trace of returned :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2276,6 +2311,8 @@ class SecurityClient(NamespacedClient):
to v7. to v7.
: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 :arg error_trace: Whether to include the stack trace of returned
errors. errors.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -2342,3 +2379,88 @@ class SecurityClient(NamespacedClient):
return self.transport.perform_request( return self.transport.perform_request(
"GET", "/_plugins/_security/whoamiprotected", params=params, headers=headers "GET", "/_plugins/_security/whoamiprotected", params=params, headers=headers
) )
@query_params(
"cert_type",
"error_trace",
"filter_path",
"human",
"pretty",
"source",
"timeout",
)
def get_all_certificates(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves the cluster security 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.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
:arg timeout: The maximum duration, in seconds, to be spent to
retrieve certificates from all nodes.
"""
return self.transport.perform_request(
"GET",
"/_plugins/_security/api/certificates",
params=params,
headers=headers,
)
@query_params(
"cert_type",
"error_trace",
"filter_path",
"human",
"pretty",
"source",
"timeout",
)
def get_node_certificates(
self,
node_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves the given node's security certificates.
:arg node_id: The full-id of the node to retrieve 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.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
:arg timeout: The maximum duration, in seconds, to be spent to
retrieve a node's certificates.
"""
if node_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'node_id'.")
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_security", "api", "certificates", node_id),
params=params,
headers=headers,
)
opensearchpy/client/tasks.py
+1 -1
View File
@@ -175,7 +175,7 @@ class TasksClient(NamespacedClient):
response. response.
:arg source: The URL-encoded request definition. Useful for :arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests. libraries that do not accept a request body for non-POST requests.
:arg timeout: Period to wait for a response.If no response is :arg timeout: Period to wait for a response. If no response is
received before the timeout expires, the request fails and returns an received before the timeout expires, the request fails and returns an
error. error.
:arg wait_for_completion: If `true`, the request blocks until :arg wait_for_completion: If `true`, the request blocks until
opensearchpy/plugins/ml.py
+64
View File
@@ -243,3 +243,67 @@ class MlClient(NamespacedClient):
headers=headers, headers=headers,
body=body, body=body,
) )
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def deploy_model(
self,
model_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deploys a model.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if model_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'model_id'.")
return self.transport.perform_request(
"POST",
_make_path("_plugins", "_ml", "models", model_id, "_deploy"),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def undeploy_model(
self,
model_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Undeploys a model.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if model_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'model_id'.")
return self.transport.perform_request(
"POST",
_make_path("_plugins", "_ml", "models", model_id, "_undeploy"),
params=params,
headers=headers,
)
opensearchpy/plugins/observability.py
+244
View File
@@ -0,0 +1,244 @@
# 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 ObservabilityClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def create_object(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Creates a new observability object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return self.transport.perform_request(
"POST",
"/_plugins/_observability/object",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def delete_object(
self,
object_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes specific observability object specified by ID.
:arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if object_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'object_id'.")
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_observability", "object", object_id),
params=params,
headers=headers,
)
@query_params(
"error_trace",
"filter_path",
"human",
"objectId",
"objectIdList",
"pretty",
"source",
)
def delete_objects(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes specific observability objects specified by ID or a list of IDs.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
: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.
: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(
"DELETE", "/_plugins/_observability/object", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def get_localstats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves Local Stats of all observability objects.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return self.transport.perform_request(
"GET",
"/_plugins/_observability/_local/stats",
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def get_object(
self,
object_id: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves specific observability object specified by ID.
:arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if object_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'object_id'.")
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_observability", "object", object_id),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def list_objects(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves list of all observability objects.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return self.transport.perform_request(
"GET", "/_plugins/_observability/object", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def update_object(
self,
object_id: Any,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Updates an existing observability object.
:arg object_id: The ID of the Observability Object.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if object_id in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'object_id'.")
return self.transport.perform_request(
"PUT",
_make_path("_plugins", "_observability", "object", object_id),
params=params,
headers=headers,
body=body,
)
opensearchpy/plugins/ppl.py
+160
View File
@@ -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 ..client.utils import SKIP_IN_PATH, NamespacedClient, query_params
class PplClient(NamespacedClient):
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def explain(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Shows how a query is executed against OpenSearch.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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/_ppl/_explain", params=params, headers=headers, body=body
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def get_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Collect metrics for the plugin within the interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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.
"""
return self.transport.perform_request(
"GET", "/_plugins/_ppl/stats", params=params, headers=headers
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def post_stats(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
By a stats endpoint, you are able to collect metrics for the plugin within the
interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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/_ppl/stats", params=params, headers=headers, body=body
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def query(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Send a PPL query to the PPL plugin.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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/_ppl", params=params, headers=headers, body=body
)
opensearchpy/plugins/query.py
+178
View File
@@ -0,0 +1,178 @@
# 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 QueryClient(NamespacedClient):
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def datasource_delete(
self,
datasource_name: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Deletes specific datasource specified by name.
:arg datasource_name: The Name of the DataSource to delete.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if datasource_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'datasource_name'."
)
return self.transport.perform_request(
"DELETE",
_make_path("_plugins", "_query", "_datasources", datasource_name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def datasource_retrieve(
self,
datasource_name: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves specific datasource specified by name.
:arg datasource_name: The Name of the DataSource to retrieve.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if datasource_name in SKIP_IN_PATH:
raise ValueError(
"Empty value passed for a required argument 'datasource_name'."
)
return self.transport.perform_request(
"GET",
_make_path("_plugins", "_query", "_datasources", datasource_name),
params=params,
headers=headers,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def datasources_create(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Creates a new query datasource.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return self.transport.perform_request(
"POST",
"/_plugins/_query/_datasources",
params=params,
headers=headers,
body=body,
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def datasources_list(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Retrieves list of all datasources.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return self.transport.perform_request(
"GET", "/_plugins/_query/_datasources", params=params, headers=headers
)
@query_params("error_trace", "filter_path", "human", "pretty", "source")
def datasources_update(
self,
body: Any = None,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Updates an existing query datasource.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
return self.transport.perform_request(
"PUT",
"/_plugins/_query/_datasources",
params=params,
headers=headers,
body=body,
)
opensearchpy/plugins/sql.py
+230
View File
@@ -0,0 +1,230 @@
# 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, query_params
class SqlClient(NamespacedClient):
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def close(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Clear the cursor context.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def explain(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Shows how a query is executed against OpenSearch.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def get_stats(
self,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Collect metrics for the plugin within the interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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.
"""
return self.transport.perform_request(
"GET", "/_plugins/_sql/stats", params=params, headers=headers
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def post_stats(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
By a stats endpoint, you are able to collect metrics for the plugin within the
interval.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params(
"error_trace", "filter_path", "format", "human", "pretty", "sanitize", "source"
)
def query(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Send a SQL/PPL query to the SQL plugin.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
: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
)
@query_params("error_trace", "filter_path", "format", "human", "pretty", "source")
def settings(
self,
body: Any,
params: Any = None,
headers: Any = None,
) -> Any:
"""
Adds SQL settings to the standard OpenSearch cluster settings.
:arg error_trace: Whether to include the stack trace of returned
errors.
:arg filter_path: Comma-separated list of filters used to reduce
the response.
:arg format: A short version of the Accept header, e.g. json,
yaml.
:arg human: Whether to return human readable values for
statistics.
:arg pretty: Whether to pretty format the returned JSON
response.
:arg source: The URL-encoded request definition. Useful for
libraries that do not accept a request body for non-POST requests.
"""
if body in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'body'.")
return self.transport.perform_request(
"PUT",
"/_plugins/_query/settings",
params=params,
headers=headers,
body=body,
)
opensearchpy/plugins/transforms.py
+1 -1
View File
@@ -282,7 +282,7 @@ class TransformsClient(NamespacedClient):
headers: Any = None, headers: Any = None,
) -> Any: ) -> Any:
""" """
stop transform. Stop transform.
:arg id: Transform to stop :arg id: Transform to stop
samples/README.md
+13 -3
View File
@@ -1,13 +1,23 @@
# OpenSearch Python Samples # OpenSearch Python Samples
Most samples can be run using OpenSearch installed locally with docker. Most samples can be run using OpenSearch installed locally with Docker.
## Admin User Password
Add the default `admin` password to the environment.
```
export OPENSEARCH_PASSWORD=myStrongPassword123!
```
## Start the Container
``` ```
docker pull opensearchproject/opensearch:latest docker pull opensearchproject/opensearch:latest
docker run -d -p 9200:9200 -p 9600:9600 -e "discovery.type=single-node" opensearchproject/opensearch:latest docker run -d -p 9200:9200 -p 9600:9600 -e OPENSEARCH_INITIAL_ADMIN_PASSWORD=$OPENSEARCH_PASSWORD -e "discovery.type=single-node" opensearchproject/opensearch:latest
``` ```
## Prerequisites ## Install Python Prerequisites
Install [poetry](https://python-poetry.org/docs/). Install [poetry](https://python-poetry.org/docs/).
samples/advanced_index_actions/advanced_index_actions_sample.py
+2 -1
View File
@@ -8,6 +8,7 @@
# #
# Modifications Copyright OpenSearch Contributors. See # Modifications Copyright OpenSearch Contributors. See
# GitHub history for details. # GitHub history for details.
import os
import time import time
from opensearchpy import OpenSearch from opensearchpy import OpenSearch
@@ -27,7 +28,7 @@ def main() -> None:
hosts=["https://localhost:9200"], hosts=["https://localhost:9200"],
use_ssl=True, use_ssl=True,
verify_certs=False, verify_certs=False,
http_auth=("admin", "admin"), http_auth=("admin", os.getenv("OPENSEARCH_PASSWORD", "admin")),
) )
client.indices.create(index="movies") client.indices.create(index="movies")
print("'movies' index created!") print("'movies' index created!")
samples/document_lifecycle/document_lifecycle_sample.py
+3 -1
View File
@@ -9,6 +9,8 @@
# Modifications Copyright OpenSearch Contributors. See # Modifications Copyright OpenSearch Contributors. See
# GitHub history for details. # GitHub history for details.
import os
from opensearchpy import OpenSearch from opensearchpy import OpenSearch
# For cleaner output, comment in the two lines below to disable warnings and informational messages # For cleaner output, comment in the two lines below to disable warnings and informational messages
@@ -26,7 +28,7 @@ def main() -> None:
hosts=["https://localhost:9200"], hosts=["https://localhost:9200"],
use_ssl=True, use_ssl=True,
verify_certs=False, verify_certs=False,
http_auth=("admin", "admin"), http_auth=("admin", os.getenv("OPENSEARCH_PASSWORD", "admin")),
) )
# Create an index # Create an index
samples/hello/hello.py
+6 -1
View File
@@ -10,6 +10,8 @@
# GitHub history for details. # GitHub history for details.
import os
from opensearchpy import OpenSearch from opensearchpy import OpenSearch
# connect to OpenSearch # connect to OpenSearch
@@ -23,7 +25,10 @@ def main() -> None:
""" """
host = "localhost" host = "localhost"
port = 9200 port = 9200
auth = ("admin", "admin") # For testing only. Don't store credentials in code. auth = (
"admin",
os.getenv("OPENSEARCH_PASSWORD", "admin"),
) # For testing only. Don't store credentials in code.
client = OpenSearch( client = OpenSearch(
hosts=[{"host": host, "port": port}], hosts=[{"host": host, "port": port}],
samples/hello/hello_async.py
+5 -1
View File
@@ -11,6 +11,7 @@
import asyncio import asyncio
import os
from opensearchpy import AsyncOpenSearch from opensearchpy import AsyncOpenSearch
@@ -24,7 +25,10 @@ async def main() -> None:
# connect to OpenSearch # connect to OpenSearch
host = "localhost" host = "localhost"
port = 9200 port = 9200
auth = ("admin", "admin") # For testing only. Don't store credentials in code. auth = (
"admin",
os.getenv("OPENSEARCH_PASSWORD", "admin"),
) # For testing only. Don't store credentials in code.
client = AsyncOpenSearch( client = AsyncOpenSearch(
hosts=[{"host": host, "port": port}], hosts=[{"host": host, "port": port}],
samples/index_template/index_template_sample.py
+3 -1
View File
@@ -8,6 +8,8 @@
# #
# Modifications Copyright OpenSearch Contributors. See # Modifications Copyright OpenSearch Contributors. See
# GitHub history for details. # GitHub history for details.
import os
from opensearchpy import OpenSearch from opensearchpy import OpenSearch
@@ -32,7 +34,7 @@ def main() -> None:
hosts=["https://localhost:9200"], hosts=["https://localhost:9200"],
use_ssl=True, use_ssl=True,
verify_certs=False, verify_certs=False,
http_auth=("admin", "admin"), http_auth=("admin", os.getenv("OPENSEARCH_PASSWORD", "admin")),
) )
# create an index template # create an index template
samples/json/json_hello.py
+6 -1
View File
@@ -10,6 +10,8 @@
# GitHub history for details. # GitHub history for details.
import os
from opensearchpy import OpenSearch from opensearchpy import OpenSearch
@@ -21,7 +23,10 @@ def main() -> None:
host = "localhost" host = "localhost"
port = 9200 port = 9200
auth = ("admin", "admin") # For testing only. Don't store credentials in code. auth = (
"admin",
os.getenv("OPENSEARCH_PASSWORD", "admin"),
) # For testing only. Don't store credentials in code.
client = OpenSearch( client = OpenSearch(
hosts=[{"host": host, "port": port}], hosts=[{"host": host, "port": port}],
samples/json/json_hello_async.py
+5 -1
View File
@@ -11,6 +11,7 @@
import asyncio import asyncio
import os
from opensearchpy import AsyncOpenSearch from opensearchpy import AsyncOpenSearch
@@ -24,7 +25,10 @@ async def main() -> None:
# connect to OpenSearch # connect to OpenSearch
host = "localhost" host = "localhost"
port = 9200 port = 9200
auth = ("admin", "admin") # For testing only. Don't store credentials in code. auth = (
"admin",
os.getenv("OPENSEARCH_PASSWORD", "admin"),
) # For testing only. Don't store credentials in code.
client = AsyncOpenSearch( client = AsyncOpenSearch(
hosts=[{"host": host, "port": port}], hosts=[{"host": host, "port": port}],
samples/logging/log_collection_sample.py
+2 -1
View File
@@ -10,6 +10,7 @@
# GitHub history for details. # GitHub history for details.
import logging import logging
import os
import queue import queue
from datetime import datetime from datetime import datetime
from logging.handlers import QueueHandler, QueueListener from logging.handlers import QueueHandler, QueueListener
@@ -41,7 +42,7 @@ def main() -> None:
use_ssl=True, use_ssl=True,
verify_certs=False, verify_certs=False,
ssl_show_warn=False, ssl_show_warn=False,
http_auth=("admin", "admin"), http_auth=("admin", os.getenv("OPENSEARCH_PASSWORD", "admin")),
) )
# Initialize a logger named "OpenSearchLogs" for OpenSearch # Initialize a logger named "OpenSearchLogs" for OpenSearch
samples/poetry.lock
Generated
+433 -355
View File
@@ -1,91 +1,103 @@
# This file is automatically @generated by Poetry 1.6.1 and should not be changed by hand. # This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand.
[[package]]
name = "aiohappyeyeballs"
version = "2.3.5"
description = "Happy Eyeballs for asyncio"
optional = false
python-versions = ">=3.8"
files = [
{file = "aiohappyeyeballs-2.3.5-py3-none-any.whl", hash = "sha256:4d6dea59215537dbc746e93e779caea8178c866856a721c9c660d7a5a7b8be03"},
{file = "aiohappyeyeballs-2.3.5.tar.gz", hash = "sha256:6fa48b9f1317254f122a07a131a86b71ca6946ca989ce6326fff54a99a920105"},
]
[[package]] [[package]]
name = "aiohttp" name = "aiohttp"
version = "3.9.3" version = "3.10.3"
description = "Async http client/server framework (asyncio)" description = "Async http client/server framework (asyncio)"
optional = false optional = false
python-versions = ">=3.8" python-versions = ">=3.8"
files = [ files = [
{file = "aiohttp-3.9.3-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:939677b61f9d72a4fa2a042a5eee2a99a24001a67c13da113b2e30396567db54"}, {file = "aiohttp-3.10.3-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:cc36cbdedf6f259371dbbbcaae5bb0e95b879bc501668ab6306af867577eb5db"},
{file = "aiohttp-3.9.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:1f5cd333fcf7590a18334c90f8c9147c837a6ec8a178e88d90a9b96ea03194cc"}, {file = "aiohttp-3.10.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:85466b5a695c2a7db13eb2c200af552d13e6a9313d7fa92e4ffe04a2c0ea74c1"},
{file = "aiohttp-3.9.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:82e6aa28dd46374f72093eda8bcd142f7771ee1eb9d1e223ff0fa7177a96b4a5"}, {file = "aiohttp-3.10.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:71bb1d97bfe7e6726267cea169fdf5df7658831bb68ec02c9c6b9f3511e108bb"},
{file = "aiohttp-3.9.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f56455b0c2c7cc3b0c584815264461d07b177f903a04481dfc33e08a89f0c26b"}, {file = "aiohttp-3.10.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:baec1eb274f78b2de54471fc4c69ecbea4275965eab4b556ef7a7698dee18bf2"},
{file = "aiohttp-3.9.3-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:bca77a198bb6e69795ef2f09a5f4c12758487f83f33d63acde5f0d4919815768"}, {file = "aiohttp-3.10.3-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:13031e7ec1188274bad243255c328cc3019e36a5a907978501256000d57a7201"},
{file = "aiohttp-3.9.3-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e083c285857b78ee21a96ba1eb1b5339733c3563f72980728ca2b08b53826ca5"}, {file = "aiohttp-3.10.3-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2bbc55a964b8eecb341e492ae91c3bd0848324d313e1e71a27e3d96e6ee7e8e8"},
{file = "aiohttp-3.9.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:ab40e6251c3873d86ea9b30a1ac6d7478c09277b32e14745d0d3c6e76e3c7e29"}, {file = "aiohttp-3.10.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e8cc0564b286b625e673a2615ede60a1704d0cbbf1b24604e28c31ed37dc62aa"},
{file = "aiohttp-3.9.3-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:df822ee7feaaeffb99c1a9e5e608800bd8eda6e5f18f5cfb0dc7eeb2eaa6bbec"}, {file = "aiohttp-3.10.3-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f817a54059a4cfbc385a7f51696359c642088710e731e8df80d0607193ed2b73"},
{file = "aiohttp-3.9.3-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:acef0899fea7492145d2bbaaaec7b345c87753168589cc7faf0afec9afe9b747"}, {file = "aiohttp-3.10.3-cp310-cp310-musllinux_1_2_aarch64.whl", hash = "sha256:8542c9e5bcb2bd3115acdf5adc41cda394e7360916197805e7e32b93d821ef93"},
{file = "aiohttp-3.9.3-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:cd73265a9e5ea618014802ab01babf1940cecb90c9762d8b9e7d2cc1e1969ec6"}, {file = "aiohttp-3.10.3-cp310-cp310-musllinux_1_2_i686.whl", hash = "sha256:671efce3a4a0281060edf9a07a2f7e6230dca3a1cbc61d110eee7753d28405f7"},
{file = "aiohttp-3.9.3-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:a78ed8a53a1221393d9637c01870248a6f4ea5b214a59a92a36f18151739452c"}, {file = "aiohttp-3.10.3-cp310-cp310-musllinux_1_2_ppc64le.whl", hash = "sha256:0974f3b5b0132edcec92c3306f858ad4356a63d26b18021d859c9927616ebf27"},
{file = "aiohttp-3.9.3-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:6b0e029353361f1746bac2e4cc19b32f972ec03f0f943b390c4ab3371840aabf"}, {file = "aiohttp-3.10.3-cp310-cp310-musllinux_1_2_s390x.whl", hash = "sha256:44bb159b55926b57812dca1b21c34528e800963ffe130d08b049b2d6b994ada7"},
{file = "aiohttp-3.9.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:7cf5c9458e1e90e3c390c2639f1017a0379a99a94fdfad3a1fd966a2874bba52"}, {file = "aiohttp-3.10.3-cp310-cp310-musllinux_1_2_x86_64.whl", hash = "sha256:6ae9ae382d1c9617a91647575255ad55a48bfdde34cc2185dd558ce476bf16e9"},
{file = "aiohttp-3.9.3-cp310-cp310-win32.whl", hash = "sha256:3e59c23c52765951b69ec45ddbbc9403a8761ee6f57253250c6e1536cacc758b"}, {file = "aiohttp-3.10.3-cp310-cp310-win32.whl", hash = "sha256:aed12a54d4e1ee647376fa541e1b7621505001f9f939debf51397b9329fd88b9"},
{file = "aiohttp-3.9.3-cp310-cp310-win_amd64.whl", hash = "sha256:055ce4f74b82551678291473f66dc9fb9048a50d8324278751926ff0ae7715e5"}, {file = "aiohttp-3.10.3-cp310-cp310-win_amd64.whl", hash = "sha256:b51aef59370baf7444de1572f7830f59ddbabd04e5292fa4218d02f085f8d299"},
{file = "aiohttp-3.9.3-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:6b88f9386ff1ad91ace19d2a1c0225896e28815ee09fc6a8932fded8cda97c3d"}, {file = "aiohttp-3.10.3-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:e021c4c778644e8cdc09487d65564265e6b149896a17d7c0f52e9a088cc44e1b"},
{file = "aiohttp-3.9.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:c46956ed82961e31557b6857a5ca153c67e5476972e5f7190015018760938da2"}, {file = "aiohttp-3.10.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:24fade6dae446b183e2410a8628b80df9b7a42205c6bfc2eff783cbeedc224a2"},
{file = "aiohttp-3.9.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:07b837ef0d2f252f96009e9b8435ec1fef68ef8b1461933253d318748ec1acdc"}, {file = "aiohttp-3.10.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:bc8e9f15939dacb0e1f2d15f9c41b786051c10472c7a926f5771e99b49a5957f"},
{file = "aiohttp-3.9.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:dad46e6f620574b3b4801c68255492e0159d1712271cc99d8bdf35f2043ec266"}, {file = "aiohttp-3.10.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d5a9ec959b5381271c8ec9310aae1713b2aec29efa32e232e5ef7dcca0df0279"},
{file = "aiohttp-3.9.3-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5ed3e046ea7b14938112ccd53d91c1539af3e6679b222f9469981e3dac7ba1ce"}, {file = "aiohttp-3.10.3-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2a5d0ea8a6467b15d53b00c4e8ea8811e47c3cc1bdbc62b1aceb3076403d551f"},
{file = "aiohttp-3.9.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:039df344b45ae0b34ac885ab5b53940b174530d4dd8a14ed8b0e2155b9dddccb"}, {file = "aiohttp-3.10.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c9ed607dbbdd0d4d39b597e5bf6b0d40d844dfb0ac6a123ed79042ef08c1f87e"},
{file = "aiohttp-3.9.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:7943c414d3a8d9235f5f15c22ace69787c140c80b718dcd57caaade95f7cd93b"}, {file = "aiohttp-3.10.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d3e66d5b506832e56add66af88c288c1d5ba0c38b535a1a59e436b300b57b23e"},
{file = "aiohttp-3.9.3-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:84871a243359bb42c12728f04d181a389718710129b36b6aad0fc4655a7647d4"}, {file = "aiohttp-3.10.3-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:fda91ad797e4914cca0afa8b6cccd5d2b3569ccc88731be202f6adce39503189"},
{file = "aiohttp-3.9.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:5eafe2c065df5401ba06821b9a054d9cb2848867f3c59801b5d07a0be3a380ae"}, {file = "aiohttp-3.10.3-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:61ccb867b2f2f53df6598eb2a93329b5eee0b00646ee79ea67d68844747a418e"},
{file = "aiohttp-3.9.3-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:9d3c9b50f19704552f23b4eaea1fc082fdd82c63429a6506446cbd8737823da3"}, {file = "aiohttp-3.10.3-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:6d881353264e6156f215b3cb778c9ac3184f5465c2ece5e6fce82e68946868ef"},
{file = "aiohttp-3.9.3-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:f033d80bc6283092613882dfe40419c6a6a1527e04fc69350e87a9df02bbc283"}, {file = "aiohttp-3.10.3-cp311-cp311-musllinux_1_2_ppc64le.whl", hash = "sha256:b031ce229114825f49cec4434fa844ccb5225e266c3e146cb4bdd025a6da52f1"},
{file = "aiohttp-3.9.3-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:2c895a656dd7e061b2fd6bb77d971cc38f2afc277229ce7dd3552de8313a483e"}, {file = "aiohttp-3.10.3-cp311-cp311-musllinux_1_2_s390x.whl", hash = "sha256:5337cc742a03f9e3213b097abff8781f79de7190bbfaa987bd2b7ceb5bb0bdec"},
{file = "aiohttp-3.9.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:1f5a71d25cd8106eab05f8704cd9167b6e5187bcdf8f090a66c6d88b634802b4"}, {file = "aiohttp-3.10.3-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:ab3361159fd3dcd0e48bbe804006d5cfb074b382666e6c064112056eb234f1a9"},
{file = "aiohttp-3.9.3-cp311-cp311-win32.whl", hash = "sha256:50fca156d718f8ced687a373f9e140c1bb765ca16e3d6f4fe116e3df7c05b2c5"}, {file = "aiohttp-3.10.3-cp311-cp311-win32.whl", hash = "sha256:05d66203a530209cbe40f102ebaac0b2214aba2a33c075d0bf825987c36f1f0b"},
{file = "aiohttp-3.9.3-cp311-cp311-win_amd64.whl", hash = "sha256:5fe9ce6c09668063b8447f85d43b8d1c4e5d3d7e92c63173e6180b2ac5d46dd8"}, {file = "aiohttp-3.10.3-cp311-cp311-win_amd64.whl", hash = "sha256:70b4a4984a70a2322b70e088d654528129783ac1ebbf7dd76627b3bd22db2f17"},
{file = "aiohttp-3.9.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:38a19bc3b686ad55804ae931012f78f7a534cce165d089a2059f658f6c91fa60"}, {file = "aiohttp-3.10.3-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:166de65e2e4e63357cfa8417cf952a519ac42f1654cb2d43ed76899e2319b1ee"},
{file = "aiohttp-3.9.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:770d015888c2a598b377bd2f663adfd947d78c0124cfe7b959e1ef39f5b13869"}, {file = "aiohttp-3.10.3-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:7084876352ba3833d5d214e02b32d794e3fd9cf21fdba99cff5acabeb90d9806"},
{file = "aiohttp-3.9.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:ee43080e75fc92bf36219926c8e6de497f9b247301bbf88c5c7593d931426679"}, {file = "aiohttp-3.10.3-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d98c604c93403288591d7d6d7d6cc8a63459168f8846aeffd5b3a7f3b3e5e09"},
{file = "aiohttp-3.9.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:52df73f14ed99cee84865b95a3d9e044f226320a87af208f068ecc33e0c35b96"}, {file = "aiohttp-3.10.3-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d73b073a25a0bb8bf014345374fe2d0f63681ab5da4c22f9d2025ca3e3ea54fc"},
{file = "aiohttp-3.9.3-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:dc9b311743a78043b26ffaeeb9715dc360335e5517832f5a8e339f8a43581e4d"}, {file = "aiohttp-3.10.3-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8da6b48c20ce78f5721068f383e0e113dde034e868f1b2f5ee7cb1e95f91db57"},
{file = "aiohttp-3.9.3-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b955ed993491f1a5da7f92e98d5dad3c1e14dc175f74517c4e610b1f2456fb11"}, {file = "aiohttp-3.10.3-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3a9dcdccf50284b1b0dc72bc57e5bbd3cc9bf019060dfa0668f63241ccc16aa7"},
{file = "aiohttp-3.9.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:504b6981675ace64c28bf4a05a508af5cde526e36492c98916127f5a02354d53"}, {file = "aiohttp-3.10.3-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:56fb94bae2be58f68d000d046172d8b8e6b1b571eb02ceee5535e9633dcd559c"},
{file = "aiohttp-3.9.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a6fe5571784af92b6bc2fda8d1925cccdf24642d49546d3144948a6a1ed58ca5"}, {file = "aiohttp-3.10.3-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bf75716377aad2c718cdf66451c5cf02042085d84522aec1f9246d3e4b8641a6"},
{file = "aiohttp-3.9.3-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:ba39e9c8627edc56544c8628cc180d88605df3892beeb2b94c9bc857774848ca"}, {file = "aiohttp-3.10.3-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:6c51ed03e19c885c8e91f574e4bbe7381793f56f93229731597e4a499ffef2a5"},
{file = "aiohttp-3.9.3-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:e5e46b578c0e9db71d04c4b506a2121c0cb371dd89af17a0586ff6769d4c58c1"}, {file = "aiohttp-3.10.3-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:b84857b66fa6510a163bb083c1199d1ee091a40163cfcbbd0642495fed096204"},
{file = "aiohttp-3.9.3-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:938a9653e1e0c592053f815f7028e41a3062e902095e5a7dc84617c87267ebd5"}, {file = "aiohttp-3.10.3-cp312-cp312-musllinux_1_2_ppc64le.whl", hash = "sha256:c124b9206b1befe0491f48185fd30a0dd51b0f4e0e7e43ac1236066215aff272"},
{file = "aiohttp-3.9.3-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:c3452ea726c76e92f3b9fae4b34a151981a9ec0a4847a627c43d71a15ac32aa6"}, {file = "aiohttp-3.10.3-cp312-cp312-musllinux_1_2_s390x.whl", hash = "sha256:3461d9294941937f07bbbaa6227ba799bc71cc3b22c40222568dc1cca5118f68"},
{file = "aiohttp-3.9.3-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:ff30218887e62209942f91ac1be902cc80cddb86bf00fbc6783b7a43b2bea26f"}, {file = "aiohttp-3.10.3-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:08bd0754d257b2db27d6bab208c74601df6f21bfe4cb2ec7b258ba691aac64b3"},
{file = "aiohttp-3.9.3-cp312-cp312-win32.whl", hash = "sha256:38f307b41e0bea3294a9a2a87833191e4bcf89bb0365e83a8be3a58b31fb7f38"}, {file = "aiohttp-3.10.3-cp312-cp312-win32.whl", hash = "sha256:7f9159ae530297f61a00116771e57516f89a3de6ba33f314402e41560872b50a"},
{file = "aiohttp-3.9.3-cp312-cp312-win_amd64.whl", hash = "sha256:b791a3143681a520c0a17e26ae7465f1b6f99461a28019d1a2f425236e6eedb5"}, {file = "aiohttp-3.10.3-cp312-cp312-win_amd64.whl", hash = "sha256:e1128c5d3a466279cb23c4aa32a0f6cb0e7d2961e74e9e421f90e74f75ec1edf"},
{file = "aiohttp-3.9.3-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:0ed621426d961df79aa3b963ac7af0d40392956ffa9be022024cd16297b30c8c"}, {file = "aiohttp-3.10.3-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:d1100e68e70eb72eadba2b932b185ebf0f28fd2f0dbfe576cfa9d9894ef49752"},
{file = "aiohttp-3.9.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:7f46acd6a194287b7e41e87957bfe2ad1ad88318d447caf5b090012f2c5bb528"}, {file = "aiohttp-3.10.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:a541414578ff47c0a9b0b8b77381ea86b0c8531ab37fc587572cb662ccd80b88"},
{file = "aiohttp-3.9.3-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:feeb18a801aacb098220e2c3eea59a512362eb408d4afd0c242044c33ad6d542"}, {file = "aiohttp-3.10.3-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:d5548444ef60bf4c7b19ace21f032fa42d822e516a6940d36579f7bfa8513f9c"},
{file = "aiohttp-3.9.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:f734e38fd8666f53da904c52a23ce517f1b07722118d750405af7e4123933511"}, {file = "aiohttp-3.10.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5ba2e838b5e6a8755ac8297275c9460e729dc1522b6454aee1766c6de6d56e5e"},
{file = "aiohttp-3.9.3-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b40670ec7e2156d8e57f70aec34a7216407848dfe6c693ef131ddf6e76feb672"}, {file = "aiohttp-3.10.3-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:48665433bb59144aaf502c324694bec25867eb6630fcd831f7a893ca473fcde4"},
{file = "aiohttp-3.9.3-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fdd215b7b7fd4a53994f238d0f46b7ba4ac4c0adb12452beee724ddd0743ae5d"}, {file = "aiohttp-3.10.3-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:bac352fceed158620ce2d701ad39d4c1c76d114255a7c530e057e2b9f55bdf9f"},
{file = "aiohttp-3.9.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:017a21b0df49039c8f46ca0971b3a7fdc1f56741ab1240cb90ca408049766168"}, {file = "aiohttp-3.10.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2b0f670502100cdc567188c49415bebba947eb3edaa2028e1a50dd81bd13363f"},
{file = "aiohttp-3.9.3-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e99abf0bba688259a496f966211c49a514e65afa9b3073a1fcee08856e04425b"}, {file = "aiohttp-3.10.3-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:43b09f38a67679e32d380fe512189ccb0b25e15afc79b23fbd5b5e48e4fc8fd9"},
{file = "aiohttp-3.9.3-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:648056db9a9fa565d3fa851880f99f45e3f9a771dd3ff3bb0c048ea83fb28194"}, {file = "aiohttp-3.10.3-cp38-cp38-musllinux_1_2_aarch64.whl", hash = "sha256:cd788602e239ace64f257d1c9d39898ca65525583f0fbf0988bcba19418fe93f"},
{file = "aiohttp-3.9.3-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:8aacb477dc26797ee089721536a292a664846489c49d3ef9725f992449eda5a8"}, {file = "aiohttp-3.10.3-cp38-cp38-musllinux_1_2_i686.whl", hash = "sha256:214277dcb07ab3875f17ee1c777d446dcce75bea85846849cc9d139ab8f5081f"},
{file = "aiohttp-3.9.3-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:522a11c934ea660ff8953eda090dcd2154d367dec1ae3c540aff9f8a5c109ab4"}, {file = "aiohttp-3.10.3-cp38-cp38-musllinux_1_2_ppc64le.whl", hash = "sha256:32007fdcaab789689c2ecaaf4b71f8e37bf012a15cd02c0a9db8c4d0e7989fa8"},
{file = "aiohttp-3.9.3-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:5bce0dc147ca85caa5d33debc4f4d65e8e8b5c97c7f9f660f215fa74fc49a321"}, {file = "aiohttp-3.10.3-cp38-cp38-musllinux_1_2_s390x.whl", hash = "sha256:123e5819bfe1b87204575515cf448ab3bf1489cdeb3b61012bde716cda5853e7"},
{file = "aiohttp-3.9.3-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:4b4af9f25b49a7be47c0972139e59ec0e8285c371049df1a63b6ca81fdd216a2"}, {file = "aiohttp-3.10.3-cp38-cp38-musllinux_1_2_x86_64.whl", hash = "sha256:812121a201f0c02491a5db335a737b4113151926a79ae9ed1a9f41ea225c0e3f"},
{file = "aiohttp-3.9.3-cp38-cp38-win32.whl", hash = "sha256:298abd678033b8571995650ccee753d9458dfa0377be4dba91e4491da3f2be63"}, {file = "aiohttp-3.10.3-cp38-cp38-win32.whl", hash = "sha256:b97dc9a17a59f350c0caa453a3cb35671a2ffa3a29a6ef3568b523b9113d84e5"},
{file = "aiohttp-3.9.3-cp38-cp38-win_amd64.whl", hash = "sha256:69361bfdca5468c0488d7017b9b1e5ce769d40b46a9f4a2eed26b78619e9396c"}, {file = "aiohttp-3.10.3-cp38-cp38-win_amd64.whl", hash = "sha256:3731a73ddc26969d65f90471c635abd4e1546a25299b687e654ea6d2fc052394"},
{file = "aiohttp-3.9.3-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:0fa43c32d1643f518491d9d3a730f85f5bbaedcbd7fbcae27435bb8b7a061b29"}, {file = "aiohttp-3.10.3-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:38d91b98b4320ffe66efa56cb0f614a05af53b675ce1b8607cdb2ac826a8d58e"},
{file = "aiohttp-3.9.3-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:835a55b7ca49468aaaac0b217092dfdff370e6c215c9224c52f30daaa735c1c1"}, {file = "aiohttp-3.10.3-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:9743fa34a10a36ddd448bba8a3adc2a66a1c575c3c2940301bacd6cc896c6bf1"},
{file = "aiohttp-3.9.3-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:06a9b2c8837d9a94fae16c6223acc14b4dfdff216ab9b7202e07a9a09541168f"}, {file = "aiohttp-3.10.3-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7c126f532caf238031c19d169cfae3c6a59129452c990a6e84d6e7b198a001dc"},
{file = "aiohttp-3.9.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:abf151955990d23f84205286938796c55ff11bbfb4ccfada8c9c83ae6b3c89a3"}, {file = "aiohttp-3.10.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:926e68438f05703e500b06fe7148ef3013dd6f276de65c68558fa9974eeb59ad"},
{file = "aiohttp-3.9.3-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:59c26c95975f26e662ca78fdf543d4eeaef70e533a672b4113dd888bd2423caa"}, {file = "aiohttp-3.10.3-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:434b3ab75833accd0b931d11874e206e816f6e6626fd69f643d6a8269cd9166a"},
{file = "aiohttp-3.9.3-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:f95511dd5d0e05fd9728bac4096319f80615aaef4acbecb35a990afebe953b0e"}, {file = "aiohttp-3.10.3-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d35235a44ec38109b811c3600d15d8383297a8fab8e3dec6147477ec8636712a"},
{file = "aiohttp-3.9.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:595f105710293e76b9dc09f52e0dd896bd064a79346234b521f6b968ffdd8e58"}, {file = "aiohttp-3.10.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:59c489661edbd863edb30a8bd69ecb044bd381d1818022bc698ba1b6f80e5dd1"},
{file = "aiohttp-3.9.3-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c7c8b816c2b5af5c8a436df44ca08258fc1a13b449393a91484225fcb7545533"}, {file = "aiohttp-3.10.3-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:50544fe498c81cb98912afabfc4e4d9d85e89f86238348e3712f7ca6a2f01dab"},
{file = "aiohttp-3.9.3-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:f1088fa100bf46e7b398ffd9904f4808a0612e1d966b4aa43baa535d1b6341eb"}, {file = "aiohttp-3.10.3-cp39-cp39-musllinux_1_2_aarch64.whl", hash = "sha256:09bc79275737d4dc066e0ae2951866bb36d9c6b460cb7564f111cc0427f14844"},
{file = "aiohttp-3.9.3-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:f59dfe57bb1ec82ac0698ebfcdb7bcd0e99c255bd637ff613760d5f33e7c81b3"}, {file = "aiohttp-3.10.3-cp39-cp39-musllinux_1_2_i686.whl", hash = "sha256:af4dbec58e37f5afff4f91cdf235e8e4b0bd0127a2a4fd1040e2cad3369d2f06"},
{file = "aiohttp-3.9.3-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:361a1026c9dd4aba0109e4040e2aecf9884f5cfe1b1b1bd3d09419c205e2e53d"}, {file = "aiohttp-3.10.3-cp39-cp39-musllinux_1_2_ppc64le.whl", hash = "sha256:b22cae3c9dd55a6b4c48c63081d31c00fc11fa9db1a20c8a50ee38c1a29539d2"},
{file = "aiohttp-3.9.3-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:363afe77cfcbe3a36353d8ea133e904b108feea505aa4792dad6585a8192c55a"}, {file = "aiohttp-3.10.3-cp39-cp39-musllinux_1_2_s390x.whl", hash = "sha256:ba562736d3fbfe9241dad46c1a8994478d4a0e50796d80e29d50cabe8fbfcc3f"},
{file = "aiohttp-3.9.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8e2c45c208c62e955e8256949eb225bd8b66a4c9b6865729a786f2aa79b72e9d"}, {file = "aiohttp-3.10.3-cp39-cp39-musllinux_1_2_x86_64.whl", hash = "sha256:f25d6c4e82d7489be84f2b1c8212fafc021b3731abdb61a563c90e37cced3a21"},
{file = "aiohttp-3.9.3-cp39-cp39-win32.whl", hash = "sha256:f7217af2e14da0856e082e96ff637f14ae45c10a5714b63c77f26d8884cf1051"}, {file = "aiohttp-3.10.3-cp39-cp39-win32.whl", hash = "sha256:b69d832e5f5fa15b1b6b2c8eb6a9fd2c0ec1fd7729cb4322ed27771afc9fc2ac"},
{file = "aiohttp-3.9.3-cp39-cp39-win_amd64.whl", hash = "sha256:27468897f628c627230dba07ec65dc8d0db566923c48f29e084ce382119802bc"}, {file = "aiohttp-3.10.3-cp39-cp39-win_amd64.whl", hash = "sha256:673bb6e3249dc8825df1105f6ef74e2eab779b7ff78e96c15cadb78b04a83752"},
{file = "aiohttp-3.9.3.tar.gz", hash = "sha256:90842933e5d1ff760fae6caca4b2b3edba53ba8f4b71e95dacf2818a2aca06f7"}, {file = "aiohttp-3.10.3.tar.gz", hash = "sha256:21650e7032cc2d31fc23d353d7123e771354f2a3d5b05a5647fc30fea214e696"},
] ]
[package.dependencies] [package.dependencies]
aiohappyeyeballs = ">=2.3.0"
aiosignal = ">=1.1.2" aiosignal = ">=1.1.2"
async-timeout = {version = ">=4.0,<5.0", markers = "python_version < \"3.11\""} async-timeout = {version = ">=4.0,<5.0", markers = "python_version < \"3.11\""}
attrs = ">=17.3.0" attrs = ">=17.3.0"
@@ -94,7 +106,7 @@ multidict = ">=4.5,<7.0"
yarl = ">=1.0,<2.0" yarl = ">=1.0,<2.0"
[package.extras] [package.extras]
speedups = ["Brotli", "aiodns", "brotlicffi"] speedups = ["Brotli", "aiodns (>=3.2.0)", "brotlicffi"]
[[package]] [[package]]
name = "aiosignal" name = "aiosignal"
@@ -123,50 +135,51 @@ files = [
[[package]] [[package]]
name = "attrs" name = "attrs"
version = "23.1.0" version = "24.2.0"
description = "Classes Without Boilerplate" description = "Classes Without Boilerplate"
optional = false optional = false
python-versions = ">=3.7" python-versions = ">=3.7"
files = [ files = [
{file = "attrs-23.1.0-py3-none-any.whl", hash = "sha256:1f28b4522cdc2fb4256ac1a020c78acf9cba2c6b461ccd2c126f3aa8e8335d04"}, {file = "attrs-24.2.0-py3-none-any.whl", hash = "sha256:81921eb96de3191c8258c199618104dd27ac608d9366f5e35d011eae1867ede2"},
{file = "attrs-23.1.0.tar.gz", hash = "sha256:6279836d581513a26f1bf235f9acd333bc9115683f14f7e8fae46c98fc50e015"}, {file = "attrs-24.2.0.tar.gz", hash = "sha256:5cfb1b9148b5b086569baec03f20d7b6bf3bcacc9a42bebf87ffaaca362f6346"},
] ]
[package.extras] [package.extras]
cov = ["attrs[tests]", "coverage[toml] (>=5.3)"] benchmark = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-codspeed", "pytest-mypy-plugins", "pytest-xdist[psutil]"]
dev = ["attrs[docs,tests]", "pre-commit"] cov = ["cloudpickle", "coverage[toml] (>=5.3)", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"]
docs = ["furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphinxcontrib-towncrier", "towncrier", "zope-interface"] dev = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pre-commit", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"]
tests = ["attrs[tests-no-zope]", "zope-interface"] docs = ["cogapp", "furo", "myst-parser", "sphinx", "sphinx-notfound-page", "sphinxcontrib-towncrier", "towncrier (<24.7)"]
tests-no-zope = ["cloudpickle", "hypothesis", "mypy (>=1.1.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"] tests = ["cloudpickle", "hypothesis", "mypy (>=1.11.1)", "pympler", "pytest (>=4.3.0)", "pytest-mypy-plugins", "pytest-xdist[psutil]"]
tests-mypy = ["mypy (>=1.11.1)", "pytest-mypy-plugins"]
[[package]] [[package]]
name = "boto3" name = "boto3"
version = "1.28.83" version = "1.34.160"
description = "The AWS SDK for Python" description = "The AWS SDK for Python"
optional = false optional = false
python-versions = ">= 3.7" python-versions = ">=3.8"
files = [ files = [
{file = "boto3-1.28.83-py3-none-any.whl", hash = "sha256:1d10691911c4b8b9443d3060257ba32b68b6e3cad0eebbb9f69fd1c52a78417f"}, {file = "boto3-1.34.160-py3-none-any.whl", hash = "sha256:bf3153bf5d66be2bb2112edc94eb143c0cba3fb502c5591437bd1c54f57eb559"},
{file = "boto3-1.28.83.tar.gz", hash = "sha256:489c4967805b677b7a4030460e4c06c0903d6bc0f6834453611bf87efbd8d8a3"}, {file = "boto3-1.34.160.tar.gz", hash = "sha256:79450f92188a8b992b3d0b802028acadf448bc6fdde877c3262c9f94d74d1c7d"},
] ]
[package.dependencies] [package.dependencies]
botocore = ">=1.31.83,<1.32.0" botocore = ">=1.34.160,<1.35.0"
jmespath = ">=0.7.1,<2.0.0" jmespath = ">=0.7.1,<2.0.0"
s3transfer = ">=0.7.0,<0.8.0" s3transfer = ">=0.10.0,<0.11.0"
[package.extras] [package.extras]
crt = ["botocore[crt] (>=1.21.0,<2.0a0)"] crt = ["botocore[crt] (>=1.21.0,<2.0a0)"]
[[package]] [[package]]
name = "botocore" name = "botocore"
version = "1.31.83" version = "1.34.160"
description = "Low-level, data-driven core of boto 3." description = "Low-level, data-driven core of boto 3."
optional = false optional = false
python-versions = ">= 3.7" python-versions = ">=3.8"
files = [ files = [
{file = "botocore-1.31.83-py3-none-any.whl", hash = "sha256:c742069e8bfd06d212d712228258ff09fb481b6ec02358e539381ce0fcad065a"}, {file = "botocore-1.34.160-py3-none-any.whl", hash = "sha256:39bcf31318a062a8a9260bf7044131694ed18f019568d2eba0a22164fdca49bd"},
{file = "botocore-1.31.83.tar.gz", hash = "sha256:40914b0fb28f13d709e1f8a4481e278350b77a3987be81acd23715ec8d5fedca"}, {file = "botocore-1.34.160.tar.gz", hash = "sha256:a5fd531c640fb2dc8b83f264efbb87a6e33b9c9f66ebbb1c61b42908f2786cac"},
] ]
[package.dependencies] [package.dependencies]
@@ -174,21 +187,21 @@ jmespath = ">=0.7.1,<2.0.0"
python-dateutil = ">=2.1,<3.0.0" python-dateutil = ">=2.1,<3.0.0"
urllib3 = [ urllib3 = [
{version = ">=1.25.4,<1.27", markers = "python_version < \"3.10\""}, {version = ">=1.25.4,<1.27", markers = "python_version < \"3.10\""},
{version = ">=1.25.4,<2.1", markers = "python_version >= \"3.10\""}, {version = ">=1.25.4,<2.2.0 || >2.2.0,<3", markers = "python_version >= \"3.10\""},
] ]
[package.extras] [package.extras]
crt = ["awscrt (==0.16.26)"] crt = ["awscrt (==0.21.2)"]
[[package]] [[package]]
name = "certifi" name = "certifi"
version = "2023.7.22" version = "2024.7.4"
description = "Python package for providing Mozilla's CA Bundle." description = "Python package for providing Mozilla's CA Bundle."
optional = false optional = false
python-versions = ">=3.6" python-versions = ">=3.6"
files = [ files = [
{file = "certifi-2023.7.22-py3-none-any.whl", hash = "sha256:92d6037539857d8206b8f6ae472e8b77db8058fec5937a1ef3f54304089edbb9"}, {file = "certifi-2024.7.4-py3-none-any.whl", hash = "sha256:c198e21b1289c2ab85ee4e67bb4b4ef3ead0892059901a8d5b622f24a1101e90"},
{file = "certifi-2023.7.22.tar.gz", hash = "sha256:539cc1d13202e33ca466e88b2807e29f4c13049d6d87031a3c110744495cb082"}, {file = "certifi-2024.7.4.tar.gz", hash = "sha256:5a1e7645bc0ec61a09e26c36f6106dd4cf40c6db3a1fb6352b0244e7fb057c7b"},
] ]
[[package]] [[package]]
@@ -290,98 +303,111 @@ files = [
{file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"}, {file = "charset_normalizer-3.3.2-py3-none-any.whl", hash = "sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc"},
] ]
[[package]]
name = "events"
version = "0.5"
description = "Bringing the elegance of C# EventHandler to Python"
optional = false
python-versions = "*"
files = [
{file = "Events-0.5-py3-none-any.whl", hash = "sha256:a7286af378ba3e46640ac9825156c93bdba7502174dd696090fdfcd4d80a1abd"},
]
[[package]] [[package]]
name = "frozenlist" name = "frozenlist"
version = "1.3.3" version = "1.4.1"
description = "A list-like structure which implements collections.abc.MutableSequence" description = "A list-like structure which implements collections.abc.MutableSequence"
optional = false optional = false
python-versions = ">=3.7" python-versions = ">=3.8"
files = [ files = [
{file = "frozenlist-1.3.3-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:ff8bf625fe85e119553b5383ba0fb6aa3d0ec2ae980295aaefa552374926b3f4"}, {file = "frozenlist-1.4.1-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:f9aa1878d1083b276b0196f2dfbe00c9b7e752475ed3b682025ff20c1c1f51ac"},
{file = "frozenlist-1.3.3-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:dfbac4c2dfcc082fcf8d942d1e49b6aa0766c19d3358bd86e2000bf0fa4a9cf0"}, {file = "frozenlist-1.4.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:29acab3f66f0f24674b7dc4736477bcd4bc3ad4b896f5f45379a67bce8b96868"},
{file = "frozenlist-1.3.3-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:b1c63e8d377d039ac769cd0926558bb7068a1f7abb0f003e3717ee003ad85530"}, {file = "frozenlist-1.4.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:74fb4bee6880b529a0c6560885fce4dc95936920f9f20f53d99a213f7bf66776"},
{file = "frozenlist-1.3.3-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7fdfc24dcfce5b48109867c13b4cb15e4660e7bd7661741a391f821f23dfdca7"}, {file = "frozenlist-1.4.1-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:590344787a90ae57d62511dd7c736ed56b428f04cd8c161fcc5e7232c130c69a"},
{file = "frozenlist-1.3.3-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2c926450857408e42f0bbc295e84395722ce74bae69a3b2aa2a65fe22cb14b99"}, {file = "frozenlist-1.4.1-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:068b63f23b17df8569b7fdca5517edef76171cf3897eb68beb01341131fbd2ad"},
{file = "frozenlist-1.3.3-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:1841e200fdafc3d51f974d9d377c079a0694a8f06de2e67b48150328d66d5483"}, {file = "frozenlist-1.4.1-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:5c849d495bf5154cd8da18a9eb15db127d4dba2968d88831aff6f0331ea9bd4c"},
{file = "frozenlist-1.3.3-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f470c92737afa7d4c3aacc001e335062d582053d4dbe73cda126f2d7031068dd"}, {file = "frozenlist-1.4.1-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:9750cc7fe1ae3b1611bb8cfc3f9ec11d532244235d75901fb6b8e42ce9229dfe"},
{file = "frozenlist-1.3.3-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:783263a4eaad7c49983fe4b2e7b53fa9770c136c270d2d4bbb6d2192bf4d9caf"}, {file = "frozenlist-1.4.1-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a9b2de4cf0cdd5bd2dee4c4f63a653c61d2408055ab77b151c1957f221cabf2a"},
{file = "frozenlist-1.3.3-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:924620eef691990dfb56dc4709f280f40baee568c794b5c1885800c3ecc69816"}, {file = "frozenlist-1.4.1-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:0633c8d5337cb5c77acbccc6357ac49a1770b8c487e5b3505c57b949b4b82e98"},
{file = "frozenlist-1.3.3-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:ae4dc05c465a08a866b7a1baf360747078b362e6a6dbeb0c57f234db0ef88ae0"}, {file = "frozenlist-1.4.1-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:27657df69e8801be6c3638054e202a135c7f299267f1a55ed3a598934f6c0d75"},
{file = "frozenlist-1.3.3-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:bed331fe18f58d844d39ceb398b77d6ac0b010d571cba8267c2e7165806b00ce"}, {file = "frozenlist-1.4.1-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:f9a3ea26252bd92f570600098783d1371354d89d5f6b7dfd87359d669f2109b5"},
{file = "frozenlist-1.3.3-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:02c9ac843e3390826a265e331105efeab489ffaf4dd86384595ee8ce6d35ae7f"}, {file = "frozenlist-1.4.1-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:4f57dab5fe3407b6c0c1cc907ac98e8a189f9e418f3b6e54d65a718aaafe3950"},
{file = "frozenlist-1.3.3-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:9545a33965d0d377b0bc823dcabf26980e77f1b6a7caa368a365a9497fb09420"}, {file = "frozenlist-1.4.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:e02a0e11cf6597299b9f3bbd3f93d79217cb90cfd1411aec33848b13f5c656cc"},
{file = "frozenlist-1.3.3-cp310-cp310-win32.whl", hash = "sha256:d5cd3ab21acbdb414bb6c31958d7b06b85eeb40f66463c264a9b343a4e238642"}, {file = "frozenlist-1.4.1-cp310-cp310-win32.whl", hash = "sha256:a828c57f00f729620a442881cc60e57cfcec6842ba38e1b19fd3e47ac0ff8dc1"},
{file = "frozenlist-1.3.3-cp310-cp310-win_amd64.whl", hash = "sha256:b756072364347cb6aa5b60f9bc18e94b2f79632de3b0190253ad770c5df17db1"}, {file = "frozenlist-1.4.1-cp310-cp310-win_amd64.whl", hash = "sha256:f56e2333dda1fe0f909e7cc59f021eba0d2307bc6f012a1ccf2beca6ba362439"},
{file = "frozenlist-1.3.3-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:b4395e2f8d83fbe0c627b2b696acce67868793d7d9750e90e39592b3626691b7"}, {file = "frozenlist-1.4.1-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:a0cb6f11204443f27a1628b0e460f37fb30f624be6051d490fa7d7e26d4af3d0"},
{file = "frozenlist-1.3.3-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:14143ae966a6229350021384870458e4777d1eae4c28d1a7aa47f24d030e6678"}, {file = "frozenlist-1.4.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b46c8ae3a8f1f41a0d2ef350c0b6e65822d80772fe46b653ab6b6274f61d4a49"},
{file = "frozenlist-1.3.3-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5d8860749e813a6f65bad8285a0520607c9500caa23fea6ee407e63debcdbef6"}, {file = "frozenlist-1.4.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:fde5bd59ab5357e3853313127f4d3565fc7dad314a74d7b5d43c22c6a5ed2ced"},
{file = "frozenlist-1.3.3-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:23d16d9f477bb55b6154654e0e74557040575d9d19fe78a161bd33d7d76808e8"}, {file = "frozenlist-1.4.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:722e1124aec435320ae01ee3ac7bec11a5d47f25d0ed6328f2273d287bc3abb0"},
{file = "frozenlist-1.3.3-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:eb82dbba47a8318e75f679690190c10a5e1f447fbf9df41cbc4c3afd726d88cb"}, {file = "frozenlist-1.4.1-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:2471c201b70d58a0f0c1f91261542a03d9a5e088ed3dc6c160d614c01649c106"},
{file = "frozenlist-1.3.3-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9309869032abb23d196cb4e4db574232abe8b8be1339026f489eeb34a4acfd91"}, {file = "frozenlist-1.4.1-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c757a9dd70d72b076d6f68efdbb9bc943665ae954dad2801b874c8c69e185068"},
{file = "frozenlist-1.3.3-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:a97b4fe50b5890d36300820abd305694cb865ddb7885049587a5678215782a6b"}, {file = "frozenlist-1.4.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f146e0911cb2f1da549fc58fc7bcd2b836a44b79ef871980d605ec392ff6b0d2"},
{file = "frozenlist-1.3.3-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c188512b43542b1e91cadc3c6c915a82a5eb95929134faf7fd109f14f9892ce4"}, {file = "frozenlist-1.4.1-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:4f9c515e7914626b2a2e1e311794b4c35720a0be87af52b79ff8e1429fc25f19"},
{file = "frozenlist-1.3.3-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:303e04d422e9b911a09ad499b0368dc551e8c3cd15293c99160c7f1f07b59a48"}, {file = "frozenlist-1.4.1-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:c302220494f5c1ebeb0912ea782bcd5e2f8308037b3c7553fad0e48ebad6ad82"},
{file = "frozenlist-1.3.3-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:0771aed7f596c7d73444c847a1c16288937ef988dc04fb9f7be4b2aa91db609d"}, {file = "frozenlist-1.4.1-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:442acde1e068288a4ba7acfe05f5f343e19fac87bfc96d89eb886b0363e977ec"},
{file = "frozenlist-1.3.3-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:66080ec69883597e4d026f2f71a231a1ee9887835902dbe6b6467d5a89216cf6"}, {file = "frozenlist-1.4.1-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:1b280e6507ea8a4fa0c0a7150b4e526a8d113989e28eaaef946cc77ffd7efc0a"},
{file = "frozenlist-1.3.3-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:41fe21dc74ad3a779c3d73a2786bdf622ea81234bdd4faf90b8b03cad0c2c0b4"}, {file = "frozenlist-1.4.1-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:fe1a06da377e3a1062ae5fe0926e12b84eceb8a50b350ddca72dc85015873f74"},
{file = "frozenlist-1.3.3-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:f20380df709d91525e4bee04746ba612a4df0972c1b8f8e1e8af997e678c7b81"}, {file = "frozenlist-1.4.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:db9e724bebd621d9beca794f2a4ff1d26eed5965b004a97f1f1685a173b869c2"},
{file = "frozenlist-1.3.3-cp311-cp311-win32.whl", hash = "sha256:f30f1928162e189091cf4d9da2eac617bfe78ef907a761614ff577ef4edfb3c8"}, {file = "frozenlist-1.4.1-cp311-cp311-win32.whl", hash = "sha256:e774d53b1a477a67838a904131c4b0eef6b3d8a651f8b138b04f748fccfefe17"},
{file = "frozenlist-1.3.3-cp311-cp311-win_amd64.whl", hash = "sha256:a6394d7dadd3cfe3f4b3b186e54d5d8504d44f2d58dcc89d693698e8b7132b32"}, {file = "frozenlist-1.4.1-cp311-cp311-win_amd64.whl", hash = "sha256:fb3c2db03683b5767dedb5769b8a40ebb47d6f7f45b1b3e3b4b51ec8ad9d9825"},
{file = "frozenlist-1.3.3-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:8df3de3a9ab8325f94f646609a66cbeeede263910c5c0de0101079ad541af332"}, {file = "frozenlist-1.4.1-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:1979bc0aeb89b33b588c51c54ab0161791149f2461ea7c7c946d95d5f93b56ae"},
{file = "frozenlist-1.3.3-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0693c609e9742c66ba4870bcee1ad5ff35462d5ffec18710b4ac89337ff16e27"}, {file = "frozenlist-1.4.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:cc7b01b3754ea68a62bd77ce6020afaffb44a590c2289089289363472d13aedb"},
{file = "frozenlist-1.3.3-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:cd4210baef299717db0a600d7a3cac81d46ef0e007f88c9335db79f8979c0d3d"}, {file = "frozenlist-1.4.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:c9c92be9fd329ac801cc420e08452b70e7aeab94ea4233a4804f0915c14eba9b"},
{file = "frozenlist-1.3.3-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:394c9c242113bfb4b9aa36e2b80a05ffa163a30691c7b5a29eba82e937895d5e"}, {file = "frozenlist-1.4.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5c3894db91f5a489fc8fa6a9991820f368f0b3cbdb9cd8849547ccfab3392d86"},
{file = "frozenlist-1.3.3-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6327eb8e419f7d9c38f333cde41b9ae348bec26d840927332f17e887a8dcb70d"}, {file = "frozenlist-1.4.1-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ba60bb19387e13597fb059f32cd4d59445d7b18b69a745b8f8e5db0346f33480"},
{file = "frozenlist-1.3.3-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:2e24900aa13212e75e5b366cb9065e78bbf3893d4baab6052d1aca10d46d944c"}, {file = "frozenlist-1.4.1-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8aefbba5f69d42246543407ed2461db31006b0f76c4e32dfd6f42215a2c41d09"},
{file = "frozenlist-1.3.3-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:3843f84a6c465a36559161e6c59dce2f2ac10943040c2fd021cfb70d58c4ad56"}, {file = "frozenlist-1.4.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:780d3a35680ced9ce682fbcf4cb9c2bad3136eeff760ab33707b71db84664e3a"},
{file = "frozenlist-1.3.3-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:84610c1502b2461255b4c9b7d5e9c48052601a8957cd0aea6ec7a7a1e1fb9420"}, {file = "frozenlist-1.4.1-cp312-cp312-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9acbb16f06fe7f52f441bb6f413ebae6c37baa6ef9edd49cdd567216da8600cd"},
{file = "frozenlist-1.3.3-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:c21b9aa40e08e4f63a2f92ff3748e6b6c84d717d033c7b3438dd3123ee18f70e"}, {file = "frozenlist-1.4.1-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:23b701e65c7b36e4bf15546a89279bd4d8675faabc287d06bbcfac7d3c33e1e6"},
{file = "frozenlist-1.3.3-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:efce6ae830831ab6a22b9b4091d411698145cb9b8fc869e1397ccf4b4b6455cb"}, {file = "frozenlist-1.4.1-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:3e0153a805a98f5ada7e09826255ba99fb4f7524bb81bf6b47fb702666484ae1"},
{file = "frozenlist-1.3.3-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:40de71985e9042ca00b7953c4f41eabc3dc514a2d1ff534027f091bc74416401"}, {file = "frozenlist-1.4.1-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:dd9b1baec094d91bf36ec729445f7769d0d0cf6b64d04d86e45baf89e2b9059b"},
{file = "frozenlist-1.3.3-cp37-cp37m-win32.whl", hash = "sha256:180c00c66bde6146a860cbb81b54ee0df350d2daf13ca85b275123bbf85de18a"}, {file = "frozenlist-1.4.1-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:1a4471094e146b6790f61b98616ab8e44f72661879cc63fa1049d13ef711e71e"},
{file = "frozenlist-1.3.3-cp37-cp37m-win_amd64.whl", hash = "sha256:9bbbcedd75acdfecf2159663b87f1bb5cfc80e7cd99f7ddd9d66eb98b14a8411"}, {file = "frozenlist-1.4.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:5667ed53d68d91920defdf4035d1cdaa3c3121dc0b113255124bcfada1cfa1b8"},
{file = "frozenlist-1.3.3-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:034a5c08d36649591be1cbb10e09da9f531034acfe29275fc5454a3b101ce41a"}, {file = "frozenlist-1.4.1-cp312-cp312-win32.whl", hash = "sha256:beee944ae828747fd7cb216a70f120767fc9f4f00bacae8543c14a6831673f89"},
{file = "frozenlist-1.3.3-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:ba64dc2b3b7b158c6660d49cdb1d872d1d0bf4e42043ad8d5006099479a194e5"}, {file = "frozenlist-1.4.1-cp312-cp312-win_amd64.whl", hash = "sha256:64536573d0a2cb6e625cf309984e2d873979709f2cf22839bf2d61790b448ad5"},
{file = "frozenlist-1.3.3-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:47df36a9fe24054b950bbc2db630d508cca3aa27ed0566c0baf661225e52c18e"}, {file = "frozenlist-1.4.1-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:20b51fa3f588ff2fe658663db52a41a4f7aa6c04f6201449c6c7c476bd255c0d"},
{file = "frozenlist-1.3.3-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:008a054b75d77c995ea26629ab3a0c0d7281341f2fa7e1e85fa6153ae29ae99c"}, {file = "frozenlist-1.4.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:410478a0c562d1a5bcc2f7ea448359fcb050ed48b3c6f6f4f18c313a9bdb1826"},
{file = "frozenlist-1.3.3-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:841ea19b43d438a80b4de62ac6ab21cfe6827bb8a9dc62b896acc88eaf9cecba"}, {file = "frozenlist-1.4.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:c6321c9efe29975232da3bd0af0ad216800a47e93d763ce64f291917a381b8eb"},
{file = "frozenlist-1.3.3-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e235688f42b36be2b6b06fc37ac2126a73b75fb8d6bc66dd632aa35286238703"}, {file = "frozenlist-1.4.1-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:48f6a4533887e189dae092f1cf981f2e3885175f7a0f33c91fb5b7b682b6bab6"},
{file = "frozenlist-1.3.3-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ca713d4af15bae6e5d79b15c10c8522859a9a89d3b361a50b817c98c2fb402a2"}, {file = "frozenlist-1.4.1-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6eb73fa5426ea69ee0e012fb59cdc76a15b1283d6e32e4f8dc4482ec67d1194d"},
{file = "frozenlist-1.3.3-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9ac5995f2b408017b0be26d4a1d7c61bce106ff3d9e3324374d66b5964325448"}, {file = "frozenlist-1.4.1-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:fbeb989b5cc29e8daf7f976b421c220f1b8c731cbf22b9130d8815418ea45887"},
{file = "frozenlist-1.3.3-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:a4ae8135b11652b08a8baf07631d3ebfe65a4c87909dbef5fa0cdde440444ee4"}, {file = "frozenlist-1.4.1-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:32453c1de775c889eb4e22f1197fe3bdfe457d16476ea407472b9442e6295f7a"},
{file = "frozenlist-1.3.3-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:4ea42116ceb6bb16dbb7d526e242cb6747b08b7710d9782aa3d6732bd8d27649"}, {file = "frozenlist-1.4.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:693945278a31f2086d9bf3df0fe8254bbeaef1fe71e1351c3bd730aa7d31c41b"},
{file = "frozenlist-1.3.3-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:810860bb4bdce7557bc0febb84bbd88198b9dbc2022d8eebe5b3590b2ad6c842"}, {file = "frozenlist-1.4.1-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:1d0ce09d36d53bbbe566fe296965b23b961764c0bcf3ce2fa45f463745c04701"},
{file = "frozenlist-1.3.3-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:ee78feb9d293c323b59a6f2dd441b63339a30edf35abcb51187d2fc26e696d13"}, {file = "frozenlist-1.4.1-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:3a670dc61eb0d0eb7080890c13de3066790f9049b47b0de04007090807c776b0"},
{file = "frozenlist-1.3.3-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:0af2e7c87d35b38732e810befb9d797a99279cbb85374d42ea61c1e9d23094b3"}, {file = "frozenlist-1.4.1-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:dca69045298ce5c11fd539682cff879cc1e664c245d1c64da929813e54241d11"},
{file = "frozenlist-1.3.3-cp38-cp38-win32.whl", hash = "sha256:899c5e1928eec13fd6f6d8dc51be23f0d09c5281e40d9cf4273d188d9feeaf9b"}, {file = "frozenlist-1.4.1-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:a06339f38e9ed3a64e4c4e43aec7f59084033647f908e4259d279a52d3757d09"},
{file = "frozenlist-1.3.3-cp38-cp38-win_amd64.whl", hash = "sha256:7f44e24fa70f6fbc74aeec3e971f60a14dde85da364aa87f15d1be94ae75aeef"}, {file = "frozenlist-1.4.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:b7f2f9f912dca3934c1baec2e4585a674ef16fe00218d833856408c48d5beee7"},
{file = "frozenlist-1.3.3-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:2b07ae0c1edaa0a36339ec6cce700f51b14a3fc6545fdd32930d2c83917332cf"}, {file = "frozenlist-1.4.1-cp38-cp38-win32.whl", hash = "sha256:e7004be74cbb7d9f34553a5ce5fb08be14fb33bc86f332fb71cbe5216362a497"},
{file = "frozenlist-1.3.3-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:ebb86518203e12e96af765ee89034a1dbb0c3c65052d1b0c19bbbd6af8a145e1"}, {file = "frozenlist-1.4.1-cp38-cp38-win_amd64.whl", hash = "sha256:5a7d70357e7cee13f470c7883a063aae5fe209a493c57d86eb7f5a6f910fae09"},
{file = "frozenlist-1.3.3-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:5cf820485f1b4c91e0417ea0afd41ce5cf5965011b3c22c400f6d144296ccbc0"}, {file = "frozenlist-1.4.1-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:bfa4a17e17ce9abf47a74ae02f32d014c5e9404b6d9ac7f729e01562bbee601e"},
{file = "frozenlist-1.3.3-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5c11e43016b9024240212d2a65043b70ed8dfd3b52678a1271972702d990ac6d"}, {file = "frozenlist-1.4.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:b7e3ed87d4138356775346e6845cccbe66cd9e207f3cd11d2f0b9fd13681359d"},
{file = "frozenlist-1.3.3-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8fa3c6e3305aa1146b59a09b32b2e04074945ffcfb2f0931836d103a2c38f936"}, {file = "frozenlist-1.4.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:c99169d4ff810155ca50b4da3b075cbde79752443117d89429595c2e8e37fed8"},
{file = "frozenlist-1.3.3-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:352bd4c8c72d508778cf05ab491f6ef36149f4d0cb3c56b1b4302852255d05d5"}, {file = "frozenlist-1.4.1-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:edb678da49d9f72c9f6c609fbe41a5dfb9a9282f9e6a2253d5a91e0fc382d7c0"},
{file = "frozenlist-1.3.3-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:65a5e4d3aa679610ac6e3569e865425b23b372277f89b5ef06cf2cdaf1ebf22b"}, {file = "frozenlist-1.4.1-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:6db4667b187a6742b33afbbaf05a7bc551ffcf1ced0000a571aedbb4aa42fc7b"},
{file = "frozenlist-1.3.3-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b1e2c1185858d7e10ff045c496bbf90ae752c28b365fef2c09cf0fa309291669"}, {file = "frozenlist-1.4.1-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:55fdc093b5a3cb41d420884cdaf37a1e74c3c37a31f46e66286d9145d2063bd0"},
{file = "frozenlist-1.3.3-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:f163d2fd041c630fed01bc48d28c3ed4a3b003c00acd396900e11ee5316b56bb"}, {file = "frozenlist-1.4.1-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:82e8211d69a4f4bc360ea22cd6555f8e61a1bd211d1d5d39d3d228b48c83a897"},
{file = "frozenlist-1.3.3-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:05cdb16d09a0832eedf770cb7bd1fe57d8cf4eaf5aced29c4e41e3f20b30a784"}, {file = "frozenlist-1.4.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:89aa2c2eeb20957be2d950b85974b30a01a762f3308cd02bb15e1ad632e22dc7"},
{file = "frozenlist-1.3.3-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:8bae29d60768bfa8fb92244b74502b18fae55a80eac13c88eb0b496d4268fd2d"}, {file = "frozenlist-1.4.1-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:9d3e0c25a2350080e9319724dede4f31f43a6c9779be48021a7f4ebde8b2d742"},
{file = "frozenlist-1.3.3-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:eedab4c310c0299961ac285591acd53dc6723a1ebd90a57207c71f6e0c2153ab"}, {file = "frozenlist-1.4.1-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:7268252af60904bf52c26173cbadc3a071cece75f873705419c8681f24d3edea"},
{file = "frozenlist-1.3.3-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:3bbdf44855ed8f0fbcd102ef05ec3012d6a4fd7c7562403f76ce6a52aeffb2b1"}, {file = "frozenlist-1.4.1-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:0c250a29735d4f15321007fb02865f0e6b6a41a6b88f1f523ca1596ab5f50bd5"},
{file = "frozenlist-1.3.3-cp39-cp39-win32.whl", hash = "sha256:efa568b885bca461f7c7b9e032655c0c143d305bf01c30caf6db2854a4532b38"}, {file = "frozenlist-1.4.1-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:96ec70beabbd3b10e8bfe52616a13561e58fe84c0101dd031dc78f250d5128b9"},
{file = "frozenlist-1.3.3-cp39-cp39-win_amd64.whl", hash = "sha256:cfe33efc9cb900a4c46f91a5ceba26d6df370ffddd9ca386eb1d4f0ad97b9ea9"}, {file = "frozenlist-1.4.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:23b2d7679b73fe0e5a4560b672a39f98dfc6f60df63823b0a9970525325b95f6"},
{file = "frozenlist-1.3.3.tar.gz", hash = "sha256:58bcc55721e8a90b88332d6cd441261ebb22342e238296bb330968952fbb3a6a"}, {file = "frozenlist-1.4.1-cp39-cp39-win32.whl", hash = "sha256:a7496bfe1da7fb1a4e1cc23bb67c58fab69311cc7d32b5a99c2007b4b2a0e932"},
{file = "frozenlist-1.4.1-cp39-cp39-win_amd64.whl", hash = "sha256:e6a20a581f9ce92d389a8c7d7c3dd47c81fd5d6e655c8dddf341e14aa48659d0"},
{file = "frozenlist-1.4.1-py3-none-any.whl", hash = "sha256:04ced3e6a46b4cfffe20f9ae482818e34eba9b5fb0ce4056e4cc9b6e212d09b7"},
{file = "frozenlist-1.4.1.tar.gz", hash = "sha256:c037a86e8513059a2613aaba4d817bb90b9d9b6b69aace3ce9c877e8c8ed402b"},
] ]
[[package]] [[package]]
name = "idna" name = "idna"
version = "3.4" version = "3.7"
description = "Internationalized Domain Names in Applications (IDNA)" description = "Internationalized Domain Names in Applications (IDNA)"
optional = false optional = false
python-versions = ">=3.5" python-versions = ">=3.5"
files = [ files = [
{file = "idna-3.4-py3-none-any.whl", hash = "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2"}, {file = "idna-3.7-py3-none-any.whl", hash = "sha256:82fee1fc78add43492d3a1898bfa6d8a904cc97d8427f683ed8e798d07761aa0"},
{file = "idna-3.4.tar.gz", hash = "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4"}, {file = "idna-3.7.tar.gz", hash = "sha256:028ff3aadf0609c1fd278d8ea3089299412a7a8b9bd005dd08b9f8285bcb5cfc"},
] ]
[[package]] [[package]]
@@ -397,85 +423,101 @@ files = [
[[package]] [[package]]
name = "multidict" name = "multidict"
version = "6.0.4" version = "6.0.5"
description = "multidict implementation" description = "multidict implementation"
optional = false optional = false
python-versions = ">=3.7" python-versions = ">=3.7"
files = [ files = [
{file = "multidict-6.0.4-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:0b1a97283e0c85772d613878028fec909f003993e1007eafa715b24b377cb9b8"}, {file = "multidict-6.0.5-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:228b644ae063c10e7f324ab1ab6b548bdf6f8b47f3ec234fef1093bc2735e5f9"},
{file = "multidict-6.0.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:eeb6dcc05e911516ae3d1f207d4b0520d07f54484c49dfc294d6e7d63b734171"}, {file = "multidict-6.0.5-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:896ebdcf62683551312c30e20614305f53125750803b614e9e6ce74a96232604"},
{file = "multidict-6.0.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:d6d635d5209b82a3492508cf5b365f3446afb65ae7ebd755e70e18f287b0adf7"}, {file = "multidict-6.0.5-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:411bf8515f3be9813d06004cac41ccf7d1cd46dfe233705933dd163b60e37600"},
{file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c048099e4c9e9d615545e2001d3d8a4380bd403e1a0578734e0d31703d1b0c0b"}, {file = "multidict-6.0.5-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:1d147090048129ce3c453f0292e7697d333db95e52616b3793922945804a433c"},
{file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ea20853c6dbbb53ed34cb4d080382169b6f4554d394015f1bef35e881bf83547"}, {file = "multidict-6.0.5-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:215ed703caf15f578dca76ee6f6b21b7603791ae090fbf1ef9d865571039ade5"},
{file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:16d232d4e5396c2efbbf4f6d4df89bfa905eb0d4dc5b3549d872ab898451f569"}, {file = "multidict-6.0.5-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7c6390cf87ff6234643428991b7359b5f59cc15155695deb4eda5c777d2b880f"},
{file = "multidict-6.0.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:36c63aaa167f6c6b04ef2c85704e93af16c11d20de1d133e39de6a0e84582a93"}, {file = "multidict-6.0.5-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:21fd81c4ebdb4f214161be351eb5bcf385426bf023041da2fd9e60681f3cebae"},
{file = "multidict-6.0.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:64bdf1086b6043bf519869678f5f2757f473dee970d7abf6da91ec00acb9cb98"}, {file = "multidict-6.0.5-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:3cc2ad10255f903656017363cd59436f2111443a76f996584d1077e43ee51182"},
{file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:43644e38f42e3af682690876cff722d301ac585c5b9e1eacc013b7a3f7b696a0"}, {file = "multidict-6.0.5-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:6939c95381e003f54cd4c5516740faba40cf5ad3eeff460c3ad1d3e0ea2549bf"},
{file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:7582a1d1030e15422262de9f58711774e02fa80df0d1578995c76214f6954988"}, {file = "multidict-6.0.5-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:220dd781e3f7af2c2c1053da9fa96d9cf3072ca58f057f4c5adaaa1cab8fc442"},
{file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:ddff9c4e225a63a5afab9dd15590432c22e8057e1a9a13d28ed128ecf047bbdc"}, {file = "multidict-6.0.5-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:766c8f7511df26d9f11cd3a8be623e59cca73d44643abab3f8c8c07620524e4a"},
{file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:ee2a1ece51b9b9e7752e742cfb661d2a29e7bcdba2d27e66e28a99f1890e4fa0"}, {file = "multidict-6.0.5-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:fe5d7785250541f7f5019ab9cba2c71169dc7d74d0f45253f8313f436458a4ef"},
{file = "multidict-6.0.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:a2e4369eb3d47d2034032a26c7a80fcb21a2cb22e1173d761a162f11e562caa5"}, {file = "multidict-6.0.5-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:c1c1496e73051918fcd4f58ff2e0f2f3066d1c76a0c6aeffd9b45d53243702cc"},
{file = "multidict-6.0.4-cp310-cp310-win32.whl", hash = "sha256:574b7eae1ab267e5f8285f0fe881f17efe4b98c39a40858247720935b893bba8"}, {file = "multidict-6.0.5-cp310-cp310-win32.whl", hash = "sha256:7afcdd1fc07befad18ec4523a782cde4e93e0a2bf71239894b8d61ee578c1319"},
{file = "multidict-6.0.4-cp310-cp310-win_amd64.whl", hash = "sha256:4dcbb0906e38440fa3e325df2359ac6cb043df8e58c965bb45f4e406ecb162cc"}, {file = "multidict-6.0.5-cp310-cp310-win_amd64.whl", hash = "sha256:99f60d34c048c5c2fabc766108c103612344c46e35d4ed9ae0673d33c8fb26e8"},
{file = "multidict-6.0.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:0dfad7a5a1e39c53ed00d2dd0c2e36aed4650936dc18fd9a1826a5ae1cad6f03"}, {file = "multidict-6.0.5-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:f285e862d2f153a70586579c15c44656f888806ed0e5b56b64489afe4a2dbfba"},
{file = "multidict-6.0.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:64da238a09d6039e3bd39bb3aee9c21a5e34f28bfa5aa22518581f910ff94af3"}, {file = "multidict-6.0.5-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:53689bb4e102200a4fafa9de9c7c3c212ab40a7ab2c8e474491914d2305f187e"},
{file = "multidict-6.0.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:ff959bee35038c4624250473988b24f846cbeb2c6639de3602c073f10410ceba"}, {file = "multidict-6.0.5-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:612d1156111ae11d14afaf3a0669ebf6c170dbb735e510a7438ffe2369a847fd"},
{file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:01a3a55bd90018c9c080fbb0b9f4891db37d148a0a18722b42f94694f8b6d4c9"}, {file = "multidict-6.0.5-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7be7047bd08accdb7487737631d25735c9a04327911de89ff1b26b81745bd4e3"},
{file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c5cb09abb18c1ea940fb99360ea0396f34d46566f157122c92dfa069d3e0e982"}, {file = "multidict-6.0.5-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:de170c7b4fe6859beb8926e84f7d7d6c693dfe8e27372ce3b76f01c46e489fcf"},
{file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:666daae833559deb2d609afa4490b85830ab0dfca811a98b70a205621a6109fe"}, {file = "multidict-6.0.5-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:04bde7a7b3de05732a4eb39c94574db1ec99abb56162d6c520ad26f83267de29"},
{file = "multidict-6.0.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:11bdf3f5e1518b24530b8241529d2050014c884cf18b6fc69c0c2b30ca248710"}, {file = "multidict-6.0.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:85f67aed7bb647f93e7520633d8f51d3cbc6ab96957c71272b286b2f30dc70ed"},
{file = "multidict-6.0.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7d18748f2d30f94f498e852c67d61261c643b349b9d2a581131725595c45ec6c"}, {file = "multidict-6.0.5-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:425bf820055005bfc8aa9a0b99ccb52cc2f4070153e34b701acc98d201693733"},
{file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:458f37be2d9e4c95e2d8866a851663cbc76e865b78395090786f6cd9b3bbf4f4"}, {file = "multidict-6.0.5-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:d3eb1ceec286eba8220c26f3b0096cf189aea7057b6e7b7a2e60ed36b373b77f"},
{file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:b1a2eeedcead3a41694130495593a559a668f382eee0727352b9a41e1c45759a"}, {file = "multidict-6.0.5-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:7901c05ead4b3fb75113fb1dd33eb1253c6d3ee37ce93305acd9d38e0b5f21a4"},
{file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:7d6ae9d593ef8641544d6263c7fa6408cc90370c8cb2bbb65f8d43e5b0351d9c"}, {file = "multidict-6.0.5-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:e0e79d91e71b9867c73323a3444724d496c037e578a0e1755ae159ba14f4f3d1"},
{file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:5979b5632c3e3534e42ca6ff856bb24b2e3071b37861c2c727ce220d80eee9ed"}, {file = "multidict-6.0.5-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:29bfeb0dff5cb5fdab2023a7a9947b3b4af63e9c47cae2a10ad58394b517fddc"},
{file = "multidict-6.0.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:dcfe792765fab89c365123c81046ad4103fcabbc4f56d1c1997e6715e8015461"}, {file = "multidict-6.0.5-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:e030047e85cbcedbfc073f71836d62dd5dadfbe7531cae27789ff66bc551bd5e"},
{file = "multidict-6.0.4-cp311-cp311-win32.whl", hash = "sha256:3601a3cece3819534b11d4efc1eb76047488fddd0c85a3948099d5da4d504636"}, {file = "multidict-6.0.5-cp311-cp311-win32.whl", hash = "sha256:2f4848aa3baa109e6ab81fe2006c77ed4d3cd1e0ac2c1fbddb7b1277c168788c"},
{file = "multidict-6.0.4-cp311-cp311-win_amd64.whl", hash = "sha256:81a4f0b34bd92df3da93315c6a59034df95866014ac08535fc819f043bfd51f0"}, {file = "multidict-6.0.5-cp311-cp311-win_amd64.whl", hash = "sha256:2faa5ae9376faba05f630d7e5e6be05be22913782b927b19d12b8145968a85ea"},
{file = "multidict-6.0.4-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:67040058f37a2a51ed8ea8f6b0e6ee5bd78ca67f169ce6122f3e2ec80dfe9b78"}, {file = "multidict-6.0.5-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:51d035609b86722963404f711db441cf7134f1889107fb171a970c9701f92e1e"},
{file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:853888594621e6604c978ce2a0444a1e6e70c8d253ab65ba11657659dcc9100f"}, {file = "multidict-6.0.5-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:cbebcd5bcaf1eaf302617c114aa67569dd3f090dd0ce8ba9e35e9985b41ac35b"},
{file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:39ff62e7d0f26c248b15e364517a72932a611a9b75f35b45be078d81bdb86603"}, {file = "multidict-6.0.5-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:2ffc42c922dbfddb4a4c3b438eb056828719f07608af27d163191cb3e3aa6cc5"},
{file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:af048912e045a2dc732847d33821a9d84ba553f5c5f028adbd364dd4765092ac"}, {file = "multidict-6.0.5-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ceb3b7e6a0135e092de86110c5a74e46bda4bd4fbfeeb3a3bcec79c0f861e450"},
{file = "multidict-6.0.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b1e8b901e607795ec06c9e42530788c45ac21ef3aaa11dbd0c69de543bfb79a9"}, {file = "multidict-6.0.5-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:79660376075cfd4b2c80f295528aa6beb2058fd289f4c9252f986751a4cd0496"},
{file = "multidict-6.0.4-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:62501642008a8b9871ddfccbf83e4222cf8ac0d5aeedf73da36153ef2ec222d2"}, {file = "multidict-6.0.5-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e4428b29611e989719874670fd152b6625500ad6c686d464e99f5aaeeaca175a"},
{file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:99b76c052e9f1bc0721f7541e5e8c05db3941eb9ebe7b8553c625ef88d6eefde"}, {file = "multidict-6.0.5-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d84a5c3a5f7ce6db1f999fb9438f686bc2e09d38143f2d93d8406ed2dd6b9226"},
{file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:509eac6cf09c794aa27bcacfd4d62c885cce62bef7b2c3e8b2e49d365b5003fe"}, {file = "multidict-6.0.5-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:76c0de87358b192de7ea9649beb392f107dcad9ad27276324c24c91774ca5271"},
{file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:21a12c4eb6ddc9952c415f24eef97e3e55ba3af61f67c7bc388dcdec1404a067"}, {file = "multidict-6.0.5-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:79a6d2ba910adb2cbafc95dad936f8b9386e77c84c35bc0add315b856d7c3abb"},
{file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:5cad9430ab3e2e4fa4a2ef4450f548768400a2ac635841bc2a56a2052cdbeb87"}, {file = "multidict-6.0.5-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:92d16a3e275e38293623ebf639c471d3e03bb20b8ebb845237e0d3664914caef"},
{file = "multidict-6.0.4-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:ab55edc2e84460694295f401215f4a58597f8f7c9466faec545093045476327d"}, {file = "multidict-6.0.5-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:fb616be3538599e797a2017cccca78e354c767165e8858ab5116813146041a24"},
{file = "multidict-6.0.4-cp37-cp37m-win32.whl", hash = "sha256:5a4dcf02b908c3b8b17a45fb0f15b695bf117a67b76b7ad18b73cf8e92608775"}, {file = "multidict-6.0.5-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:14c2976aa9038c2629efa2c148022ed5eb4cb939e15ec7aace7ca932f48f9ba6"},
{file = "multidict-6.0.4-cp37-cp37m-win_amd64.whl", hash = "sha256:6ed5f161328b7df384d71b07317f4d8656434e34591f20552c7bcef27b0ab88e"}, {file = "multidict-6.0.5-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:435a0984199d81ca178b9ae2c26ec3d49692d20ee29bc4c11a2a8d4514c67eda"},
{file = "multidict-6.0.4-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5fc1b16f586f049820c5c5b17bb4ee7583092fa0d1c4e28b5239181ff9532e0c"}, {file = "multidict-6.0.5-cp312-cp312-win32.whl", hash = "sha256:9fe7b0653ba3d9d65cbe7698cca585bf0f8c83dbbcc710db9c90f478e175f2d5"},
{file = "multidict-6.0.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:1502e24330eb681bdaa3eb70d6358e818e8e8f908a22a1851dfd4e15bc2f8161"}, {file = "multidict-6.0.5-cp312-cp312-win_amd64.whl", hash = "sha256:01265f5e40f5a17f8241d52656ed27192be03bfa8764d88e8220141d1e4b3556"},
{file = "multidict-6.0.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:b692f419760c0e65d060959df05f2a531945af31fda0c8a3b3195d4efd06de11"}, {file = "multidict-6.0.5-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:19fe01cea168585ba0f678cad6f58133db2aa14eccaf22f88e4a6dccadfad8b3"},
{file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:45e1ecb0379bfaab5eef059f50115b54571acfbe422a14f668fc8c27ba410e7e"}, {file = "multidict-6.0.5-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:6bf7a982604375a8d49b6cc1b781c1747f243d91b81035a9b43a2126c04766f5"},
{file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ddd3915998d93fbcd2566ddf9cf62cdb35c9e093075f862935573d265cf8f65d"}, {file = "multidict-6.0.5-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:107c0cdefe028703fb5dafe640a409cb146d44a6ae201e55b35a4af8e95457dd"},
{file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:59d43b61c59d82f2effb39a93c48b845efe23a3852d201ed2d24ba830d0b4cf2"}, {file = "multidict-6.0.5-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:403c0911cd5d5791605808b942c88a8155c2592e05332d2bf78f18697a5fa15e"},
{file = "multidict-6.0.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:cc8e1d0c705233c5dd0c5e6460fbad7827d5d36f310a0fadfd45cc3029762258"}, {file = "multidict-6.0.5-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aeaf541ddbad8311a87dd695ed9642401131ea39ad7bc8cf3ef3967fd093b626"},
{file = "multidict-6.0.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d6aa0418fcc838522256761b3415822626f866758ee0bc6632c9486b179d0b52"}, {file = "multidict-6.0.5-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e4972624066095e52b569e02b5ca97dbd7a7ddd4294bf4e7247d52635630dd83"},
{file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:6748717bb10339c4760c1e63da040f5f29f5ed6e59d76daee30305894069a660"}, {file = "multidict-6.0.5-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:d946b0a9eb8aaa590df1fe082cee553ceab173e6cb5b03239716338629c50c7a"},
{file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:4d1a3d7ef5e96b1c9e92f973e43aa5e5b96c659c9bc3124acbbd81b0b9c8a951"}, {file = "multidict-6.0.5-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:b55358304d7a73d7bdf5de62494aaf70bd33015831ffd98bc498b433dfe5b10c"},
{file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:4372381634485bec7e46718edc71528024fcdc6f835baefe517b34a33c731d60"}, {file = "multidict-6.0.5-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:a3145cb08d8625b2d3fee1b2d596a8766352979c9bffe5d7833e0503d0f0b5e5"},
{file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:fc35cb4676846ef752816d5be2193a1e8367b4c1397b74a565a9d0389c433a1d"}, {file = "multidict-6.0.5-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:d65f25da8e248202bd47445cec78e0025c0fe7582b23ec69c3b27a640dd7a8e3"},
{file = "multidict-6.0.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:4b9d9e4e2b37daddb5c23ea33a3417901fa7c7b3dee2d855f63ee67a0b21e5b1"}, {file = "multidict-6.0.5-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:c9bf56195c6bbd293340ea82eafd0071cb3d450c703d2c93afb89f93b8386ccc"},
{file = "multidict-6.0.4-cp38-cp38-win32.whl", hash = "sha256:e41b7e2b59679edfa309e8db64fdf22399eec4b0b24694e1b2104fb789207779"}, {file = "multidict-6.0.5-cp37-cp37m-win32.whl", hash = "sha256:69db76c09796b313331bb7048229e3bee7928eb62bab5e071e9f7fcc4879caee"},
{file = "multidict-6.0.4-cp38-cp38-win_amd64.whl", hash = "sha256:d6c254ba6e45d8e72739281ebc46ea5eb5f101234f3ce171f0e9f5cc86991480"}, {file = "multidict-6.0.5-cp37-cp37m-win_amd64.whl", hash = "sha256:fce28b3c8a81b6b36dfac9feb1de115bab619b3c13905b419ec71d03a3fc1423"},
{file = "multidict-6.0.4-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:16ab77bbeb596e14212e7bab8429f24c1579234a3a462105cda4a66904998664"}, {file = "multidict-6.0.5-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:76f067f5121dcecf0d63a67f29080b26c43c71a98b10c701b0677e4a065fbd54"},
{file = "multidict-6.0.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:bc779e9e6f7fda81b3f9aa58e3a6091d49ad528b11ed19f6621408806204ad35"}, {file = "multidict-6.0.5-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:b82cc8ace10ab5bd93235dfaab2021c70637005e1ac787031f4d1da63d493c1d"},
{file = "multidict-6.0.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:4ceef517eca3e03c1cceb22030a3e39cb399ac86bff4e426d4fc6ae49052cc60"}, {file = "multidict-6.0.5-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:5cb241881eefd96b46f89b1a056187ea8e9ba14ab88ba632e68d7a2ecb7aadf7"},
{file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:281af09f488903fde97923c7744bb001a9b23b039a909460d0f14edc7bf59706"}, {file = "multidict-6.0.5-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:e8e94e6912639a02ce173341ff62cc1201232ab86b8a8fcc05572741a5dc7d93"},
{file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:52f2dffc8acaba9a2f27174c41c9e57f60b907bb9f096b36b1a1f3be71c6284d"}, {file = "multidict-6.0.5-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:09a892e4a9fb47331da06948690ae38eaa2426de97b4ccbfafbdcbe5c8f37ff8"},
{file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:b41156839806aecb3641f3208c0dafd3ac7775b9c4c422d82ee2a45c34ba81ca"}, {file = "multidict-6.0.5-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:55205d03e8a598cfc688c71ca8ea5f66447164efff8869517f175ea632c7cb7b"},
{file = "multidict-6.0.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:d5e3fc56f88cc98ef8139255cf8cd63eb2c586531e43310ff859d6bb3a6b51f1"}, {file = "multidict-6.0.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:37b15024f864916b4951adb95d3a80c9431299080341ab9544ed148091b53f50"},
{file = "multidict-6.0.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8316a77808c501004802f9beebde51c9f857054a0c871bd6da8280e718444449"}, {file = "multidict-6.0.5-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f2a1dee728b52b33eebff5072817176c172050d44d67befd681609b4746e1c2e"},
{file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:f70b98cd94886b49d91170ef23ec5c0e8ebb6f242d734ed7ed677b24d50c82cf"}, {file = "multidict-6.0.5-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:edd08e6f2f1a390bf137080507e44ccc086353c8e98c657e666c017718561b89"},
{file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:bf6774e60d67a9efe02b3616fee22441d86fab4c6d335f9d2051d19d90a40063"}, {file = "multidict-6.0.5-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:60d698e8179a42ec85172d12f50b1668254628425a6bd611aba022257cac1386"},
{file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:e69924bfcdda39b722ef4d9aa762b2dd38e4632b3641b1d9a57ca9cd18f2f83a"}, {file = "multidict-6.0.5-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:3d25f19500588cbc47dc19081d78131c32637c25804df8414463ec908631e453"},
{file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:6b181d8c23da913d4ff585afd1155a0e1194c0b50c54fcfe286f70cdaf2b7176"}, {file = "multidict-6.0.5-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:4cc0ef8b962ac7a5e62b9e826bd0cd5040e7d401bc45a6835910ed699037a461"},
{file = "multidict-6.0.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:52509b5be062d9eafc8170e53026fbc54cf3b32759a23d07fd935fb04fc22d95"}, {file = "multidict-6.0.5-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:eca2e9d0cc5a889850e9bbd68e98314ada174ff6ccd1129500103df7a94a7a44"},
{file = "multidict-6.0.4-cp39-cp39-win32.whl", hash = "sha256:27c523fbfbdfd19c6867af7346332b62b586eed663887392cff78d614f9ec313"}, {file = "multidict-6.0.5-cp38-cp38-win32.whl", hash = "sha256:4a6a4f196f08c58c59e0b8ef8ec441d12aee4125a7d4f4fef000ccb22f8d7241"},
{file = "multidict-6.0.4-cp39-cp39-win_amd64.whl", hash = "sha256:33029f5734336aa0d4c0384525da0387ef89148dc7191aae00ca5fb23d7aafc2"}, {file = "multidict-6.0.5-cp38-cp38-win_amd64.whl", hash = "sha256:0275e35209c27a3f7951e1ce7aaf93ce0d163b28948444bec61dd7badc6d3f8c"},
{file = "multidict-6.0.4.tar.gz", hash = "sha256:3666906492efb76453c0e7b97f2cf459b0682e7402c0489a95484965dbc1da49"}, {file = "multidict-6.0.5-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:e7be68734bd8c9a513f2b0cfd508802d6609da068f40dc57d4e3494cefc92929"},
{file = "multidict-6.0.5-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:1d9ea7a7e779d7a3561aade7d596649fbecfa5c08a7674b11b423783217933f9"},
{file = "multidict-6.0.5-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ea1456df2a27c73ce51120fa2f519f1bea2f4a03a917f4a43c8707cf4cbbae1a"},
{file = "multidict-6.0.5-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:cf590b134eb70629e350691ecca88eac3e3b8b3c86992042fb82e3cb1830d5e1"},
{file = "multidict-6.0.5-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:5c0631926c4f58e9a5ccce555ad7747d9a9f8b10619621f22f9635f069f6233e"},
{file = "multidict-6.0.5-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:dce1c6912ab9ff5f179eaf6efe7365c1f425ed690b03341911bf4939ef2f3046"},
{file = "multidict-6.0.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c0868d64af83169e4d4152ec612637a543f7a336e4a307b119e98042e852ad9c"},
{file = "multidict-6.0.5-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:141b43360bfd3bdd75f15ed811850763555a251e38b2405967f8e25fb43f7d40"},
{file = "multidict-6.0.5-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:7df704ca8cf4a073334e0427ae2345323613e4df18cc224f647f251e5e75a527"},
{file = "multidict-6.0.5-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:6214c5a5571802c33f80e6c84713b2c79e024995b9c5897f794b43e714daeec9"},
{file = "multidict-6.0.5-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:cd6c8fca38178e12c00418de737aef1261576bd1b6e8c6134d3e729a4e858b38"},
{file = "multidict-6.0.5-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:e02021f87a5b6932fa6ce916ca004c4d441509d33bbdbeca70d05dff5e9d2479"},
{file = "multidict-6.0.5-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:ebd8d160f91a764652d3e51ce0d2956b38efe37c9231cd82cfc0bed2e40b581c"},
{file = "multidict-6.0.5-cp39-cp39-win32.whl", hash = "sha256:04da1bb8c8dbadf2a18a452639771951c662c5ad03aefe4884775454be322c9b"},
{file = "multidict-6.0.5-cp39-cp39-win_amd64.whl", hash = "sha256:d6f6d4f185481c9669b9447bf9d9cf3b95a0e9df9d169bbc17e363b7d5487755"},
{file = "multidict-6.0.5-py3-none-any.whl", hash = "sha256:0d63c74e3d7ab26de115c49bffc92cc77ed23395303d496eae515d4204a625e7"},
{file = "multidict-6.0.5.tar.gz", hash = "sha256:f7e301075edaf50500f0b341543c41194d8df3ae5caf4702f2095f3ca73dd8da"},
] ]
[[package]] [[package]]
@@ -488,17 +530,20 @@ files = []
develop = true develop = true
[package.dependencies] [package.dependencies]
aiohttp = {version = ">=3.9.2,<4", optional = true, markers = "extra == \"async\""} aiohttp = {version = ">=3.9.4,<4", optional = true, markers = "extra == \"async\""}
certifi = ">=2022.12.07" certifi = ">=2024.07.04"
Events = "*"
python-dateutil = "*" python-dateutil = "*"
requests = ">=2.4.0,<3.0.0" requests = ">=2.4.0,<3.0.0"
six = "*" urllib3 = [
urllib3 = ">=1.26.18,<2" {version = ">=1.26.19,<1.27", markers = "python_version < \"3.10\""},
{version = ">=1.26.19,<2.2.0 || >2.2.0,<3", markers = "python_version >= \"3.10\""},
]
[package.extras] [package.extras]
async = ["aiohttp (>=3.9.2,<4)"] async = ["aiohttp (>=3.9.4,<4)"]
develop = ["black (>=24.3.0)", "botocore", "coverage (<8.0.0)", "jinja2", "mock", "myst_parser", "pytest (>=3.0.0)", "pytest-cov", "pytest-mock (<4.0.0)", "pytz", "pyyaml", "requests (>=2.0.0,<3.0.0)", "sphinx", "sphinx_copybutton", "sphinx_rtd_theme"] develop = ["black (>=24.3.0)", "botocore", "coverage (<8.0.0)", "jinja2", "myst_parser", "pytest (>=3.0.0)", "pytest-cov", "pytest-mock (<4.0.0)", "pytz", "pyyaml", "requests (>=2.0.0,<3.0.0)", "sphinx", "sphinx_copybutton", "sphinx_rtd_theme"]
docs = ["aiohttp (>=3.9.2,<4)", "myst_parser", "sphinx", "sphinx_copybutton", "sphinx_rtd_theme"] docs = ["aiohttp (>=3.9.4,<4)", "myst_parser", "sphinx", "sphinx_copybutton", "sphinx_rtd_theme"]
kerberos = ["requests_kerberos"] kerberos = ["requests_kerberos"]
[package.source] [package.source]
@@ -507,13 +552,13 @@ url = ".."
[[package]] [[package]]
name = "python-dateutil" name = "python-dateutil"
version = "2.8.2" version = "2.9.0.post0"
description = "Extensions to the standard Python datetime module" description = "Extensions to the standard Python datetime module"
optional = false optional = false
python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7" python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,>=2.7"
files = [ files = [
{file = "python-dateutil-2.8.2.tar.gz", hash = "sha256:0123cacc1627ae19ddf3c27a5de5bd67ee4586fbdd6440d9748f8abb483d3e86"}, {file = "python-dateutil-2.9.0.post0.tar.gz", hash = "sha256:37dd54208da7e1cd875388217d5e00ebd4179249f90fb72437e91a35459a0ad3"},
{file = "python_dateutil-2.8.2-py2.py3-none-any.whl", hash = "sha256:961d03dc3453ebbc59dbdea9e4e11c5651520a876d0f4db161e8674aae935da9"}, {file = "python_dateutil-2.9.0.post0-py2.py3-none-any.whl", hash = "sha256:a8b2bc7bffae282281c8140a97d3aa9c14da0b136dfe83f850eea9a5f7470427"},
] ]
[package.dependencies] [package.dependencies]
@@ -521,13 +566,13 @@ six = ">=1.5"
[[package]] [[package]]
name = "requests" name = "requests"
version = "2.31.0" version = "2.32.3"
description = "Python HTTP for Humans." description = "Python HTTP for Humans."
optional = false optional = false
python-versions = ">=3.7" python-versions = ">=3.8"
files = [ files = [
{file = "requests-2.31.0-py3-none-any.whl", hash = "sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f"}, {file = "requests-2.32.3-py3-none-any.whl", hash = "sha256:70761cfe03c773ceb22aa2f671b4757976145175cdfca038c02654d061d6dcc6"},
{file = "requests-2.31.0.tar.gz", hash = "sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1"}, {file = "requests-2.32.3.tar.gz", hash = "sha256:55365417734eb18255590a9ff9eb97e9e1da868d4ccd6402399eaf68af20a760"},
] ]
[package.dependencies] [package.dependencies]
@@ -542,20 +587,20 @@ use-chardet-on-py3 = ["chardet (>=3.0.2,<6)"]
[[package]] [[package]]
name = "s3transfer" name = "s3transfer"
version = "0.7.0" version = "0.10.2"
description = "An Amazon S3 Transfer Manager" description = "An Amazon S3 Transfer Manager"
optional = false optional = false
python-versions = ">= 3.7" python-versions = ">=3.8"
files = [ files = [
{file = "s3transfer-0.7.0-py3-none-any.whl", hash = "sha256:10d6923c6359175f264811ef4bf6161a3156ce8e350e705396a7557d6293c33a"}, {file = "s3transfer-0.10.2-py3-none-any.whl", hash = "sha256:eca1c20de70a39daee580aef4986996620f365c4e0fda6a86100231d62f1bf69"},
{file = "s3transfer-0.7.0.tar.gz", hash = "sha256:fd3889a66f5fe17299fe75b82eae6cf722554edca744ca5d5fe308b104883d2e"}, {file = "s3transfer-0.10.2.tar.gz", hash = "sha256:0711534e9356d3cc692fdde846b4a1e4b0cb6519971860796e6bc4c7aea00ef6"},
] ]
[package.dependencies] [package.dependencies]
botocore = ">=1.12.36,<2.0a.0" botocore = ">=1.33.2,<2.0a.0"
[package.extras] [package.extras]
crt = ["botocore[crt] (>=1.20.29,<2.0a.0)"] crt = ["botocore[crt] (>=1.33.2,<2.0a.0)"]
[[package]] [[package]]
name = "six" name = "six"
@@ -570,13 +615,13 @@ files = [
[[package]] [[package]]
name = "urllib3" name = "urllib3"
version = "1.26.18" version = "1.26.19"
description = "HTTP library with thread-safe connection pooling, file post, and more." description = "HTTP library with thread-safe connection pooling, file post, and more."
optional = false optional = false
python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*" python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,>=2.7"
files = [ files = [
{file = "urllib3-1.26.18-py2.py3-none-any.whl", hash = "sha256:34b97092d7e0a3a8cf7cd10e386f401b3737364026c45e622aa02903dffe0f07"}, {file = "urllib3-1.26.19-py2.py3-none-any.whl", hash = "sha256:37a0344459b199fce0e80b0d3569837ec6b6937435c5244e7fd73fa6006830f3"},
{file = "urllib3-1.26.18.tar.gz", hash = "sha256:f8ecc1bba5667413457c529ab955bf8c67b45db799d159066261719e328580a0"}, {file = "urllib3-1.26.19.tar.gz", hash = "sha256:3e3d753a8618b86d7de333b4223005f68720bcd6a7d2bcb9fbd2229ec7c1e429"},
] ]
[package.extras] [package.extras]
@@ -584,87 +629,120 @@ brotli = ["brotli (==1.0.9)", "brotli (>=1.0.9)", "brotlicffi (>=0.8.0)", "brotl
secure = ["certifi", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "ipaddress", "pyOpenSSL (>=0.14)", "urllib3-secure-extra"] secure = ["certifi", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "ipaddress", "pyOpenSSL (>=0.14)", "urllib3-secure-extra"]
socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"]
[[package]]
name = "urllib3"
version = "2.2.2"
description = "HTTP library with thread-safe connection pooling, file post, and more."
optional = false
python-versions = ">=3.8"
files = [
{file = "urllib3-2.2.2-py3-none-any.whl", hash = "sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472"},
{file = "urllib3-2.2.2.tar.gz", hash = "sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168"},
]
[package.extras]
brotli = ["brotli (>=1.0.9)", "brotlicffi (>=0.8.0)"]
h2 = ["h2 (>=4,<5)"]
socks = ["pysocks (>=1.5.6,!=1.5.7,<2.0)"]
zstd = ["zstandard (>=0.18.0)"]
[[package]] [[package]]
name = "yarl" name = "yarl"
version = "1.9.2" version = "1.9.4"
description = "Yet another URL library" description = "Yet another URL library"
optional = false optional = false
python-versions = ">=3.7" python-versions = ">=3.7"
files = [ files = [
{file = "yarl-1.9.2-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:8c2ad583743d16ddbdf6bb14b5cd76bf43b0d0006e918809d5d4ddf7bde8dd82"}, {file = "yarl-1.9.4-cp310-cp310-macosx_10_9_universal2.whl", hash = "sha256:a8c1df72eb746f4136fe9a2e72b0c9dc1da1cbd23b5372f94b5820ff8ae30e0e"},
{file = "yarl-1.9.2-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:82aa6264b36c50acfb2424ad5ca537a2060ab6de158a5bd2a72a032cc75b9eb8"}, {file = "yarl-1.9.4-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:a3a6ed1d525bfb91b3fc9b690c5a21bb52de28c018530ad85093cc488bee2dd2"},
{file = "yarl-1.9.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c0c77533b5ed4bcc38e943178ccae29b9bcf48ffd1063f5821192f23a1bd27b9"}, {file = "yarl-1.9.4-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:c38c9ddb6103ceae4e4498f9c08fac9b590c5c71b0370f98714768e22ac6fa66"},
{file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ee4afac41415d52d53a9833ebae7e32b344be72835bbb589018c9e938045a560"}, {file = "yarl-1.9.4-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d9e09c9d74f4566e905a0b8fa668c58109f7624db96a2171f21747abc7524234"},
{file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9bf345c3a4f5ba7f766430f97f9cc1320786f19584acc7086491f45524a551ac"}, {file = "yarl-1.9.4-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b8477c1ee4bd47c57d49621a062121c3023609f7a13b8a46953eb6c9716ca392"},
{file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:2a96c19c52ff442a808c105901d0bdfd2e28575b3d5f82e2f5fd67e20dc5f4ea"}, {file = "yarl-1.9.4-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:d5ff2c858f5f6a42c2a8e751100f237c5e869cbde669a724f2062d4c4ef93551"},
{file = "yarl-1.9.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:891c0e3ec5ec881541f6c5113d8df0315ce5440e244a716b95f2525b7b9f3608"}, {file = "yarl-1.9.4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:357495293086c5b6d34ca9616a43d329317feab7917518bc97a08f9e55648455"},
{file = "yarl-1.9.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c3a53ba34a636a256d767c086ceb111358876e1fb6b50dfc4d3f4951d40133d5"}, {file = "yarl-1.9.4-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:54525ae423d7b7a8ee81ba189f131054defdb122cde31ff17477951464c1691c"},
{file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:566185e8ebc0898b11f8026447eacd02e46226716229cea8db37496c8cdd26e0"}, {file = "yarl-1.9.4-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:801e9264d19643548651b9db361ce3287176671fb0117f96b5ac0ee1c3530d53"},
{file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:2b0738fb871812722a0ac2154be1f049c6223b9f6f22eec352996b69775b36d4"}, {file = "yarl-1.9.4-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:e516dc8baf7b380e6c1c26792610230f37147bb754d6426462ab115a02944385"},
{file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:32f1d071b3f362c80f1a7d322bfd7b2d11e33d2adf395cc1dd4df36c9c243095"}, {file = "yarl-1.9.4-cp310-cp310-musllinux_1_1_ppc64le.whl", hash = "sha256:7d5aaac37d19b2904bb9dfe12cdb08c8443e7ba7d2852894ad448d4b8f442863"},
{file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:e9fdc7ac0d42bc3ea78818557fab03af6181e076a2944f43c38684b4b6bed8e3"}, {file = "yarl-1.9.4-cp310-cp310-musllinux_1_1_s390x.whl", hash = "sha256:54beabb809ffcacbd9d28ac57b0db46e42a6e341a030293fb3185c409e626b8b"},
{file = "yarl-1.9.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:56ff08ab5df8429901ebdc5d15941b59f6253393cb5da07b4170beefcf1b2528"}, {file = "yarl-1.9.4-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:bac8d525a8dbc2a1507ec731d2867025d11ceadcb4dd421423a5d42c56818541"},
{file = "yarl-1.9.2-cp310-cp310-win32.whl", hash = "sha256:8ea48e0a2f931064469bdabca50c2f578b565fc446f302a79ba6cc0ee7f384d3"}, {file = "yarl-1.9.4-cp310-cp310-win32.whl", hash = "sha256:7855426dfbddac81896b6e533ebefc0af2f132d4a47340cee6d22cac7190022d"},
{file = "yarl-1.9.2-cp310-cp310-win_amd64.whl", hash = "sha256:50f33040f3836e912ed16d212f6cc1efb3231a8a60526a407aeb66c1c1956dde"}, {file = "yarl-1.9.4-cp310-cp310-win_amd64.whl", hash = "sha256:848cd2a1df56ddbffeb375535fb62c9d1645dde33ca4d51341378b3f5954429b"},
{file = "yarl-1.9.2-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:646d663eb2232d7909e6601f1a9107e66f9791f290a1b3dc7057818fe44fc2b6"}, {file = "yarl-1.9.4-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:35a2b9396879ce32754bd457d31a51ff0a9d426fd9e0e3c33394bf4b9036b099"},
{file = "yarl-1.9.2-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:aff634b15beff8902d1f918012fc2a42e0dbae6f469fce134c8a0dc51ca423bb"}, {file = "yarl-1.9.4-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:4c7d56b293cc071e82532f70adcbd8b61909eec973ae9d2d1f9b233f3d943f2c"},
{file = "yarl-1.9.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:a83503934c6273806aed765035716216cc9ab4e0364f7f066227e1aaea90b8d0"}, {file = "yarl-1.9.4-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:d8a1c6c0be645c745a081c192e747c5de06e944a0d21245f4cf7c05e457c36e0"},
{file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:b25322201585c69abc7b0e89e72790469f7dad90d26754717f3310bfe30331c2"}, {file = "yarl-1.9.4-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4b3c1ffe10069f655ea2d731808e76e0f452fc6c749bea04781daf18e6039525"},
{file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:22a94666751778629f1ec4280b08eb11815783c63f52092a5953faf73be24191"}, {file = "yarl-1.9.4-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:549d19c84c55d11687ddbd47eeb348a89df9cb30e1993f1b128f4685cd0ebbf8"},
{file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:8ec53a0ea2a80c5cd1ab397925f94bff59222aa3cf9c6da938ce05c9ec20428d"}, {file = "yarl-1.9.4-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:a7409f968456111140c1c95301cadf071bd30a81cbd7ab829169fb9e3d72eae9"},
{file = "yarl-1.9.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:159d81f22d7a43e6eabc36d7194cb53f2f15f498dbbfa8edc8a3239350f59fe7"}, {file = "yarl-1.9.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e23a6d84d9d1738dbc6e38167776107e63307dfc8ad108e580548d1f2c587f42"},
{file = "yarl-1.9.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:832b7e711027c114d79dffb92576acd1bd2decc467dec60e1cac96912602d0e6"}, {file = "yarl-1.9.4-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d8b889777de69897406c9fb0b76cdf2fd0f31267861ae7501d93003d55f54fbe"},
{file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:95d2ecefbcf4e744ea952d073c6922e72ee650ffc79028eb1e320e732898d7e8"}, {file = "yarl-1.9.4-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:03caa9507d3d3c83bca08650678e25364e1843b484f19986a527630ca376ecce"},
{file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:d4e2c6d555e77b37288eaf45b8f60f0737c9efa3452c6c44626a5455aeb250b9"}, {file = "yarl-1.9.4-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:4e9035df8d0880b2f1c7f5031f33f69e071dfe72ee9310cfc76f7b605958ceb9"},
{file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:783185c75c12a017cc345015ea359cc801c3b29a2966c2655cd12b233bf5a2be"}, {file = "yarl-1.9.4-cp311-cp311-musllinux_1_1_ppc64le.whl", hash = "sha256:c0ec0ed476f77db9fb29bca17f0a8fcc7bc97ad4c6c1d8959c507decb22e8572"},
{file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:b8cc1863402472f16c600e3e93d542b7e7542a540f95c30afd472e8e549fc3f7"}, {file = "yarl-1.9.4-cp311-cp311-musllinux_1_1_s390x.whl", hash = "sha256:ee04010f26d5102399bd17f8df8bc38dc7ccd7701dc77f4a68c5b8d733406958"},
{file = "yarl-1.9.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:822b30a0f22e588b32d3120f6d41e4ed021806418b4c9f0bc3048b8c8cb3f92a"}, {file = "yarl-1.9.4-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:49a180c2e0743d5d6e0b4d1a9e5f633c62eca3f8a86ba5dd3c471060e352ca98"},
{file = "yarl-1.9.2-cp311-cp311-win32.whl", hash = "sha256:a60347f234c2212a9f0361955007fcf4033a75bf600a33c88a0a8e91af77c0e8"}, {file = "yarl-1.9.4-cp311-cp311-win32.whl", hash = "sha256:81eb57278deb6098a5b62e88ad8281b2ba09f2f1147c4767522353eaa6260b31"},
{file = "yarl-1.9.2-cp311-cp311-win_amd64.whl", hash = "sha256:be6b3fdec5c62f2a67cb3f8c6dbf56bbf3f61c0f046f84645cd1ca73532ea051"}, {file = "yarl-1.9.4-cp311-cp311-win_amd64.whl", hash = "sha256:d1d2532b340b692880261c15aee4dc94dd22ca5d61b9db9a8a361953d36410b1"},
{file = "yarl-1.9.2-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:38a3928ae37558bc1b559f67410df446d1fbfa87318b124bf5032c31e3447b74"}, {file = "yarl-1.9.4-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:0d2454f0aef65ea81037759be5ca9947539667eecebca092733b2eb43c965a81"},
{file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ac9bb4c5ce3975aeac288cfcb5061ce60e0d14d92209e780c93954076c7c4367"}, {file = "yarl-1.9.4-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:44d8ffbb9c06e5a7f529f38f53eda23e50d1ed33c6c869e01481d3fafa6b8142"},
{file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:3da8a678ca8b96c8606bbb8bfacd99a12ad5dd288bc6f7979baddd62f71c63ef"}, {file = "yarl-1.9.4-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:aaaea1e536f98754a6e5c56091baa1b6ce2f2700cc4a00b0d49eca8dea471074"},
{file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:13414591ff516e04fcdee8dc051c13fd3db13b673c7a4cb1350e6b2ad9639ad3"}, {file = "yarl-1.9.4-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:3777ce5536d17989c91696db1d459574e9a9bd37660ea7ee4d3344579bb6f129"},
{file = "yarl-1.9.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bf74d08542c3a9ea97bb8f343d4fcbd4d8f91bba5ec9d5d7f792dbe727f88938"}, {file = "yarl-1.9.4-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9fc5fc1eeb029757349ad26bbc5880557389a03fa6ada41703db5e068881e5f2"},
{file = "yarl-1.9.2-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:6e7221580dc1db478464cfeef9b03b95c5852cc22894e418562997df0d074ccc"}, {file = "yarl-1.9.4-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ea65804b5dc88dacd4a40279af0cdadcfe74b3e5b4c897aa0d81cf86927fee78"},
{file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:494053246b119b041960ddcd20fd76224149cfea8ed8777b687358727911dd33"}, {file = "yarl-1.9.4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:aa102d6d280a5455ad6a0f9e6d769989638718e938a6a0a2ff3f4a7ff8c62cc4"},
{file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:52a25809fcbecfc63ac9ba0c0fb586f90837f5425edfd1ec9f3372b119585e45"}, {file = "yarl-1.9.4-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:09efe4615ada057ba2d30df871d2f668af661e971dfeedf0c159927d48bbeff0"},
{file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:e65610c5792870d45d7b68c677681376fcf9cc1c289f23e8e8b39c1485384185"}, {file = "yarl-1.9.4-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:008d3e808d03ef28542372d01057fd09168419cdc8f848efe2804f894ae03e51"},
{file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:1b1bba902cba32cdec51fca038fd53f8beee88b77efc373968d1ed021024cc04"}, {file = "yarl-1.9.4-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:6f5cb257bc2ec58f437da2b37a8cd48f666db96d47b8a3115c29f316313654ff"},
{file = "yarl-1.9.2-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:662e6016409828ee910f5d9602a2729a8a57d74b163c89a837de3fea050c7582"}, {file = "yarl-1.9.4-cp312-cp312-musllinux_1_1_ppc64le.whl", hash = "sha256:992f18e0ea248ee03b5a6e8b3b4738850ae7dbb172cc41c966462801cbf62cf7"},
{file = "yarl-1.9.2-cp37-cp37m-win32.whl", hash = "sha256:f364d3480bffd3aa566e886587eaca7c8c04d74f6e8933f3f2c996b7f09bee1b"}, {file = "yarl-1.9.4-cp312-cp312-musllinux_1_1_s390x.whl", hash = "sha256:0e9d124c191d5b881060a9e5060627694c3bdd1fe24c5eecc8d5d7d0eb6faabc"},
{file = "yarl-1.9.2-cp37-cp37m-win_amd64.whl", hash = "sha256:6a5883464143ab3ae9ba68daae8e7c5c95b969462bbe42e2464d60e7e2698368"}, {file = "yarl-1.9.4-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:3986b6f41ad22988e53d5778f91855dc0399b043fc8946d4f2e68af22ee9ff10"},
{file = "yarl-1.9.2-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:5610f80cf43b6202e2c33ba3ec2ee0a2884f8f423c8f4f62906731d876ef4fac"}, {file = "yarl-1.9.4-cp312-cp312-win32.whl", hash = "sha256:4b21516d181cd77ebd06ce160ef8cc2a5e9ad35fb1c5930882baff5ac865eee7"},
{file = "yarl-1.9.2-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:b9a4e67ad7b646cd6f0938c7ebfd60e481b7410f574c560e455e938d2da8e0f4"}, {file = "yarl-1.9.4-cp312-cp312-win_amd64.whl", hash = "sha256:a9bd00dc3bc395a662900f33f74feb3e757429e545d831eef5bb280252631984"},
{file = "yarl-1.9.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:83fcc480d7549ccebe9415d96d9263e2d4226798c37ebd18c930fce43dfb9574"}, {file = "yarl-1.9.4-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:63b20738b5aac74e239622d2fe30df4fca4942a86e31bf47a81a0e94c14df94f"},
{file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:5fcd436ea16fee7d4207c045b1e340020e58a2597301cfbcfdbe5abd2356c2fb"}, {file = "yarl-1.9.4-cp37-cp37m-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:d7d7f7de27b8944f1fee2c26a88b4dabc2409d2fea7a9ed3df79b67277644e17"},
{file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:84e0b1599334b1e1478db01b756e55937d4614f8654311eb26012091be109d59"}, {file = "yarl-1.9.4-cp37-cp37m-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:c74018551e31269d56fab81a728f683667e7c28c04e807ba08f8c9e3bba32f14"},
{file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:3458a24e4ea3fd8930e934c129b676c27452e4ebda80fbe47b56d8c6c7a63a9e"}, {file = "yarl-1.9.4-cp37-cp37m-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:ca06675212f94e7a610e85ca36948bb8fc023e458dd6c63ef71abfd482481aa5"},
{file = "yarl-1.9.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:838162460b3a08987546e881a2bfa573960bb559dfa739e7800ceeec92e64417"}, {file = "yarl-1.9.4-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5aef935237d60a51a62b86249839b51345f47564208c6ee615ed2a40878dccdd"},
{file = "yarl-1.9.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:f4e2d08f07a3d7d3e12549052eb5ad3eab1c349c53ac51c209a0e5991bbada78"}, {file = "yarl-1.9.4-cp37-cp37m-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:2b134fd795e2322b7684155b7855cc99409d10b2e408056db2b93b51a52accc7"},
{file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:de119f56f3c5f0e2fb4dee508531a32b069a5f2c6e827b272d1e0ff5ac040333"}, {file = "yarl-1.9.4-cp37-cp37m-musllinux_1_1_aarch64.whl", hash = "sha256:d25039a474c4c72a5ad4b52495056f843a7ff07b632c1b92ea9043a3d9950f6e"},
{file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:149ddea5abf329752ea5051b61bd6c1d979e13fbf122d3a1f9f0c8be6cb6f63c"}, {file = "yarl-1.9.4-cp37-cp37m-musllinux_1_1_i686.whl", hash = "sha256:f7d6b36dd2e029b6bcb8a13cf19664c7b8e19ab3a58e0fefbb5b8461447ed5ec"},
{file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:674ca19cbee4a82c9f54e0d1eee28116e63bc6fd1e96c43031d11cbab8b2afd5"}, {file = "yarl-1.9.4-cp37-cp37m-musllinux_1_1_ppc64le.whl", hash = "sha256:957b4774373cf6f709359e5c8c4a0af9f6d7875db657adb0feaf8d6cb3c3964c"},
{file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:9b3152f2f5677b997ae6c804b73da05a39daa6a9e85a512e0e6823d81cdad7cc"}, {file = "yarl-1.9.4-cp37-cp37m-musllinux_1_1_s390x.whl", hash = "sha256:d7eeb6d22331e2fd42fce928a81c697c9ee2d51400bd1a28803965883e13cead"},
{file = "yarl-1.9.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:5415d5a4b080dc9612b1b63cba008db84e908b95848369aa1da3686ae27b6d2b"}, {file = "yarl-1.9.4-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:6a962e04b8f91f8c4e5917e518d17958e3bdee71fd1d8b88cdce74dd0ebbf434"},
{file = "yarl-1.9.2-cp38-cp38-win32.whl", hash = "sha256:f7a3d8146575e08c29ed1cd287068e6d02f1c7bdff8970db96683b9591b86ee7"}, {file = "yarl-1.9.4-cp37-cp37m-win32.whl", hash = "sha256:f3bc6af6e2b8f92eced34ef6a96ffb248e863af20ef4fde9448cc8c9b858b749"},
{file = "yarl-1.9.2-cp38-cp38-win_amd64.whl", hash = "sha256:63c48f6cef34e6319a74c727376e95626f84ea091f92c0250a98e53e62c77c72"}, {file = "yarl-1.9.4-cp37-cp37m-win_amd64.whl", hash = "sha256:ad4d7a90a92e528aadf4965d685c17dacff3df282db1121136c382dc0b6014d2"},
{file = "yarl-1.9.2-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:75df5ef94c3fdc393c6b19d80e6ef1ecc9ae2f4263c09cacb178d871c02a5ba9"}, {file = "yarl-1.9.4-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:ec61d826d80fc293ed46c9dd26995921e3a82146feacd952ef0757236fc137be"},
{file = "yarl-1.9.2-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:c027a6e96ef77d401d8d5a5c8d6bc478e8042f1e448272e8d9752cb0aff8b5c8"}, {file = "yarl-1.9.4-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:8be9e837ea9113676e5754b43b940b50cce76d9ed7d2461df1af39a8ee674d9f"},
{file = "yarl-1.9.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:f3b078dbe227f79be488ffcfc7a9edb3409d018e0952cf13f15fd6512847f3f7"}, {file = "yarl-1.9.4-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:bef596fdaa8f26e3d66af846bbe77057237cb6e8efff8cd7cc8dff9a62278bbf"},
{file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:59723a029760079b7d991a401386390c4be5bfec1e7dd83e25a6a0881859e716"}, {file = "yarl-1.9.4-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:2d47552b6e52c3319fede1b60b3de120fe83bde9b7bddad11a69fb0af7db32f1"},
{file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:b03917871bf859a81ccb180c9a2e6c1e04d2f6a51d953e6a5cdd70c93d4e5a2a"}, {file = "yarl-1.9.4-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:84fc30f71689d7fc9168b92788abc977dc8cefa806909565fc2951d02f6b7d57"},
{file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:c1012fa63eb6c032f3ce5d2171c267992ae0c00b9e164efe4d73db818465fac3"}, {file = "yarl-1.9.4-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:4aa9741085f635934f3a2583e16fcf62ba835719a8b2b28fb2917bb0537c1dfa"},
{file = "yarl-1.9.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a74dcbfe780e62f4b5a062714576f16c2f3493a0394e555ab141bf0d746bb955"}, {file = "yarl-1.9.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:206a55215e6d05dbc6c98ce598a59e6fbd0c493e2de4ea6cc2f4934d5a18d130"},
{file = "yarl-1.9.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:8c56986609b057b4839968ba901944af91b8e92f1725d1a2d77cbac6972b9ed1"}, {file = "yarl-1.9.4-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:07574b007ee20e5c375a8fe4a0789fad26db905f9813be0f9fef5a68080de559"},
{file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:2c315df3293cd521033533d242d15eab26583360b58f7ee5d9565f15fee1bef4"}, {file = "yarl-1.9.4-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:5a2e2433eb9344a163aced6a5f6c9222c0786e5a9e9cac2c89f0b28433f56e23"},
{file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:b7232f8dfbd225d57340e441d8caf8652a6acd06b389ea2d3222b8bc89cbfca6"}, {file = "yarl-1.9.4-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:6ad6d10ed9b67a382b45f29ea028f92d25bc0bc1daf6c5b801b90b5aa70fb9ec"},
{file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:53338749febd28935d55b41bf0bcc79d634881195a39f6b2f767870b72514caf"}, {file = "yarl-1.9.4-cp38-cp38-musllinux_1_1_ppc64le.whl", hash = "sha256:6fe79f998a4052d79e1c30eeb7d6c1c1056ad33300f682465e1b4e9b5a188b78"},
{file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:066c163aec9d3d073dc9ffe5dd3ad05069bcb03fcaab8d221290ba99f9f69ee3"}, {file = "yarl-1.9.4-cp38-cp38-musllinux_1_1_s390x.whl", hash = "sha256:a825ec844298c791fd28ed14ed1bffc56a98d15b8c58a20e0e08c1f5f2bea1be"},
{file = "yarl-1.9.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:8288d7cd28f8119b07dd49b7230d6b4562f9b61ee9a4ab02221060d21136be80"}, {file = "yarl-1.9.4-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:8619d6915b3b0b34420cf9b2bb6d81ef59d984cb0fde7544e9ece32b4b3043c3"},
{file = "yarl-1.9.2-cp39-cp39-win32.whl", hash = "sha256:b124e2a6d223b65ba8768d5706d103280914d61f5cae3afbc50fc3dfcc016623"}, {file = "yarl-1.9.4-cp38-cp38-win32.whl", hash = "sha256:686a0c2f85f83463272ddffd4deb5e591c98aac1897d65e92319f729c320eece"},
{file = "yarl-1.9.2-cp39-cp39-win_amd64.whl", hash = "sha256:61016e7d582bc46a5378ffdd02cd0314fb8ba52f40f9cf4d9a5e7dbef88dee18"}, {file = "yarl-1.9.4-cp38-cp38-win_amd64.whl", hash = "sha256:a00862fb23195b6b8322f7d781b0dc1d82cb3bcac346d1e38689370cc1cc398b"},
{file = "yarl-1.9.2.tar.gz", hash = "sha256:04ab9d4b9f587c06d801c2abfe9317b77cdf996c65a90d5e84ecc45010823571"}, {file = "yarl-1.9.4-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:604f31d97fa493083ea21bd9b92c419012531c4e17ea6da0f65cacdcf5d0bd27"},
{file = "yarl-1.9.4-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:8a854227cf581330ffa2c4824d96e52ee621dd571078a252c25e3a3b3d94a1b1"},
{file = "yarl-1.9.4-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ba6f52cbc7809cd8d74604cce9c14868306ae4aa0282016b641c661f981a6e91"},
{file = "yarl-1.9.4-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a6327976c7c2f4ee6816eff196e25385ccc02cb81427952414a64811037bbc8b"},
{file = "yarl-1.9.4-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:8397a3817d7dcdd14bb266283cd1d6fc7264a48c186b986f32e86d86d35fbac5"},
{file = "yarl-1.9.4-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:e0381b4ce23ff92f8170080c97678040fc5b08da85e9e292292aba67fdac6c34"},
{file = "yarl-1.9.4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:23d32a2594cb5d565d358a92e151315d1b2268bc10f4610d098f96b147370136"},
{file = "yarl-1.9.4-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:ddb2a5c08a4eaaba605340fdee8fc08e406c56617566d9643ad8bf6852778fc7"},
{file = "yarl-1.9.4-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:26a1dc6285e03f3cc9e839a2da83bcbf31dcb0d004c72d0730e755b33466c30e"},
{file = "yarl-1.9.4-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:18580f672e44ce1238b82f7fb87d727c4a131f3a9d33a5e0e82b793362bf18b4"},
{file = "yarl-1.9.4-cp39-cp39-musllinux_1_1_ppc64le.whl", hash = "sha256:29e0f83f37610f173eb7e7b5562dd71467993495e568e708d99e9d1944f561ec"},
{file = "yarl-1.9.4-cp39-cp39-musllinux_1_1_s390x.whl", hash = "sha256:1f23e4fe1e8794f74b6027d7cf19dc25f8b63af1483d91d595d4a07eca1fb26c"},
{file = "yarl-1.9.4-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:db8e58b9d79200c76956cefd14d5c90af54416ff5353c5bfd7cbe58818e26ef0"},
{file = "yarl-1.9.4-cp39-cp39-win32.whl", hash = "sha256:c7224cab95645c7ab53791022ae77a4509472613e839dab722a72abe5a684575"},
{file = "yarl-1.9.4-cp39-cp39-win_amd64.whl", hash = "sha256:824d6c50492add5da9374875ce72db7a0733b29c2394890aef23d533106e2b15"},
{file = "yarl-1.9.4-py3-none-any.whl", hash = "sha256:928cecb0ef9d5a7946eb6ff58417ad2fe9375762382f1bf5c55e61645f2c43ad"},
{file = "yarl-1.9.4.tar.gz", hash = "sha256:566db86717cf8080b99b58b083b773a908ae40f06681e87e589a976faf8246bf"},
] ]
[package.dependencies] [package.dependencies]
samples/security/roles.py
+6 -1
View File
@@ -9,6 +9,8 @@
# Modifications Copyright OpenSearch Contributors. See # Modifications Copyright OpenSearch Contributors. See
# GitHub history for details. # GitHub history for details.
import os
from opensearchpy import OpenSearch from opensearchpy import OpenSearch
@@ -20,7 +22,10 @@ def main() -> None:
host = "localhost" host = "localhost"
port = 9200 port = 9200
auth = ("admin", "admin") # For testing only. Don't store credentials in code. auth = (
"admin",
os.getenv("OPENSEARCH_PASSWORD", "admin"),
) # For testing only. Don't store credentials in code.
client = OpenSearch( client = OpenSearch(
hosts=[{"host": host, "port": port}], hosts=[{"host": host, "port": port}],
samples/security/users.py
+6 -1
View File
@@ -9,6 +9,8 @@
# Modifications Copyright OpenSearch Contributors. See # Modifications Copyright OpenSearch Contributors. See
# GitHub history for details. # GitHub history for details.
import os
from opensearchpy import OpenSearch from opensearchpy import OpenSearch
@@ -20,7 +22,10 @@ def main() -> None:
host = "localhost" host = "localhost"
port = 9200 port = 9200
auth = ("admin", "admin") # For testing only. Don't store credentials in code. auth = (
"admin",
os.getenv("OPENSEARCH_PASSWORD", "admin"),
) # For testing only. Don't store credentials in code.
client = OpenSearch( client = OpenSearch(
hosts=[{"host": host, "port": port}], hosts=[{"host": host, "port": port}],
setup.py
+4 -4
View File
@@ -54,11 +54,11 @@ packages = [
if package == MODULE_DIR or package.startswith(MODULE_DIR + ".") if package == MODULE_DIR or package.startswith(MODULE_DIR + ".")
] ]
install_requires = [ install_requires = [
'urllib3>=1.26.18,<1.27 ; python_version < "3.10"', 'urllib3>=1.26.19,<1.27 ; python_version < "3.10"',
'urllib3>=1.26.18,!=2.2.0,<3 ; python_version >= "3.10"', 'urllib3>=1.26.19,!=2.2.0,!=2.2.1,<3 ; python_version >= "3.10"',
"requests>=2.4.0, <3.0.0", "requests>=2.32.0, <3.0.0",
"python-dateutil", "python-dateutil",
"certifi>=2022.12.07", "certifi>=2024.07.04",
"Events", "Events",
] ]
tests_require = [ tests_require = [
utils/generate_api.py
+2 -3
View File
@@ -397,10 +397,9 @@ class API:
and self.name == "create_data_stream" and self.name == "create_data_stream"
and part == "name" and part == "name"
): ):
replace_str = r"`\`, "
# Replace the string in the description # Replace the string in the description
parts["name"]["description"] = parts["name"]["description"].replace( parts["name"]["description"] = parts["name"]["description"].replace(
replace_str, "" r"`\`, ", ""
) )
if "backslash" not in parts["name"]["description"]: if "backslash" not in parts["name"]["description"]:
parts["name"]["description"] = parts["name"]["description"].replace( parts["name"]["description"] = parts["name"]["description"].replace(
@@ -624,7 +623,7 @@ def read_modules() -> Any:
param_dict: Dict[str, Any] = {} param_dict: Dict[str, Any] = {}
if "description" in param: if "description" in param:
param_dict.update( param_dict.update(
description=param["description"].replace("\n", "") description=param["description"].replace("\n", " ")
) )
if "type" in param["schema"]: if "type" in param["schema"]: