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

Updated opensearch-py to reflect the latest OpenSearch API spec (2024-07-15) (#775)

Browse Source 
Signed-off-by: GitHub <noreply@github.com>
Co-authored-by: saimedhi <saimedhi@users.noreply.github.com>
This commit is contained in:
opensearch-trigger-bot[bot]
2024-07-15 08:30:16 -04:00
committed by GitHub
parent a380e7083f
commit ea0a718754
17 changed files with 161 additions and 160 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+1
View File
@@ -10,6 +10,7 @@ Inspired from [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
### Fixed ### Fixed
- 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))
### Updated APIs ### Updated APIs
- 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@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@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@f2afd71](https://github.com/opensearch-project/opensearch-api-specification/commit/f2afd7171406c7477fbd644d74087bb0e2948c75)
opensearchpy/_async/client/__init__.py
+31 -31
View File
@@ -373,8 +373,8 @@ class AsyncOpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. 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
@@ -463,8 +463,8 @@ class AsyncOpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. 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
@@ -658,8 +658,8 @@ class AsyncOpenSearch(Client):
: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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -746,8 +746,8 @@ class AsyncOpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. 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
@@ -875,7 +875,7 @@ class AsyncOpenSearch(Client):
request.Defaults to no timeout. request.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
query_then_fetch, dfs_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.
:arg slices: The number of slices this task should be divided :arg slices: The number of slices this task should be divided
into. Valid choices are auto. into. Valid choices are auto.
@@ -1066,8 +1066,8 @@ class AsyncOpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1134,8 +1134,8 @@ class AsyncOpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1266,8 +1266,8 @@ class AsyncOpenSearch(Client):
: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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. hidden, none, open.
:arg fields: Comma-separated list of fields to retrieve :arg fields: Comma-separated list of fields to retrieve
capabilities for. Wildcard (`*`) expressions are supported. capabilities for. Wildcard (`*`) expressions are supported.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1353,7 +1353,7 @@ class AsyncOpenSearch(Client):
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.
:arg version_type: Specific version type: internal, external, :arg version_type: Specific version type: internal, external,
external_gte. Valid choices are internal, external, external_gte, force. external_gte. Valid choices are external, external_gte, force, internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1463,7 +1463,7 @@ class AsyncOpenSearch(Client):
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.
:arg version_type: Specific version type: internal, external, :arg version_type: Specific version type: internal, external,
external_gte. Valid choices are internal, external, external_gte, force. external_gte. Valid choices are external, external_gte, force, internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1606,7 +1606,7 @@ class AsyncOpenSearch(Client):
Default is false. Default is false.
:arg search_type: Indicates whether global term and document :arg search_type: Indicates whether global term and document
frequencies should be used when scoring returned documents. Valid frequencies should be used when scoring returned documents. Valid
choices are query_then_fetch, dfs_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
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 typed_keys: Specifies whether aggregation and suggester :arg typed_keys: Specifies whether aggregation and suggester
@@ -1669,7 +1669,7 @@ class AsyncOpenSearch(Client):
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
query_then_fetch, dfs_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
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 typed_keys: If `true`, the response prefixes aggregation :arg typed_keys: If `true`, the response prefixes aggregation
@@ -1757,7 +1757,7 @@ class AsyncOpenSearch(Client):
: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 version_type: Specific version type. Valid choices are :arg version_type: Specific version type. Valid choices are
internal, external, external_gte, force. external, external_gte, force, internal.
""" """
path = _make_path(index, "_mtermvectors") path = _make_path(index, "_mtermvectors")
@@ -1864,7 +1864,7 @@ class AsyncOpenSearch(Client):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -2229,8 +2229,8 @@ class AsyncOpenSearch(Client):
: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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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
@@ -2307,8 +2307,8 @@ class AsyncOpenSearch(Client):
:arg search_pipeline: Customizable sequence of processing stages :arg search_pipeline: Customizable sequence of processing stages
applied to search queries. applied to search queries.
:arg search_type: How distributed term frequencies are :arg search_type: How distributed term frequencies are
calculated for relevance scoring. Valid choices are query_then_fetch, calculated for relevance scoring. Valid choices are
dfs_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
@@ -2329,7 +2329,7 @@ class AsyncOpenSearch(Client):
suggestions. suggestions.
:arg suggest_mode: Specifies the suggest mode.This parameter can :arg suggest_mode: Specifies the suggest mode.This parameter can
only be used when the `suggest_field` and `suggest_text` query string only be used when the `suggest_field` and `suggest_text` query string
parameters are specified. Valid choices are missing, popular, always. parameters are specified. Valid choices are always, missing, popular.
:arg suggest_size: Number of suggestions to return.This :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.
@@ -2502,7 +2502,7 @@ class AsyncOpenSearch(Client):
:arg scroll: Specifies how long a consistent view of the :arg scroll: Specifies how long a consistent view of the
indexshould be maintained for scrolled search. indexshould 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 query_then_fetch, dfs_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
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 typed_keys: If `true`, the response prefixes aggregation :arg typed_keys: If `true`, the response prefixes aggregation
@@ -2588,7 +2588,7 @@ class AsyncOpenSearch(Client):
: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 version_type: Specific version type. Valid choices are :arg version_type: Specific version type. Valid choices are
internal, external, external_gte, force. external, external_gte, force, internal.
""" """
if index in SKIP_IN_PATH: if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index'.") raise ValueError("Empty value passed for a required argument 'index'.")
@@ -2656,7 +2656,7 @@ class AsyncOpenSearch(Client):
: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 operationvisible 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 operationvisible to search, if 'false' do
nothing with refreshes. Valid choices are true, false, 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.
:arg retry_on_conflict: Specify how many times should the :arg retry_on_conflict: Specify how many times should the
@@ -2805,7 +2805,7 @@ class AsyncOpenSearch(Client):
:arg search_timeout: Explicit timeout for each search request. :arg search_timeout: Explicit timeout for each search request.
: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
query_then_fetch, dfs_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.
:arg slices: The number of slices this task should be divided :arg slices: The number of slices this task should be divided
into. Valid choices are auto. into. Valid choices are auto.
@@ -2965,7 +2965,7 @@ class AsyncOpenSearch(Client):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
opensearchpy/_async/client/cat.py
+23 -23
View File
@@ -72,7 +72,7 @@ class CatClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 format: A short version of the Accept header, e.g. json, :arg format: A short version of the Accept header, e.g. json,
@@ -118,7 +118,7 @@ class CatClient(NamespacedClient):
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -171,7 +171,7 @@ class CatClient(NamespacedClient):
:arg node_id: Comma-separated list of node identifiers or names :arg node_id: Comma-separated list of node identifiers or names
used to limit the returned information. used to limit the returned information.
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -332,7 +332,7 @@ class CatClient(NamespacedClient):
:arg fields: Comma-separated list of fields used to limit :arg fields: Comma-separated list of fields used to limit
returned information. returned information.
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -398,7 +398,7 @@ class CatClient(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 time: The unit used to display time values. Valid choices :arg time: The unit used to display time values. Valid choices
are nanos, micros, ms, s, m, h, d. are d, h, m, micros, ms, nanos, s.
:arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps. :arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
Default is True. Default is True.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
@@ -468,13 +468,13 @@ class CatClient(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 bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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: The type of index that wildcard patterns :arg expand_wildcards: The type of index that wildcard patterns
can match. Valid choices are all, open, closed, hidden, none. can match. Valid choices 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
the response. the response.
:arg format: A short version of the Accept header, e.g. json, :arg format: A short version of the Accept header, e.g. json,
@@ -482,7 +482,7 @@ class CatClient(NamespacedClient):
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg health: The health status used to limit returned indices. :arg health: The health status used to limit returned indices.
By default, the response includes indices of any health status. Valid By default, the response includes indices of any health status. Valid
choices are green, yellow, red. choices are green, red, yellow.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
@@ -503,7 +503,7 @@ class CatClient(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 time: The unit used to display time values. Valid choices :arg time: The unit used to display time values. Valid choices
are nanos, micros, ms, s, m, h, d. are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -649,7 +649,7 @@ class CatClient(NamespacedClient):
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -677,7 +677,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -733,7 +733,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -764,7 +764,7 @@ class CatClient(NamespacedClient):
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -871,7 +871,7 @@ class CatClient(NamespacedClient):
:arg active_only: If `true`, the response only includes ongoing :arg active_only: If `true`, the response only includes ongoing
shard recoveries. Default is false. shard recoveries. Default is false.
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. 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
@@ -891,7 +891,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -993,7 +993,7 @@ class CatClient(NamespacedClient):
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified). string or when no indices have been specified).
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg completed_only: If `true`, the response only includes :arg completed_only: If `true`, the response only includes
latest completed segment replication events. Default is false. latest completed segment replication events. Default is false.
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
@@ -1002,7 +1002,7 @@ class CatClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 format: A short version of the Accept header, e.g. json, :arg format: A short version of the Accept header, e.g. json,
@@ -1023,7 +1023,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
@@ -1063,7 +1063,7 @@ class CatClient(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 bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -1122,7 +1122,7 @@ class CatClient(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 bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -1147,7 +1147,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -1270,7 +1270,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
@@ -1334,7 +1334,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
opensearchpy/_async/client/cluster.py
+6 -6
View File
@@ -82,14 +82,14 @@ class ClusterClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg level: Can be one of cluster, indices or shards. Controls :arg level: Can be one of cluster, indices or shards. Controls
the details level of the health information returned. Valid choices are the details level of the health information returned. Valid choices are
cluster, indices, shards, awareness_attributes. awareness_attributes, cluster, indices, shards.
: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.
@@ -109,8 +109,8 @@ class ClusterClient(NamespacedClient):
be active, or 0 to not wait. Valid choices are all, index-setting. be active, or 0 to not wait. Valid choices are all, index-setting.
:arg wait_for_events: Can be one of immediate, urgent, high, :arg wait_for_events: Can be one of immediate, urgent, high,
normal, low, languid. Wait until all currently queued events with the normal, low, languid. Wait until all currently queued events with the
given priority are processed. Valid choices are immediate, urgent, high, given priority are processed. Valid choices are high, immediate,
normal, low, languid. languid, low, normal, urgent.
:arg wait_for_no_initializing_shards: A boolean value which :arg wait_for_no_initializing_shards: A boolean value which
controls whether to wait (until the timeout provided) for the cluster to controls whether to wait (until the timeout provided) for the cluster to
have no shard initializations. Defaults to false, which means it will have no shard initializations. Defaults to false, which means it will
@@ -126,7 +126,7 @@ class ClusterClient(NamespacedClient):
:arg wait_for_status: One of green, yellow or red. Will wait :arg wait_for_status: One of green, yellow or red. Will wait
(until the timeout provided) until the status of the cluster changes to (until the timeout provided) until the status of the cluster changes to
the one provided or better, i.e. green > yellow > red. By default, will the one provided or better, i.e. green > yellow > red. By default, will
not wait for any status. Valid choices are green, yellow, red. not wait for any status. Valid choices are green, red, yellow.
""" """
return await self.transport.perform_request( return await self.transport.perform_request(
"GET", "GET",
@@ -219,7 +219,7 @@ class ClusterClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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: Return settings in flat format. Default is :arg flat_settings: Return settings in flat format. Default is
opensearchpy/_async/client/indices.py
+12 -12
View File
@@ -348,7 +348,7 @@ class IndicesClient(NamespacedClient):
can match. If the request can target data streams, this can match. If the request can target data streams, this
argumentdetermines whether wildcard expressions match hidden data argumentdetermines whether wildcard expressions match hidden data
streams. Supports comma-separated values,such as open,hidden. Valid streams. Supports comma-separated values,such as open,hidden. Valid
choices are all, open, closed, hidden, none. choices 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
the response. the response.
:arg flat_settings: If true, returns settings in flat format. :arg flat_settings: If true, returns settings in flat format.
@@ -1377,8 +1377,8 @@ 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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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.
@@ -1447,8 +1447,8 @@ 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 targetdata streams, this argument determines match. If the request can targetdata streams, this argument determines
whether wildcard expressions matchhidden data streams. Supports comma- whether wildcard expressions matchhidden data streams. Supports comma-
separated values, such as`open,hidden`. Valid choices are all, open, separated values, such as`open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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.
@@ -1520,8 +1520,8 @@ 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 argumentdetermines match. If the request can target data streams, this argumentdetermines
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, open, separated values,such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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.
:arg fields: Comma-separated list or wildcard expressions of :arg fields: Comma-separated list or wildcard expressions of
@@ -1820,7 +1820,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1869,7 +1869,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1917,7 +1917,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. Valid choices whether wildcard expressions match hidden data streams. Valid choices
are all, open, closed, hidden, none. 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
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1969,7 +1969,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 flush: Specify whether the index should be flushed after :arg flush: Specify whether the index should be flushed after
@@ -2712,7 +2712,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
opensearchpy/_async/client/nodes.py
+2 -2
View File
@@ -220,8 +220,8 @@ class NodesClient(NamespacedClient):
the returned information; use `_local` to return information from the the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all node you're connecting to, leave empty to get information from all
nodes. nodes.
:arg doc_type: The type to sample. Valid choices are cpu, wait, :arg doc_type: The type to sample. Valid choices are block, cpu,
block. wait.
: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
opensearchpy/_async/client/tasks.py
+1 -1
View File
@@ -73,7 +73,7 @@ class TasksClient(NamespacedClient):
: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 group_by: Key used to group tasks in the response. Valid :arg group_by: Key used to group tasks in the response. Valid
choices are nodes, parents, none. choices are nodes, none, parents.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg nodes: Comma-separated list of node IDs or names to limit :arg nodes: Comma-separated list of node IDs or names to limit
opensearchpy/_async/plugins/knn.py
+3 -3
View File
@@ -180,7 +180,7 @@ class KnnClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. closed, hidden, none, open.
:arg explain: Specify whether to return detailed information :arg explain: Specify whether to return detailed information
about score computation as part of a hit. 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
@@ -219,7 +219,7 @@ class KnnClient(NamespacedClient):
:arg scroll: Specify how long a consistent view of the index :arg scroll: Specify how long a consistent view of the index
should be maintained for scrolled search. should be maintained for scrolled search.
:arg search_type: Search operation type. Valid choices are :arg search_type: Search operation type. Valid choices are
query_then_fetch, dfs_query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg seq_no_primary_term: Specify whether to return sequence :arg seq_no_primary_term: Specify whether to return sequence
number and primary term of the last modification of each hit. number and primary term of the last modification of each hit.
:arg size: Number of hits to return. Default is 10. :arg size: Number of hits to return. Default is 10.
@@ -232,7 +232,7 @@ class KnnClient(NamespacedClient):
return. return.
:arg suggest_field: Specify which field to use for suggestions. :arg suggest_field: Specify which field to use for suggestions.
:arg suggest_mode: Specify suggest mode. Valid choices are :arg suggest_mode: Specify suggest mode. Valid choices are
missing, popular, always. always, missing, popular.
:arg suggest_size: How many suggestions to return in response. :arg suggest_size: How many suggestions to return in response.
:arg suggest_text: The source text for which the suggestions :arg suggest_text: The source text for which the suggestions
should be returned. should be returned.
opensearchpy/_async/plugins/notifications.py
+2 -2
View File
@@ -212,8 +212,8 @@ class NotificationsClient(NamespacedClient):
:arg config_type: Type of notification configuration. Valid :arg config_type: Type of notification configuration. Valid
choices are slack, chime, microsoft_teams, webhook, email, sns, choices are chime, email, email_group, microsoft_teams, ses_account,
ses_account, smtp_account, email_group. slack, smtp_account, sns, webhook.
: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
opensearchpy/client/__init__.py
+31 -31
View File
@@ -373,8 +373,8 @@ class OpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. 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
@@ -463,8 +463,8 @@ class OpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. 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
@@ -658,8 +658,8 @@ class OpenSearch(Client):
: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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -746,8 +746,8 @@ class OpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. 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
@@ -875,7 +875,7 @@ class OpenSearch(Client):
request.Defaults to no timeout. request.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
query_then_fetch, dfs_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.
:arg slices: The number of slices this task should be divided :arg slices: The number of slices this task should be divided
into. Valid choices are auto. into. Valid choices are auto.
@@ -1066,8 +1066,8 @@ class OpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1134,8 +1134,8 @@ class OpenSearch(Client):
control.The specified version must match the current version of the control.The specified version must match the current version of the
document for the request to succeed. document for the request to succeed.
:arg version_type: Specific version type: `external`, :arg version_type: Specific version type: `external`,
`external_gte`. Valid choices are internal, external, external_gte, `external_gte`. Valid choices are external, external_gte, force,
force. internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1266,8 +1266,8 @@ class OpenSearch(Client):
: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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. hidden, none, open.
:arg fields: Comma-separated list of fields to retrieve :arg fields: Comma-separated list of fields to retrieve
capabilities for. Wildcard (`*`) expressions are supported. capabilities for. Wildcard (`*`) expressions are supported.
:arg filter_path: Comma-separated list of filters used to reduce :arg filter_path: Comma-separated list of filters used to reduce
@@ -1353,7 +1353,7 @@ class OpenSearch(Client):
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.
:arg version_type: Specific version type: internal, external, :arg version_type: Specific version type: internal, external,
external_gte. Valid choices are internal, external, external_gte, force. external_gte. Valid choices are external, external_gte, force, internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1463,7 +1463,7 @@ class OpenSearch(Client):
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.
:arg version_type: Specific version type: internal, external, :arg version_type: Specific version type: internal, external,
external_gte. Valid choices are internal, external, external_gte, force. external_gte. Valid choices are external, external_gte, force, internal.
""" """
for param in (index, id): for param in (index, id):
if param in SKIP_IN_PATH: if param in SKIP_IN_PATH:
@@ -1606,7 +1606,7 @@ class OpenSearch(Client):
Default is false. Default is false.
:arg search_type: Indicates whether global term and document :arg search_type: Indicates whether global term and document
frequencies should be used when scoring returned documents. Valid frequencies should be used when scoring returned documents. Valid
choices are query_then_fetch, dfs_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
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 typed_keys: Specifies whether aggregation and suggester :arg typed_keys: Specifies whether aggregation and suggester
@@ -1669,7 +1669,7 @@ class OpenSearch(Client):
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
query_then_fetch, dfs_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
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 typed_keys: If `true`, the response prefixes aggregation :arg typed_keys: If `true`, the response prefixes aggregation
@@ -1757,7 +1757,7 @@ class OpenSearch(Client):
: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 version_type: Specific version type. Valid choices are :arg version_type: Specific version type. Valid choices are
internal, external, external_gte, force. external, external_gte, force, internal.
""" """
path = _make_path(index, "_mtermvectors") path = _make_path(index, "_mtermvectors")
@@ -1864,7 +1864,7 @@ class OpenSearch(Client):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -2229,8 +2229,8 @@ class OpenSearch(Client):
: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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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
@@ -2307,8 +2307,8 @@ class OpenSearch(Client):
:arg search_pipeline: Customizable sequence of processing stages :arg search_pipeline: Customizable sequence of processing stages
applied to search queries. applied to search queries.
:arg search_type: How distributed term frequencies are :arg search_type: How distributed term frequencies are
calculated for relevance scoring. Valid choices are query_then_fetch, calculated for relevance scoring. Valid choices are
dfs_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
@@ -2329,7 +2329,7 @@ class OpenSearch(Client):
suggestions. suggestions.
:arg suggest_mode: Specifies the suggest mode.This parameter can :arg suggest_mode: Specifies the suggest mode.This parameter can
only be used when the `suggest_field` and `suggest_text` query string only be used when the `suggest_field` and `suggest_text` query string
parameters are specified. Valid choices are missing, popular, always. parameters are specified. Valid choices are always, missing, popular.
:arg suggest_size: Number of suggestions to return.This :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.
@@ -2502,7 +2502,7 @@ class OpenSearch(Client):
:arg scroll: Specifies how long a consistent view of the :arg scroll: Specifies how long a consistent view of the
indexshould be maintained for scrolled search. indexshould 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 query_then_fetch, dfs_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
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 typed_keys: If `true`, the response prefixes aggregation :arg typed_keys: If `true`, the response prefixes aggregation
@@ -2588,7 +2588,7 @@ class OpenSearch(Client):
: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 version_type: Specific version type. Valid choices are :arg version_type: Specific version type. Valid choices are
internal, external, external_gte, force. external, external_gte, force, internal.
""" """
if index in SKIP_IN_PATH: if index in SKIP_IN_PATH:
raise ValueError("Empty value passed for a required argument 'index'.") raise ValueError("Empty value passed for a required argument 'index'.")
@@ -2656,7 +2656,7 @@ class OpenSearch(Client):
: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 operationvisible 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 operationvisible to search, if 'false' do
nothing with refreshes. Valid choices are true, false, 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.
:arg retry_on_conflict: Specify how many times should the :arg retry_on_conflict: Specify how many times should the
@@ -2805,7 +2805,7 @@ class OpenSearch(Client):
:arg search_timeout: Explicit timeout for each search request. :arg search_timeout: Explicit timeout for each search request.
: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
query_then_fetch, dfs_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.
:arg slices: The number of slices this task should be divided :arg slices: The number of slices this task should be divided
into. Valid choices are auto. into. Valid choices are auto.
@@ -2965,7 +2965,7 @@ class OpenSearch(Client):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
opensearchpy/client/cat.py
+23 -23
View File
@@ -72,7 +72,7 @@ class CatClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 format: A short version of the Accept header, e.g. json, :arg format: A short version of the Accept header, e.g. json,
@@ -118,7 +118,7 @@ class CatClient(NamespacedClient):
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -171,7 +171,7 @@ class CatClient(NamespacedClient):
:arg node_id: Comma-separated list of node identifiers or names :arg node_id: Comma-separated list of node identifiers or names
used to limit the returned information. used to limit the returned information.
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -332,7 +332,7 @@ class CatClient(NamespacedClient):
:arg fields: Comma-separated list of fields used to limit :arg fields: Comma-separated list of fields used to limit
returned information. returned information.
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -398,7 +398,7 @@ class CatClient(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 time: The unit used to display time values. Valid choices :arg time: The unit used to display time values. Valid choices
are nanos, micros, ms, s, m, h, d. are d, h, m, micros, ms, nanos, s.
:arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps. :arg ts: If true, returns `HH:MM:SS` and Unix epoch timestamps.
Default is True. Default is True.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
@@ -468,13 +468,13 @@ class CatClient(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 bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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: The type of index that wildcard patterns :arg expand_wildcards: The type of index that wildcard patterns
can match. Valid choices are all, open, closed, hidden, none. can match. Valid choices 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
the response. the response.
:arg format: A short version of the Accept header, e.g. json, :arg format: A short version of the Accept header, e.g. json,
@@ -482,7 +482,7 @@ class CatClient(NamespacedClient):
:arg h: Comma-separated list of column names to display. :arg h: Comma-separated list of column names to display.
:arg health: The health status used to limit returned indices. :arg health: The health status used to limit returned indices.
By default, the response includes indices of any health status. Valid By default, the response includes indices of any health status. Valid
choices are green, yellow, red. choices are green, red, yellow.
:arg help: Return help information. Default is false. :arg help: Return help information. Default is false.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
@@ -503,7 +503,7 @@ class CatClient(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 time: The unit used to display time values. Valid choices :arg time: The unit used to display time values. Valid choices
are nanos, micros, ms, s, m, h, d. are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -649,7 +649,7 @@ class CatClient(NamespacedClient):
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -677,7 +677,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -733,7 +733,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -764,7 +764,7 @@ class CatClient(NamespacedClient):
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -871,7 +871,7 @@ class CatClient(NamespacedClient):
:arg active_only: If `true`, the response only includes ongoing :arg active_only: If `true`, the response only includes ongoing
shard recoveries. Default is false. shard recoveries. Default is false.
:arg bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
information about shard recoveries. Default is false. information about shard recoveries. 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
@@ -891,7 +891,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -993,7 +993,7 @@ class CatClient(NamespacedClient):
expression resolves into no concrete indices. (This includes `_all` expression resolves into no concrete indices. (This includes `_all`
string or when no indices have been specified). string or when no indices have been specified).
:arg bytes: The unit in which to display byte values. Valid :arg bytes: The unit in which to display byte values. Valid
choices are b, k, kb, m, mb, g, gb, t, tb, p, pb. choices are b, g, gb, k, kb, m, mb, p, pb, t, tb.
:arg completed_only: If `true`, the response only includes :arg completed_only: If `true`, the response only includes
latest completed segment replication events. Default is false. latest completed segment replication events. Default is false.
:arg detailed: If `true`, the response includes detailed :arg detailed: If `true`, the response includes detailed
@@ -1002,7 +1002,7 @@ class CatClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 format: A short version of the Accept header, e.g. json, :arg format: A short version of the Accept header, e.g. json,
@@ -1023,7 +1023,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg timeout: Operation timeout. :arg timeout: Operation timeout.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
@@ -1063,7 +1063,7 @@ class CatClient(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 bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -1122,7 +1122,7 @@ class CatClient(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 bytes: The unit used to display byte values. Valid choices :arg bytes: The unit used to display byte values. Valid choices
are b, k, kb, m, mb, g, gb, t, tb, p, pb. are b, g, gb, k, kb, m, mb, p, pb, t, tb.
: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
@@ -1147,7 +1147,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -1270,7 +1270,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
@@ -1334,7 +1334,7 @@ class CatClient(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 time: The unit in which to display time values. Valid :arg time: The unit in which to display time values. Valid
choices are nanos, micros, ms, s, m, h, d. choices are d, h, m, micros, ms, nanos, s.
:arg v: Verbose mode. Display column headers. Default is false. :arg v: Verbose mode. Display column headers. Default is false.
""" """
return self.transport.perform_request( return self.transport.perform_request(
opensearchpy/client/cluster.py
+6 -6
View File
@@ -82,14 +82,14 @@ class ClusterClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg level: Can be one of cluster, indices or shards. Controls :arg level: Can be one of cluster, indices or shards. Controls
the details level of the health information returned. Valid choices are the details level of the health information returned. Valid choices are
cluster, indices, shards, awareness_attributes. awareness_attributes, cluster, indices, shards.
: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.
@@ -109,8 +109,8 @@ class ClusterClient(NamespacedClient):
be active, or 0 to not wait. Valid choices are all, index-setting. be active, or 0 to not wait. Valid choices are all, index-setting.
:arg wait_for_events: Can be one of immediate, urgent, high, :arg wait_for_events: Can be one of immediate, urgent, high,
normal, low, languid. Wait until all currently queued events with the normal, low, languid. Wait until all currently queued events with the
given priority are processed. Valid choices are immediate, urgent, high, given priority are processed. Valid choices are high, immediate,
normal, low, languid. languid, low, normal, urgent.
:arg wait_for_no_initializing_shards: A boolean value which :arg wait_for_no_initializing_shards: A boolean value which
controls whether to wait (until the timeout provided) for the cluster to controls whether to wait (until the timeout provided) for the cluster to
have no shard initializations. Defaults to false, which means it will have no shard initializations. Defaults to false, which means it will
@@ -126,7 +126,7 @@ class ClusterClient(NamespacedClient):
:arg wait_for_status: One of green, yellow or red. Will wait :arg wait_for_status: One of green, yellow or red. Will wait
(until the timeout provided) until the status of the cluster changes to (until the timeout provided) until the status of the cluster changes to
the one provided or better, i.e. green > yellow > red. By default, will the one provided or better, i.e. green > yellow > red. By default, will
not wait for any status. Valid choices are green, yellow, red. not wait for any status. Valid choices are green, red, yellow.
""" """
return self.transport.perform_request( return self.transport.perform_request(
"GET", "GET",
@@ -219,7 +219,7 @@ class ClusterClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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: Return settings in flat format. Default is :arg flat_settings: Return settings in flat format. Default is
opensearchpy/client/indices.py
+12 -12
View File
@@ -348,7 +348,7 @@ class IndicesClient(NamespacedClient):
can match. If the request can target data streams, this can match. If the request can target data streams, this
argumentdetermines whether wildcard expressions match hidden data argumentdetermines whether wildcard expressions match hidden data
streams. Supports comma-separated values,such as open,hidden. Valid streams. Supports comma-separated values,such as open,hidden. Valid
choices are all, open, closed, hidden, none. choices 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
the response. the response.
:arg flat_settings: If true, returns settings in flat format. :arg flat_settings: If true, returns settings in flat format.
@@ -1377,8 +1377,8 @@ 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, open, separated values, such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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.
@@ -1447,8 +1447,8 @@ 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 targetdata streams, this argument determines match. If the request can targetdata streams, this argument determines
whether wildcard expressions matchhidden data streams. Supports comma- whether wildcard expressions matchhidden data streams. Supports comma-
separated values, such as`open,hidden`. Valid choices are all, open, separated values, such as`open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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.
@@ -1520,8 +1520,8 @@ 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 argumentdetermines match. If the request can target data streams, this argumentdetermines
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, open, separated values,such as `open,hidden`. Valid choices are all, closed,
closed, hidden, none. 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.
:arg fields: Comma-separated list or wildcard expressions of :arg fields: Comma-separated list or wildcard expressions of
@@ -1820,7 +1820,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1869,7 +1869,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1917,7 +1917,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. Valid choices whether wildcard expressions match hidden data streams. Valid choices
are all, open, closed, hidden, none. 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
the response. the response.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
@@ -1969,7 +1969,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 flush: Specify whether the index should be flushed after :arg flush: Specify whether the index should be flushed after
@@ -2712,7 +2712,7 @@ class IndicesClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. 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 human: Whether to return human readable values for :arg human: Whether to return human readable values for
opensearchpy/client/nodes.py
+2 -2
View File
@@ -220,8 +220,8 @@ class NodesClient(NamespacedClient):
the returned information; use `_local` to return information from the the returned information; use `_local` to return information from the
node you're connecting to, leave empty to get information from all node you're connecting to, leave empty to get information from all
nodes. nodes.
:arg doc_type: The type to sample. Valid choices are cpu, wait, :arg doc_type: The type to sample. Valid choices are block, cpu,
block. wait.
: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
opensearchpy/client/tasks.py
+1 -1
View File
@@ -73,7 +73,7 @@ class TasksClient(NamespacedClient):
: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 group_by: Key used to group tasks in the response. Valid :arg group_by: Key used to group tasks in the response. Valid
choices are nodes, parents, none. choices are nodes, none, parents.
:arg human: Whether to return human readable values for :arg human: Whether to return human readable values for
statistics. statistics.
:arg nodes: Comma-separated list of node IDs or names to limit :arg nodes: Comma-separated list of node IDs or names to limit
opensearchpy/plugins/knn.py
+3 -3
View File
@@ -180,7 +180,7 @@ class KnnClient(NamespacedClient):
errors. errors.
:arg expand_wildcards: Whether to expand wildcard expression to :arg expand_wildcards: Whether to expand wildcard expression to
concrete indices that are open, closed or both. Valid choices are all, concrete indices that are open, closed or both. Valid choices are all,
open, closed, hidden, none. closed, hidden, none, open.
:arg explain: Specify whether to return detailed information :arg explain: Specify whether to return detailed information
about score computation as part of a hit. 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
@@ -219,7 +219,7 @@ class KnnClient(NamespacedClient):
:arg scroll: Specify how long a consistent view of the index :arg scroll: Specify how long a consistent view of the index
should be maintained for scrolled search. should be maintained for scrolled search.
:arg search_type: Search operation type. Valid choices are :arg search_type: Search operation type. Valid choices are
query_then_fetch, dfs_query_then_fetch. dfs_query_then_fetch, query_then_fetch.
:arg seq_no_primary_term: Specify whether to return sequence :arg seq_no_primary_term: Specify whether to return sequence
number and primary term of the last modification of each hit. number and primary term of the last modification of each hit.
:arg size: Number of hits to return. Default is 10. :arg size: Number of hits to return. Default is 10.
@@ -232,7 +232,7 @@ class KnnClient(NamespacedClient):
return. return.
:arg suggest_field: Specify which field to use for suggestions. :arg suggest_field: Specify which field to use for suggestions.
:arg suggest_mode: Specify suggest mode. Valid choices are :arg suggest_mode: Specify suggest mode. Valid choices are
missing, popular, always. always, missing, popular.
:arg suggest_size: How many suggestions to return in response. :arg suggest_size: How many suggestions to return in response.
:arg suggest_text: The source text for which the suggestions :arg suggest_text: The source text for which the suggestions
should be returned. should be returned.
opensearchpy/plugins/notifications.py
+2 -2
View File
@@ -212,8 +212,8 @@ class NotificationsClient(NamespacedClient):
:arg config_type: Type of notification configuration. Valid :arg config_type: Type of notification configuration. Valid
choices are slack, chime, microsoft_teams, webhook, email, sns, choices are chime, email, email_group, microsoft_teams, ses_account,
ses_account, smtp_account, email_group. slack, smtp_account, sns, webhook.
: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