From 73fd52f21d41f709f67fcc98fdbf1e3cb1df8c2f Mon Sep 17 00:00:00 2001 From: dblock Date: Mon, 9 Oct 2023 21:57:53 +0000 Subject: [PATCH] deploy: ce835fb59d7333f74ff9f1a32f2d3a6eed36c515 --- _modules/opensearchpy/client/cluster.html | 367 +++++++++++++++------- api-ref/clients/cluster_client.html | 273 ++++++++++------ genindex.html | 18 +- objects.inv | Bin 3678 -> 3732 bytes searchindex.js | 2 +- 5 files changed, 450 insertions(+), 210 deletions(-) diff --git a/_modules/opensearchpy/client/cluster.html b/_modules/opensearchpy/client/cluster.html index 24bb6f2c..a2bbef37 100644 --- a/_modules/opensearchpy/client/cluster.html +++ b/_modules/opensearchpy/client/cluster.html @@ -108,16 +108,27 @@

Source code for opensearchpy.client.cluster

 #  under the License.
 
 
+# ----------------------------------------------------
+# THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.
+#
+# To contribute, kindly make essential modifications through either the "opensearch-py client generator":
+# https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py
+# or the "OpenSearch API specification" available at:
+# https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json
+# -----------------------------------------------------
+
+
 from .utils import SKIP_IN_PATH, NamespacedClient, _make_path, query_params
 
 
 
[docs]class ClusterClient(NamespacedClient):
[docs] @query_params( + "awareness_attribute", + "cluster_manager_timeout", "expand_wildcards", "level", "local", "master_timeout", - "cluster_manager_timeout", "timeout", "wait_for_active_shards", "wait_for_events", @@ -131,31 +142,35 @@

Source code for opensearchpy.client.cluster

         Returns basic information about the health of the cluster.
 
 
-        :arg index: Limit the information returned to a specific index
+        :arg index: Limit the information returned to specific indicies.
+        :arg awareness_attribute: The awareness attribute for which the
+            health is required.
+        :arg cluster_manager_timeout: Operation timeout for connection
+            to cluster-manager node.
         :arg expand_wildcards: Whether to expand wildcard expression to
-            concrete indices that are open, closed or both.  Valid choices: open,
-            closed, hidden, none, all  Default: all
-        :arg level: Specify the level of detail for returned information
-            Valid choices: cluster, indices, shards  Default: cluster
+            concrete indices that are open, closed or both.  Valid choices: all,
+            open, closed, hidden, none
+        :arg level: Specify the level of detail for returned
+            information.  Valid choices: cluster, indices, shards,
+            awareness_attributes
         :arg local: Return local information, do not retrieve the state
-            from cluster_manager node (default: false)
-        :arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
-            to master node
-        :arg cluster_manager_timeout: Explicit operation timeout for connection
-            to cluster_manager node
-        :arg timeout: Explicit operation timeout
+            from cluster-manager node. (default: false)
+        :arg master_timeout (Deprecated: To promote inclusive language,
+            use 'cluster_manager_timeout' instead): Operation timeout for connection
+            to master node.
+        :arg timeout: Operation timeout.
         :arg wait_for_active_shards: Wait until the specified number of
-            shards is active
+            shards is active.
         :arg wait_for_events: Wait until all currently queued events
-            with the given priority are processed  Valid choices: immediate, urgent,
-            high, normal, low, languid
+            with the given priority are processed.  Valid choices: immediate,
+            urgent, high, normal, low, languid
         :arg wait_for_no_initializing_shards: Whether to wait until
-            there are no initializing shards in the cluster
+            there are no initializing shards in the cluster.
         :arg wait_for_no_relocating_shards: Whether to wait until there
-            are no relocating shards in the cluster
+            are no relocating shards in the cluster.
         :arg wait_for_nodes: Wait until the specified number of nodes is
-            available
-        :arg wait_for_status: Wait until cluster is in a specific state
+            available.
+        :arg wait_for_status: Wait until cluster is in a specific state.
             Valid choices: green, yellow, red
         """
         return self.transport.perform_request(
@@ -165,17 +180,20 @@ 

Source code for opensearchpy.client.cluster

             headers=headers,
         )
-
[docs] @query_params("local", "master_timeout", "cluster_manager_timeout") +
[docs] @query_params("cluster_manager_timeout", "local", "master_timeout") def pending_tasks(self, params=None, headers=None): """ Returns a list of any cluster-level changes (e.g. create index, update mapping, allocate or fail shard) which have not yet been executed. + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. :arg local: Return local information, do not retrieve the state - from cluster_manager node (default: false) - :arg master_timeout (Deprecated: use cluster_manager_timeout): Specify timeout for connection to master - :arg cluster_manager_timeout: Specify timeout for connection to cluster_manager + from cluster-manager node. (default: false) + :arg master_timeout (Deprecated: To promote inclusive language, + use 'cluster_manager_timeout' instead): Operation timeout for connection + to master node. """ return self.transport.perform_request( "GET", "/_cluster/pending_tasks", params=params, headers=headers @@ -183,12 +201,12 @@

Source code for opensearchpy.client.cluster

 
 
[docs] @query_params( "allow_no_indices", + "cluster_manager_timeout", "expand_wildcards", "flat_settings", "ignore_unavailable", "local", "master_timeout", - "cluster_manager_timeout", "wait_for_metadata_version", "wait_for_timeout", ) @@ -198,28 +216,31 @@

Source code for opensearchpy.client.cluster

 
 
         :arg metric: Limit the information returned to the specified
-            metrics  Valid choices: _all, blocks, metadata, nodes, routing_table,
-            routing_nodes, master_node, version
-        :arg index: A comma-separated list of index names; use `_all` or
-            empty string to perform the operation on all indices
+            metrics.  Valid choices: _all, blocks, metadata, nodes, routing_table,
+            routing_nodes, master_node, cluster_manager_node, version
+        :arg index: Comma-separated list of indices; use `_all` or empty
+            string to perform the operation on all indices.
         :arg allow_no_indices: Whether to ignore if a wildcard indices
             expression resolves into no concrete indices. (This includes `_all`
-            string or when no indices have been specified)
+            string or when no indices have been specified).
+        :arg cluster_manager_timeout: Operation timeout for connection
+            to cluster-manager node.
         :arg expand_wildcards: Whether to expand wildcard expression to
-            concrete indices that are open, closed or both.  Valid choices: open,
-            closed, hidden, none, all  Default: open
-        :arg flat_settings: Return settings in flat format (default:
+            concrete indices that are open, closed or both.  Valid choices: all,
+            open, closed, hidden, none
+        :arg flat_settings: Return settings in flat format. (default:
             false)
         :arg ignore_unavailable: Whether specified concrete indices
-            should be ignored when unavailable (missing or closed)
+            should be ignored when unavailable (missing or closed).
         :arg local: Return local information, do not retrieve the state
-            from cluster_manager node (default: false)
-        :arg master_timeout (Deprecated: use cluster_manager_timeout): Specify timeout for connection to master
-        :arg cluster_manager_timeout: Specify timeout for connection to cluster_manager
+            from cluster-manager node. (default: false)
+        :arg master_timeout (Deprecated: To promote inclusive language,
+            use 'cluster_manager_timeout' instead): Operation timeout for connection
+            to master node.
         :arg wait_for_metadata_version: Wait for the metadata version to
-            be equal or greater than the specified metadata version
+            be equal or greater than the specified metadata version.
         :arg wait_for_timeout: The maximum time to wait for
-            wait_for_metadata_version before timing out
+            wait_for_metadata_version before timing out.
         """
         if index and metric in SKIP_IN_PATH:
             metric = "_all"
@@ -237,13 +258,13 @@ 

Source code for opensearchpy.client.cluster

         Returns high-level overview of cluster statistics.
 
 
-        :arg node_id: A comma-separated list of node IDs or names to
-            limit the returned information; use `_local` to return information from
-            the node you're connecting to, leave empty to get information from all
-            nodes
-        :arg flat_settings: Return settings in flat format (default:
+        :arg node_id: Comma-separated list of node IDs or names to limit
+            the returned information; use `_local` to return information from the
+            node you're connecting to, leave empty to get information from all
+            nodes.
+        :arg flat_settings: Return settings in flat format. (default:
             false)
-        :arg timeout: Explicit operation timeout
+        :arg timeout: Operation timeout.
         """
         return self.transport.perform_request(
             "GET",
@@ -255,10 +276,10 @@ 

Source code for opensearchpy.client.cluster

         )
[docs] @query_params( + "cluster_manager_timeout", "dry_run", "explain", "master_timeout", - "cluster_manager_timeout", "metric", "retry_failed", "timeout", @@ -270,30 +291,30 @@

Source code for opensearchpy.client.cluster

 
         :arg body: The definition of `commands` to perform (`move`,
             `cancel`, `allocate`)
+        :arg cluster_manager_timeout: Operation timeout for connection
+            to cluster-manager node.
         :arg dry_run: Simulate the operation only and return the
-            resulting state
+            resulting state.
         :arg explain: Return an explanation of why the commands can or
-            cannot be executed
-        :arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
-            to master node
-        :arg cluster_manager_timeout: Explicit operation timeout for connection
-            to cluster_manager node
+            cannot be executed.
+        :arg master_timeout (Deprecated: To promote inclusive language,
+            use 'cluster_manager_timeout' instead): Operation timeout for connection
+            to master node.
         :arg metric: Limit the information returned to the specified
-            metrics. Defaults to all but metadata  Valid choices: _all, blocks,
-            metadata, nodes, routing_table, master_node, version
+            metrics. Defaults to all but metadata.
         :arg retry_failed: Retries allocation of shards that are blocked
-            due to too many subsequent allocation failures
-        :arg timeout: Explicit operation timeout
+            due to too many subsequent allocation failures.
+        :arg timeout: Operation timeout.
         """
         return self.transport.perform_request(
             "POST", "/_cluster/reroute", params=params, headers=headers, body=body
         )
[docs] @query_params( + "cluster_manager_timeout", "flat_settings", "include_defaults", "master_timeout", - "cluster_manager_timeout", "timeout", ) def get_settings(self, params=None, headers=None): @@ -301,22 +322,23 @@

Source code for opensearchpy.client.cluster

         Returns cluster settings.
 
 
-        :arg flat_settings: Return settings in flat format (default:
+        :arg cluster_manager_timeout: Operation timeout for connection
+            to cluster-manager node.
+        :arg flat_settings: Return settings in flat format. (default:
             false)
         :arg include_defaults: Whether to return all default clusters
-            setting.
-        :arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
-            to master node
-        :arg cluster_manager_timeout: Explicit operation timeout for connection
-            to cluster_manager node
-        :arg timeout: Explicit operation timeout
+            setting. (default: false)
+        :arg master_timeout (Deprecated: To promote inclusive language,
+            use 'cluster_manager_timeout' instead): Operation timeout for connection
+            to master node.
+        :arg timeout: Operation timeout.
         """
         return self.transport.perform_request(
             "GET", "/_cluster/settings", params=params, headers=headers
         )
[docs] @query_params( - "flat_settings", "master_timeout", "cluster_manager_timeout", "timeout" + "cluster_manager_timeout", "flat_settings", "master_timeout", "timeout" ) def put_settings(self, body, params=None, headers=None): """ @@ -325,13 +347,14 @@

Source code for opensearchpy.client.cluster

 
         :arg body: The settings to be updated. Can be either `transient`
             or `persistent` (survives cluster restart).
-        :arg flat_settings: Return settings in flat format (default:
+        :arg cluster_manager_timeout: Operation timeout for connection
+            to cluster-manager node.
+        :arg flat_settings: Return settings in flat format. (default:
             false)
-        :arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection
-            to master node
-        :arg cluster_manager_timeout: Explicit operation timeout for connection
-            to cluster_manager node
-        :arg timeout: Explicit operation timeout
+        :arg master_timeout (Deprecated: To promote inclusive language,
+            use 'cluster_manager_timeout' instead): Operation timeout for connection
+            to master node.
+        :arg timeout: Operation timeout.
         """
         if body in SKIP_IN_PATH:
             raise ValueError("Empty value passed for a required argument 'body'.")
@@ -359,9 +382,9 @@ 

Source code for opensearchpy.client.cluster

         :arg body: The index, shard, and primary flag to explain. Empty
             means 'explain the first unassigned shard'
         :arg include_disk_info: Return information about disk usage and
-            shard sizes (default: false)
+            shard sizes. (default: false)
         :arg include_yes_decisions: Return 'YES' decisions in
-            explanation (default: false)
+            explanation. (default: false)
         """
         return self.transport.perform_request(
             "POST",
@@ -371,16 +394,19 @@ 

Source code for opensearchpy.client.cluster

             body=body,
         )
-
[docs] @query_params("master_timeout", "cluster_manager_timeout", "timeout") +
[docs] @query_params("cluster_manager_timeout", "master_timeout", "timeout") def delete_component_template(self, name, params=None, headers=None): """ - Deletes a component template + Deletes a component template. - :arg name: The name of the template - :arg master_timeout (Deprecated: use cluster_manager_timeout): Specify timeout for connection to master - :arg cluster_manager_timeout: Specify timeout for connection to cluster_manager - :arg timeout: Explicit operation timeout + :arg name: The name of the template. + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. + :arg master_timeout (Deprecated: To promote inclusive language, + use 'cluster_manager_timeout' instead): Operation timeout for connection + to master node. + :arg timeout: Operation timeout. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'name'.") @@ -392,19 +418,20 @@

Source code for opensearchpy.client.cluster

             headers=headers,
         )
-
[docs] @query_params("local", "master_timeout", "cluster_manager_timeout") +
[docs] @query_params("cluster_manager_timeout", "local", "master_timeout") def get_component_template(self, name=None, params=None, headers=None): """ - Returns one or more component templates + Returns one or more component templates. - :arg name: The comma separated names of the component templates + :arg name: The Comma-separated names of the component templates. + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. :arg local: Return local information, do not retrieve the state - from cluster_manager node (default: false) - :arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection - to master node - :arg cluster_manager_timeout: Explicit operation timeout for connection - to cluster_manager node + from cluster-manager node. (default: false) + :arg master_timeout (Deprecated: To promote inclusive language, + use 'cluster_manager_timeout' instead): Operation timeout for connection + to master node. """ return self.transport.perform_request( "GET", @@ -413,19 +440,22 @@

Source code for opensearchpy.client.cluster

             headers=headers,
         )
-
[docs] @query_params("create", "master_timeout", "cluster_manager_timeout", "timeout") +
[docs] @query_params("cluster_manager_timeout", "create", "master_timeout", "timeout") def put_component_template(self, name, body, params=None, headers=None): """ - Creates or updates a component template + Creates or updates a component template. - :arg name: The name of the template + :arg name: The name of the template. :arg body: The template definition + :arg cluster_manager_timeout: Operation timeout for connection + to cluster-manager node. :arg create: Whether the index template should only be added if - new or can also replace an existing one - :arg master_timeout (Deprecated: use cluster_manager_timeout): Specify timeout for connection to master - :arg cluster_manager_timeout: Specify timeout for connection to cluster_manager - :arg timeout: Explicit operation timeout + new or can also replace an existing one. (default: false) + :arg master_timeout (Deprecated: To promote inclusive language, + use 'cluster_manager_timeout' instead): Operation timeout for connection + to master node. + :arg timeout: Operation timeout. """ for param in (name, body): if param in SKIP_IN_PATH: @@ -439,19 +469,18 @@

Source code for opensearchpy.client.cluster

             body=body,
         )
-
[docs] @query_params("local", "master_timeout", "cluster_manager_timeout") +
[docs] @query_params("local", "master_timeout") def exists_component_template(self, name, params=None, headers=None): """ - Returns information about whether a particular component template exist + Returns information about whether a particular component template exist. - :arg name: The name of the template + :arg name: The name of the template. :arg local: Return local information, do not retrieve the state - from cluster_manager node (default: false) - :arg master_timeout (Deprecated: use cluster_manager_timeout): Explicit operation timeout for connection - to master node - :arg cluster_manager_timeout: Explicit operation timeout for connection - to cluster_manager node + from cluster-manager node. (default: false) + :arg master_timeout (Deprecated: To promote inclusive language, + use 'cluster_manager_timeout' instead): Operation timeout for connection + to master node. """ if name in SKIP_IN_PATH: raise ValueError("Empty value passed for a required argument 'name'.") @@ -471,7 +500,7 @@

Source code for opensearchpy.client.cluster

 
         :arg wait_for_removal: Specifies whether to wait for all
             excluded nodes to be removed from the cluster before clearing the voting
-            configuration exclusions list.  Default: True
+            configuration exclusions list. (default: True)
         """
         return self.transport.perform_request(
             "DELETE",
@@ -486,16 +515,138 @@ 

Source code for opensearchpy.client.cluster

         Updates the cluster voting config exclusions by node ids or node names.
 
 
-        :arg node_ids: A comma-separated list of the persistent ids of
-            the nodes to exclude from the voting configuration. If specified, you
-            may not also specify ?node_names.
-        :arg node_names: A comma-separated list of the names of the
+        :arg node_ids: Comma-separated list of the persistent ids of the
             nodes to exclude from the voting configuration. If specified, you may
-            not also specify ?node_ids.
-        :arg timeout: Explicit operation timeout  Default: 30s
+            not also specify ?node_names.
+        :arg node_names: Comma-separated list of the names of the nodes
+            to exclude from the voting configuration. If specified, you may not also
+            specify ?node_ids.
+        :arg timeout: Operation timeout.
         """
         return self.transport.perform_request(
             "POST", "/_cluster/voting_config_exclusions", params=params, headers=headers
+        )
+ +
[docs] @query_params() + def delete_decommission_awareness(self, params=None, headers=None): + """ + Delete any existing decommission. + + """ + return self.transport.perform_request( + "DELETE", + "/_cluster/decommission/awareness/", + params=params, + headers=headers, + )
+ +
[docs] @query_params() + def delete_weighted_routing(self, params=None, headers=None): + """ + Delete weighted shard routing weights. + + """ + return self.transport.perform_request( + "DELETE", + "/_cluster/routing/awareness/weights", + params=params, + headers=headers, + )
+ +
[docs] @query_params() + def get_decommission_awareness( + self, awareness_attribute_name, params=None, headers=None + ): + """ + Get details and status of decommissioned attribute. + + + :arg awareness_attribute_name: Awareness attribute name. + """ + if awareness_attribute_name in SKIP_IN_PATH: + raise ValueError( + "Empty value passed for a required argument 'awareness_attribute_name'." + ) + + return self.transport.perform_request( + "GET", + _make_path( + "_cluster", + "decommission", + "awareness", + awareness_attribute_name, + "_status", + ), + params=params, + headers=headers, + )
+ +
[docs] @query_params() + def get_weighted_routing(self, attribute, params=None, headers=None): + """ + Fetches weighted shard routing weights. + + + :arg attribute: Awareness attribute name. + """ + if attribute in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'attribute'.") + + return self.transport.perform_request( + "GET", + _make_path("_cluster", "routing", "awareness", attribute, "weights"), + params=params, + headers=headers, + )
+ +
[docs] @query_params() + def put_decommission_awareness( + self, + awareness_attribute_name, + awareness_attribute_value, + params=None, + headers=None, + ): + """ + Decommissions an awareness attribute. + + + :arg awareness_attribute_name: Awareness attribute name. + :arg awareness_attribute_value: Awareness attribute value. + """ + for param in (awareness_attribute_name, awareness_attribute_value): + if param in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument.") + + return self.transport.perform_request( + "PUT", + _make_path( + "_cluster", + "decommission", + "awareness", + awareness_attribute_name, + awareness_attribute_value, + ), + params=params, + headers=headers, + )
+ +
[docs] @query_params() + def put_weighted_routing(self, attribute, params=None, headers=None): + """ + Updates weighted shard routing weights. + + + :arg attribute: Awareness attribute name. + """ + if attribute in SKIP_IN_PATH: + raise ValueError("Empty value passed for a required argument 'attribute'.") + + return self.transport.perform_request( + "PUT", + _make_path("_cluster", "routing", "awareness", attribute, "weights"), + params=params, + headers=headers, )
diff --git a/api-ref/clients/cluster_client.html b/api-ref/clients/cluster_client.html index a61cc26c..2bf3b22a 100644 --- a/api-ref/clients/cluster_client.html +++ b/api-ref/clients/cluster_client.html @@ -127,9 +127,9 @@

Cluster Client
delete_component_template(name, params=None, headers=None)[source]
-

Deletes a component template

+

Deletes a component template.

Parameters:
    -
  • name – The name of the template

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Specify timeout for connection to master

  • -
  • cluster_manager_timeout – Specify timeout for connection to cluster_manager

  • -
  • timeout – Explicit operation timeout

  • +
  • name – The name of the template.

  • +
  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

  • +
  • timeout – Operation timeout.

+
+
+delete_decommission_awareness(params=None, headers=None)[source]
+

Delete any existing decommission.

+
+
delete_voting_config_exclusions(params=None, headers=None)[source]
@@ -159,25 +168,30 @@

Cluster ClientParameters:

wait_for_removal – Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting -configuration exclusions list. Default: True

+configuration exclusions list. (default: True)

+
+
+delete_weighted_routing(params=None, headers=None)[source]
+

Delete weighted shard routing weights.

+
+
exists_component_template(name, params=None, headers=None)[source]
-

Returns information about whether a particular component template exist

+

Returns information about whether a particular component template exist.

Parameters:
    -
  • name – The name of the template

  • +
  • name – The name of the template.

  • local – Return local information, do not retrieve the state -from cluster_manager node (default: false)

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection -to master node

  • -
  • cluster_manager_timeout – Explicit operation timeout for connection -to cluster_manager node

  • +from cluster-manager node. (default: false)

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

@@ -186,22 +200,34 @@

Cluster Client
get_component_template(name=None, params=None, headers=None)[source]
-

Returns one or more component templates

+

Returns one or more component templates.

Parameters:
    -
  • name – The comma separated names of the component templates

  • +
  • name – The Comma-separated names of the component templates.

  • +
  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • local – Return local information, do not retrieve the state -from cluster_manager node (default: false)

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection -to master node

  • -
  • cluster_manager_timeout – Explicit operation timeout for connection -to cluster_manager node

  • +from cluster-manager node. (default: false)

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

+
+
+get_decommission_awareness(awareness_attribute_name, params=None, headers=None)[source]
+

Get details and status of decommissioned attribute.

+
+
Parameters:
+

awareness_attribute_name – Awareness attribute name.

+
+
+
+
get_settings(params=None, headers=None)[source]
@@ -209,20 +235,32 @@

Cluster Client
Parameters:
    -
  • flat_settings – Return settings in flat format (default: +

  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • +
  • flat_settings – Return settings in flat format. (default: false)

  • include_defaults – Whether to return all default clusters -setting.

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection -to master node

  • -
  • cluster_manager_timeout – Explicit operation timeout for connection -to cluster_manager node

  • -
  • timeout – Explicit operation timeout

  • +setting. (default: false)

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

  • +
  • timeout – Operation timeout.

+
+
+get_weighted_routing(attribute, params=None, headers=None)[source]
+

Fetches weighted shard routing weights.

+
+
Parameters:
+

attribute – Awareness attribute name.

+
+
+
+
health(index=None, params=None, headers=None)[source]
@@ -230,31 +268,35 @@

Cluster Client
Parameters:
    -
  • index – Limit the information returned to a specific index

  • +
  • index – Limit the information returned to specific indicies.

  • +
  • awareness_attribute – The awareness attribute for which the +health is required.

  • +
  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • expand_wildcards – Whether to expand wildcard expression to -concrete indices that are open, closed or both. Valid choices: open, -closed, hidden, none, all Default: all

  • -
  • level – Specify the level of detail for returned information -Valid choices: cluster, indices, shards Default: cluster

  • +concrete indices that are open, closed or both. Valid choices: all, +open, closed, hidden, none

    +
  • level – Specify the level of detail for returned +information. Valid choices: cluster, indices, shards, +awareness_attributes

  • local – Return local information, do not retrieve the state -from cluster_manager node (default: false)

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection -to master node

  • -
  • cluster_manager_timeout – Explicit operation timeout for connection -to cluster_manager node

  • -
  • timeout – Explicit operation timeout

  • +from cluster-manager node. (default: false)

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

  • +
  • timeout – Operation timeout.

  • wait_for_active_shards – Wait until the specified number of -shards is active

  • +shards is active.

  • wait_for_events – Wait until all currently queued events -with the given priority are processed Valid choices: immediate, urgent, -high, normal, low, languid

  • +with the given priority are processed. Valid choices: immediate, +urgent, high, normal, low, languid

  • wait_for_no_initializing_shards – Whether to wait until -there are no initializing shards in the cluster

  • +there are no initializing shards in the cluster.

  • wait_for_no_relocating_shards – Whether to wait until there -are no relocating shards in the cluster

  • +are no relocating shards in the cluster.

  • wait_for_nodes – Wait until the specified number of nodes is -available

  • -
  • wait_for_status – Wait until cluster is in a specific state +available.

  • +
  • wait_for_status – Wait until cluster is in a specific state. Valid choices: green, yellow, red

@@ -269,10 +311,13 @@

Cluster Client
Parameters:
    +
  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • local – Return local information, do not retrieve the state -from cluster_manager node (default: false)

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Specify timeout for connection to master

  • -
  • cluster_manager_timeout – Specify timeout for connection to cluster_manager

  • +from cluster-manager node. (default: false)

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

@@ -285,13 +330,13 @@

Cluster Client
Parameters:
    -
  • node_ids – A comma-separated list of the persistent ids of -the nodes to exclude from the voting configuration. If specified, you -may not also specify ?node_names.

  • -
  • node_names – A comma-separated list of the names of the +

  • node_ids – Comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may -not also specify ?node_ids.

  • -
  • timeout – Explicit operation timeout Default: 30s

  • +not also specify ?node_names.

    +
  • node_names – Comma-separated list of the names of the nodes +to exclude from the voting configuration. If specified, you may not also +specify ?node_ids.

  • +
  • timeout – Operation timeout.

@@ -300,17 +345,34 @@

Cluster Client
put_component_template(name, body, params=None, headers=None)[source]
-

Creates or updates a component template

+

Creates or updates a component template.

Parameters:
    -
  • name – The name of the template

  • +
  • name – The name of the template.

  • body – The template definition

  • +
  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • create – Whether the index template should only be added if -new or can also replace an existing one

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Specify timeout for connection to master

  • -
  • cluster_manager_timeout – Specify timeout for connection to cluster_manager

  • -
  • timeout – Explicit operation timeout

  • +new or can also replace an existing one. (default: false)

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

  • +
  • timeout – Operation timeout.

  • +
+
+
+
+ +
+
+put_decommission_awareness(awareness_attribute_name, awareness_attribute_value, params=None, headers=None)[source]
+

Decommissions an awareness attribute.

+
+
Parameters:
+
    +
  • awareness_attribute_name – Awareness attribute name.

  • +
  • awareness_attribute_value – Awareness attribute value.

@@ -325,18 +387,30 @@

Cluster Client
  • body – The settings to be updated. Can be either transient or persistent (survives cluster restart).

  • -
  • flat_settings – Return settings in flat format (default: +

  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • +
  • flat_settings – Return settings in flat format. (default: false)

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection -to master node

  • -
  • cluster_manager_timeout – Explicit operation timeout for connection -to cluster_manager node

  • -
  • timeout – Explicit operation timeout

  • +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

  • +
  • timeout – Operation timeout.

+
+
+put_weighted_routing(attribute, params=None, headers=None)[source]
+

Updates weighted shard routing weights.

+
+
Parameters:
+

attribute – Awareness attribute name.

+
+
+
+
remote_info(params=None, headers=None)[source]
@@ -352,20 +426,20 @@

Cluster Client
  • body – The definition of commands to perform (move, cancel, allocate)

  • +
  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • dry_run – Simulate the operation only and return the -resulting state

  • +resulting state.

  • explain – Return an explanation of why the commands can or -cannot be executed

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Explicit operation timeout for connection -to master node

  • -
  • cluster_manager_timeout – Explicit operation timeout for connection -to cluster_manager node

  • +cannot be executed.

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

  • metric – Limit the information returned to the specified -metrics. Defaults to all but metadata Valid choices: _all, blocks, -metadata, nodes, routing_table, master_node, version

  • +metrics. Defaults to all but metadata.

  • retry_failed – Retries allocation of shards that are blocked -due to too many subsequent allocation failures

  • -
  • timeout – Explicit operation timeout

  • +due to too many subsequent allocation failures.

    +
  • timeout – Operation timeout.

@@ -379,28 +453,31 @@

Cluster ClientParameters:
  • metric – Limit the information returned to the specified -metrics Valid choices: _all, blocks, metadata, nodes, routing_table, -routing_nodes, master_node, version

  • -
  • index – A comma-separated list of index names; use _all or -empty string to perform the operation on all indices

  • +metrics. Valid choices: _all, blocks, metadata, nodes, routing_table, +routing_nodes, master_node, cluster_manager_node, version

    +
  • index – Comma-separated list of indices; use _all or empty +string to perform the operation on all indices.

  • allow_no_indices – Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all -string or when no indices have been specified)

  • +string or when no indices have been specified).

    +
  • cluster_manager_timeout – Operation timeout for connection +to cluster-manager node.

  • expand_wildcards – Whether to expand wildcard expression to -concrete indices that are open, closed or both. Valid choices: open, -closed, hidden, none, all Default: open

  • -
  • flat_settings – Return settings in flat format (default: +concrete indices that are open, closed or both. Valid choices: all, +open, closed, hidden, none

  • +
  • flat_settings – Return settings in flat format. (default: false)

  • ignore_unavailable – Whether specified concrete indices -should be ignored when unavailable (missing or closed)

  • +should be ignored when unavailable (missing or closed).

  • local – Return local information, do not retrieve the state -from cluster_manager node (default: false)

  • -
  • (Deprecated (master_timeout) – use cluster_manager_timeout): Specify timeout for connection to master

  • -
  • cluster_manager_timeout – Specify timeout for connection to cluster_manager

  • +from cluster-manager node. (default: false)

    +
  • (Deprecated (master_timeout) – To promote inclusive language, +use ‘cluster_manager_timeout’ instead): Operation timeout for connection +to master node.

  • wait_for_metadata_version – Wait for the metadata version to -be equal or greater than the specified metadata version

  • +be equal or greater than the specified metadata version.

  • wait_for_timeout – The maximum time to wait for -wait_for_metadata_version before timing out

  • +wait_for_metadata_version before timing out.

@@ -413,13 +490,13 @@

Cluster Client
Parameters:
    -
  • node_id – A comma-separated list of node IDs or names to -limit the returned information; use _local to return information from -the node you’re connecting to, leave empty to get information from all -nodes

  • -
  • flat_settings – Return settings in flat format (default: +

  • node_id – Comma-separated list of node IDs or names to limit +the returned information; use _local to return information from the +node you’re connecting to, leave empty to get information from all +nodes.

  • +
  • flat_settings – Return settings in flat format. (default: false)

  • -
  • timeout – Explicit operation timeout

  • +
  • timeout – Operation timeout.

diff --git a/genindex.html b/genindex.html index c965f1bc..9905a735 100644 --- a/genindex.html +++ b/genindex.html @@ -358,11 +358,13 @@

D

  • delete_component_template() (opensearchpy.client.cluster.ClusterClient method)
  • - - +
  • get_data_stream() (opensearchpy.client.indices.IndicesClient method) +
  • +
  • get_decommission_awareness() (opensearchpy.client.cluster.ClusterClient method)
  • get_destination() (opensearchpy.plugins.alerting.AlertingClient method)
  • @@ -574,6 +580,8 @@

    G

  • (opensearchpy.helpers.index.Index method)
  • +
  • get_weighted_routing() (opensearchpy.client.cluster.ClusterClient method) +
  • @@ -770,9 +778,11 @@

    P

  • (opensearchpy.helpers.index.Index method)
  • +
  • put_component_template() (opensearchpy.client.cluster.ClusterClient method) +
  • put_template() (opensearchpy.client.indices.IndicesClient method) +
  • +
  • put_weighted_routing() (opensearchpy.client.cluster.ClusterClient method)
  • diff --git a/objects.inv b/objects.inv index a74307a2a5bbb57c8d03b32e8c5a09199a6d9e7f..037e16af09e7f30fbfaa2818826a7248a9be8c23 100644 GIT binary patch delta 3588 zcmV+f4*T)m9F!f9iB@x@x)sOwd3@6 z^BVv8FX>G}rYu6y9|2Hzq}gFq@DG#{>Pu)~p}T?N_^b8uEYIQZc`hk66c1Q>WA=dU zgMcV(X$TMnh`}6=X&eIf1JDLF6rdW)ic_38t_61ivA~4EaJUMJ@^;Z~gyGhJzT_nY zWnd&muK}N)Le^0#z6gSRf>?Z*FU`KJjHwSn?(Z9_A?f(a$~I8eRkx2A!wTTX7E<8- z#{5{fRD414LB2at)lpb_fqs2@e0YKs0gV2Dv)RXvziJQkrpC<*X6-% z`N2r^S=hVNC3*jqm1b#!{JGB^ehJMiu=t;|f)b3wv$ZYf3aH3*9vn&`;4ls~ZxN40 zCaB>#YH}``h|n6PXa{*DY7Q`#>B1u6pAWg{Gton2yr}1VPYLHZRysu}J0m%M*^$i( zYJ)!j{E1ljlG9UjMmk!+@bDIY1Js1Z?hwSK7`?Q?Q$zGpBOs$yd&!Pd*iK~GYv=H1 zOa%;@ssj~_lRi;OHfl=vGdy%hLNl?b-hKIt+3?j7Do)Lgozw`}oWoi)PT}A5HHWl* zRb#5)<+(*o6`a|{YC|Y!UUK*ff_Jbfj8gpuY{cFTg+f3KJK~nWJ~vr^-ilW*hK%L# zCoH-sIuS-saccc=I@<$UvPke)`6(L|k%>)L#~?>)s=Bs}kQ6;N+Bj!|kJl2shb@Ku zywGpGRbL7K&MA79HPy?U^Pb^#Geaj-D9+i#Ev9_!?f?FUt^vUQ#d*7O%4#0vWFyxR zr4jEdc}4-Ox!0`q*4(Fmr%(PVKiW9Kx`~%>q6fiRLT4?>eEiXNarXYh{q6Tp-}1Z1 zhldY$-#$J**+~Jtq808oPMJwK>=quRYP(ew;~v0qS9Z`OgXKI6>ae zu<*kQ);N3)fMOi*j)`0>p)c`!^U{zXjd&?PKL2-Uix;Q-cZxB3{zrf}*eq$y3+z9l zfiDBNqYOQ!xml?j=dPA+f@@w&biA@V!0*(NX%bAFXztO?0W*;>fLV-LzGP)b6a&br zmY6saqyYLk`c?2@0(VS|Ir17bpn^1pf_0kAkE=}1+IRdq_8tPv_ff#Ojetc>iHa!Y zy9Tm&L;yFUA(ve}7Kt5$D^4iI*eU0Ly+q;1ZAe<&Rj7$U79(f!Y8(CgqFcg{7(k&Y zSvn-Q^pns89Dh^{Yt#Te484EzW_SI6hpx}?s`iGT^(1nadEoVe!|Z!O>XtOJnmHL{ zgXxx{S*mNqn0#XJ15ns#-Bv?uzY;EA6@_w76Ui-4){Z@ctN(zg+H+XulyuxSMYUda za9P+qpL^5A8;HJ1$x@~*$hqF*JgC&hWyqz^y;@{J4}WgG7GeCYngKb5ym`ftqHj_$ z)P(sq6+=pGTrnuDiD=TTt|%dtl&{tF-0*j^gMfEb+{OLy!CoT9OV;q!YkK_6_*6mE z#HT2FV}BMp*QO;|GYeOfaL-~eWM0J(K&Jut@CS^n(l4DTK(UXnBzhF_HCS{F`!b7A zB5EF5&d)(mM;1I&V!8bl7(mdzG9#2ouI6yIk=iiFdcoey(W#prOmizW#9s1_fhx9; z!(xn3BAb-OL2A>YF=%e2)-M`SWn+`pYA3q<`+qGoa&~A6SjLtjw173F(QDR@LKwXd zV_U8eL}8PPtL%fDy+PCvKvkp~wAR%KVe~d_lceBwkLF}X3L~{)`gLtZK^a@AMnXmQ zEXaoCU!ECRqNPMx;I?}xX=U7^sggRIR%R)}(cblVM+0kjClGQT3rIJuVukddw?q5&i}>t6^dikjHQIfm*^*4b^F zz@zF`dM!q=yVhHb-nwR!amcXX%*A6kgxD7Sve(`(96GGfTP9XP#)X#r=VG*%=lPOP zVMtntk<|vhN=o*ax6l#&N*P9v(7dALC4Z_?x6KocZCfY}<;a^o$iMaircU<5W_u#K zaLU2YT;j^YqNC8QOug3(??g;X)oAWV5H? zgPlHJvWBl_`~@!c|(svD`-2FVVFv`gOgDd5rcR`d|>c z@YFY!_z|WU*UpmHkuW@Ek06V*DSrsZBIy~BR+{PJPFR;*pRJ{~?k#YmUxH0sHYqSm zo3DrEL@u@Rw{(+9(LRl6b>#Ee0+odxG8 zdQnYuY*)3*%k?t0m`kpD8jg!_5Y=UpSHYZ?3yuiA+{fpf19TtJvgvy^ubniL2BVK`&;EFXE~<2boC9APJDN3{;hPw^g&T%7$~^ zsdMJv%~MP!{SuHS1lJOt91b!hn8S>v@&3k>&CHS%ot(nU-VYy4%;U)mnda>PR?`g@ zj@4{~bLVQdZUnX(j2aY)Tz^NqX9iv)WuYO8=xVl0&Gv>H;$|*n??3_Ny21X3?7lzL z@BA_1C)fFlsC6$pgmocZA_!I$75!67`i0Yb?hqb-+DOtA%Qw8*rn$FA)gH^mt{ds; zC#b_~ZCXay5Hd56l=Sz_?&V)&v!PCNMme>jPRy?9Z6;3zq40hqlkqFv# z8oogD8i_U37>{pVj(^|_Hm(TphwAv`{u z)H)0L5_^-(KM()zLYMp)&8dU`^%C^ZJY}Cx&6IAOGM>5!=w>E%L#rpwj@hKU&;B$s zY8V;Ytz}L_=nI;7V(}_P9M+bH_Cg~WW-2__KK${Z76fC^vVREN&N2${fI5tXJg6?_ zJP+)SlG<*j@Bq8n=+=O9((1R(SRo)@U9G@MZ)?DU(^&zU@JzKkrW%5TzhRq=(2J?v zYI6;>t18{5EGw`sc03R4u%atq1)OY3mVKXgM|7{I>4hs~TwVYnG16npuieDm8FV*|YLZ47&=7$VDTavLgq!5b%q z3OMk__aK*YzmBD%?|{B>&QQo{$OK`7PdcR8uTPH;PshVqx9qdCuidgI*H45_JDSdH z0DPm}`F~Wib?{B{^~3G^&mU68%U?=TNJ9UOx-9(-;)2xhPsxBiKX3S|Kk@d<$Mh@Q zK?<7!CYOsFXD)how$L%{vxFu3?VI$3t4*HLJ5skm3~oSErXmTe29_y@KY9AsyW4Mn z8^jXx9t1|c>)i^{VaEdSLmFmNi1o z9ct6@D4CtmHgQff-l_VSXeOFXjPtqZbbmNVX6Kkql#|IZRUec2xd9X6JeM@NGcj?R zXmi%kbn<1Qvqzf17dFduJW3{=(K*7{;Z+xY=?@aiFx$YH9g(Nw0Dllj96QM-9aFzL z?cKdkz4fW?spC8+G3i#Pr{mQt-Pw&NS0|mFarSEeay<}Z zj%Ik_q~q!)Wu-}KQl2OnJVPuw?crwpp{IQ&WryJ)d-kj4vO)Rc>a)6ZyzspCj5jT^ KB>5jNy4}PBY8ik4 delta 3527 zcmV;&4LI_Y9o`&}iB^-Gx)sOwdIVNcTyzdz`$qoV_9VZ$Jx#lAgcw|%#VO@|85A<}&KS-@6&k>3@6 zcQyX=U(%a|Oj(4YKLVicNVCJJ=sr+Ns4t;`h3*E5?drf~?^4?r8#RBSb`ggemVE-ye{K-#SbVp8#h`@M&(%Xa|bpg`6a z1!SvlGDLBg3|>fBrz;~1U|$Hq=K7O=xBL_*j%&ePKrAp}FdVLeyu4ks8)3LLpf7m| zK^Yi{(QCk`r;zoO@-KoQpCINR=1a3LD`WCQko)_FYDoHSWo1*8b=B=7#;^kTv4s?P z_n05+mhvwsK8U^(RXv5J7wFfg$A>3K5y0pVIGcU!_^Sr-K)QRH1b#?yj-=ejtU zEk79XF$;Tlx+EXIveGPVkU#gi$1kCo1?GQqR#1X*c(%6XTmj{o-UWwJ2s#*tnzyKn zMJA}}a@6DIfC5X2(Hl1Z>{Hnm112d-}SA zw0@Oys^I0hMNJi)*~e-_C}>`C_zHp#uqljE{S-Fh=!QZrz^5H?OW=@yn=Eg6*NY)z zIs6HWK8j9+*;AZauTE!sKuZ=09xFdZgTgbh>FXHeNKIAWmJyO-phlbLOz`nqg7>hc za99`mZLsPK0nl|6J&T&^WzKoe@Vb?u6Dkzv?BNzuz7F<(e?yl7uzz)3yK>2D9_3^s z*Aayg?<;vm0j#;#to7EDZ37E`g_m!91i@NDXD!Ly_@nLO?EQ!P+wY&g<#&${4^l=J?W~PJ2{sVj0Wv?Id3??Y;rH4QOF2>g~ydIKsAef?o3dYwq+N0n7+8X zGaS}|++pU$A9qd*>5kBPO!$>FcJYX7b8skLd!n=bIFka@!vO1_6V`EmfqYnD=?*Jc zS<;#g>_5DLF9W!v zs1eiLs??41P)oPKHLt}7UfCV!?&Oha5saT`9?{JKGoCPjS&Uh}WNAm_6UeF-m^c!o z0QxohRqz7$jL$jp8Z@9-f;5JLb(zeMD^1SYK7Jj04*~A>QNXy3fJIG-iYVo~2BLUG z05`lL7ehT3i5-K>Pbm4^DenM#iNcTDkhHk3P!og9XU^o+Hv9KQw}c@+fkIKTR3*3Y zlgF5f29OXg+f4e9=vJ&6D91x%joht2kc58auEEiB`(-d@ADhsHy>7&_9x1mHfeW;UG?y`s()5UhytL(e39XHD|>ppu|X${A68~w1c(Y966^(N*q+Itwb(CdQw-dJ|s zn<4`{OJ2th@RU7*EYhaX1&gF-Kw4?0+pTZisCu>o)f$ogM!#{DxP*2$OPd0?FHxT1 z=!G@m-d*)BFE`4}2ijgBe{=zGk-7>ryj*NV=;ibwgk9CH2nI1@s9|TpIf`CX6I0k# z?ecQHj4e`)tDc7AA{<0@ndDUnoaKTeLN7NTE5}vo;%dFfbx0Ujf#a11xFKYWv&=O^ zFQ|));VL${UN58%1mP-mMbL{GqcXVa%|RxTVrx01ECW@=`?hK}f5MYG=bb!fzHgpl zGU1niG=Ynj@WgbGA(n3%_t7c$L3)K}9D7LL_ygLCI< zwr&Qt8jKngiCjm!X9iv)WuYPV;%c@_&Gv>Hq75!&??Az8$msEq-4BQQ_a%(@$#woB za^K4iVO=1M2!d5bfBE>-l78Xzo_mDHpEi;-ML-R&wrTF|QMJeXU$>E-et|l?)~02I zsX&8)q=dh3b}#-nHXHIZXOvSb>cs4u!DjMQ5DM?rk?~H)D}2Ci_wA-2J%NP##NZmH zyWin7XOuB&mp9X}DzTDDgFV{wfhIcvZs7eZfdj6~4x)9?kF_eiXv z#&~?|b_8FraYukZRPX=q%d}b+76a`A_~l50BfUQ~Lbh9d@%_PC&wFpA)>+V(IGAMq zdH8o9y5z@be@-3zua}@z^OSu)HB-8I%6RG`pqrW44K1HIJ7$yaK8MrHC^a*-Tg#lL z&=)lR#Jnp-9jq-6?S)1n%v5-;efr};EeOV-Wf8c&WftH8b(jfxP+iP<9@rfvwcSkN z0d}*|tpVqx)xT_Dg#homT8E{)TNfLNBKF1%+#+w>`w=yp#z z7;^bnY$LI4(^J}fH%m;~Hyf&{z#7{Ls^)v!98{v=pK^!_F}zMlI`>Fx&gbK?y#=2V zLh4Fao|a%#9E{H#^&X17=qTU(HpbWhZ+si-e@zsI$TFMUh74cu#z`Rq4!rR_h^^eO zW2qPhpl_Tr6m~RZf-vQi4r%u5)8oU_@o?5H`|Rv%x9rLF6QR?4AZK2idZT?`q~?XI zH_6uzx9>lHNLg3@Qj$UthHvC$>2DAhq=tV=6!!c)_0@3V?U#?~SGa=|HU&&BH#g2) zfAsEbqhmT`2}|@Zz0nh{UX7F9k-7zZas!$&c^%*Vaps=Fa`P9lNzCkN z5R-I>grXy#N31Y`uOeHdGBSn^d-cvre-nHD1()gBJ1sRT7f~@x3fJK?(joGOjw}O~ zpzh$no}4<+pVXIH{^g!>BY$T5c{*-r*YVGHP@CXaJFQc>QTqye+7>(qyWEbNo{kgE z##l4uw0Ab0e3@MD<(WfGcKW2J<78qdnY(&4yU0t`K{B@?$8hm!!%iwbCA$4Le@4Xl z9-VYNN_0;CCe+17fOI@c%-+5x;EZ2zdih;4>!NF99({OI`7zNs%Nil)4z=lcl*}$@ zn>eQx?^J$FGz-lp#`#)wst%IbHD(j#WO7X9$7FtOz=Sx@B~9*3Oq?d#oHaC^e3|I% zktXnk%`zR2lF49njxY{*<%M5{e}lv_%{FjmXXNQP!B+x_;~?3jV;WbdgS+=>v_926 z4V>pBCd2CVbevobi|4Mt95biK!=!@ERqYwSJG=4Z>ZG$X&bsz52R`R$RELv}yPKqy zCaFnzqG0e0vEa0aoAHN%_L-DDhD!GASIcEe`Qqxcx^%qoy!MPY&9fx=1t0v8&nL6d B`mz83 diff --git a/searchindex.js b/searchindex.js index 6196fac9..dc9bd208 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["README", "api-ref", "api-ref/client", "api-ref/clients/cat_client", "api-ref/clients/cluster_client", "api-ref/clients/dangling_indices_client", "api-ref/clients/features_client", "api-ref/clients/indices_client", "api-ref/clients/ingest_client", "api-ref/clients/nodes_client", "api-ref/clients/opensearch_client", "api-ref/clients/remote_client", "api-ref/clients/security_client", "api-ref/clients/snapshot_client", "api-ref/clients/tasks_client", "api-ref/connection", "api-ref/connection_pool", "api-ref/exceptions", "api-ref/helpers", "api-ref/helpers/aggs", "api-ref/helpers/analysis", "api-ref/helpers/document", "api-ref/helpers/faceted_search", "api-ref/helpers/field", "api-ref/helpers/function", "api-ref/helpers/index", "api-ref/helpers/mapping", "api-ref/helpers/query", "api-ref/helpers/search", "api-ref/helpers/update_by_query", "api-ref/helpers/wrappers", "api-ref/plugins", "api-ref/plugins/alerting_plugin", "api-ref/plugins/index_management_plugin", "api-ref/serializer", "api-ref/transport", "genindex", "index"], "filenames": ["README.md", "api-ref.md", "api-ref/client.md", "api-ref/clients/cat_client.md", "api-ref/clients/cluster_client.md", "api-ref/clients/dangling_indices_client.md", "api-ref/clients/features_client.md", "api-ref/clients/indices_client.md", "api-ref/clients/ingest_client.md", "api-ref/clients/nodes_client.md", "api-ref/clients/opensearch_client.md", "api-ref/clients/remote_client.md", "api-ref/clients/security_client.md", "api-ref/clients/snapshot_client.md", "api-ref/clients/tasks_client.md", "api-ref/connection.md", "api-ref/connection_pool.md", "api-ref/exceptions.md", "api-ref/helpers.md", "api-ref/helpers/aggs.md", "api-ref/helpers/analysis.md", "api-ref/helpers/document.md", "api-ref/helpers/faceted_search.md", "api-ref/helpers/field.md", "api-ref/helpers/function.md", "api-ref/helpers/index.md", "api-ref/helpers/mapping.md", "api-ref/helpers/query.md", "api-ref/helpers/search.md", "api-ref/helpers/update_by_query.md", "api-ref/helpers/wrappers.md", "api-ref/plugins.md", "api-ref/plugins/alerting_plugin.md", "api-ref/plugins/index_management_plugin.md", "api-ref/serializer.md", "api-ref/transport.md", "genindex.md", "index.md"], "titles": ["Welcome!", "API Reference", "Clients", "Compact and aligned text (CAT) Client", "Cluster Client", "Dangling Indices Client", "Features Client", "Indices Client", "Ingest Client", "Nodes Client", "OpenSearch Client", "Remote Client", "Security Client", "Snapshot Client", "Tasks Client", "connection", "connection_pool", "exceptions", "helpers", "aggs", "analysis", "document", "faceted_search", "field", "function", "index", "mapping", "query", "search", "update_by_query", "wrappers", "Plugins", "Alerting Plugin", "Index Management Plugin", "serializer", "transport", "Index", "OpenSearch Python Client Documentation"], "terms": {"python": [0, 10, 15, 22], "client": [0, 1, 17, 32, 33], "api": [0, 3, 6, 7, 10, 14, 15, 21, 25, 28, 29, 35, 37], "doc": [0, 7, 9, 10, 21, 25, 28, 37], "py": [0, 15, 37], "i": [0, 3, 4, 6, 7, 10, 13, 15, 16, 17, 21, 22, 23, 25, 28, 33, 35, 37], "commun": [0, 37], "driven": [0, 37], "open": [0, 3, 4, 7, 10, 15, 25, 37], "sourc": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35, 37], "fork": [0, 37], "elasticsearch": [0, 37], "under": [0, 37], "apach": [0, 37], "v2": [0, 25, 37], "0": [0, 7, 10, 13, 25, 28, 35, 37], "For": [0, 15, 25, 28, 37], "more": [0, 3, 4, 7, 10, 15, 16, 25, 35, 37], "inform": [0, 3, 4, 7, 9, 10, 13, 14, 15, 16, 22, 25, 28, 35, 37], "see": [0, 10, 15, 25, 37], "org": [0, 21, 25, 37], "To": [0, 3, 5, 8, 35, 37], "get": [0, 3, 4, 6, 7, 9, 10, 13, 14, 15, 16, 21, 25, 33, 35, 37], "start": [0, 10, 37], "websit": [0, 37], "download": [0, 37], "document": [0, 1, 3, 7, 8, 9, 10, 18, 25, 28], "need": [0, 7, 10, 22, 37], "help": [0, 3, 37], "try": [0, 16, 32, 37], "forum": [0, 37], "principl": [0, 37], "contribut": [0, 37], "maintain": [0, 7, 10, 15, 37], "respons": [0, 3, 10, 15, 17, 22, 28, 29, 35, 37], "releas": [0, 7, 37], "manag": [0, 1, 3, 5, 7, 8, 15, 16, 31, 35, 37], "admin": [0, 37], "secur": [0, 1, 2, 9, 15, 37], "thi": [0, 3, 4, 6, 7, 10, 13, 14, 15, 16, 17, 21, 22, 25, 28, 29, 33, 35, 37], "ha": [0, 7, 10, 13, 14, 16, 22, 33, 37], "adopt": [0, 37], "amazon": [0, 37], "faq": [0, 37], "contact": [0, 37], "opensourc": [0, 37], "codeofconduct": [0, 37], "com": [0, 37], "ani": [0, 4, 7, 10, 15, 16, 21, 25, 28, 32, 33, 35, 37], "addit": [0, 10, 21, 25, 28, 29, 37], "question": [0, 37], "comment": [0, 37], "contributor": [0, 37], "notic": [0, 37], "detail": [0, 3, 4, 7, 10, 13, 14, 32, 37], "opensearch": [1, 9, 15, 17, 21, 25, 28, 29], "compact": [1, 2], "align": [1, 2], "text": [1, 2, 7, 10, 22, 25, 28], "cat": [1, 2, 10], "cluster": [1, 2, 3, 5, 7, 8, 9, 10, 16, 35], "dangl": [1, 2], "indic": [1, 2, 3, 4, 6, 9, 10, 13, 25, 35], "ingest": [1, 2, 9, 10], "node": [1, 2, 3, 4, 5, 6, 7, 8, 10, 13, 14, 15, 17, 25, 35], "remot": [1, 2, 4, 10], "snapshot": [1, 2, 3, 6, 9, 10], "task": [1, 2, 3, 7, 9, 10], "featur": [1, 2], "connect": [1, 3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 16, 17, 21, 25, 35], "connection_pool": [1, 35], "except": [1, 7, 15, 21, 25, 35], "helper": [1, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30], "agg": [1, 18, 28], "analysi": [1, 7, 18, 25], "faceted_search": [1, 18], "field": [1, 3, 6, 7, 9, 10, 18, 21, 22, 25, 28], "function": [1, 18, 35], "index": [1, 3, 4, 5, 7, 9, 10, 13, 18, 21, 22, 28, 29, 31, 37], "map": [1, 4, 7, 10, 18, 21, 25], "queri": [1, 7, 10, 18, 22, 25, 28, 29, 35], "search": [1, 7, 9, 10, 18, 21, 22, 25, 29, 32], "update_by_queri": [1, 10, 18], "wrapper": [1, 18, 28, 29], "plugin": [1, 3, 9], "alert": [1, 31], "serial": [1, 10, 17, 19, 21, 23, 24, 28, 29, 35], "transport": [1, 9, 10, 15, 16], "includ": [2, 3, 4, 6, 7, 10, 13, 21, 22, 25, 28, 29], "sever": [2, 3, 10], "class": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35], "opensearchpi": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35], "catclient": [3, 10], "base": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35], "namespacedcli": [3, 4, 5, 6, 7, 8, 9, 11, 13, 14, 32, 33], "alias": [3, 7, 10, 25], "name": [3, 4, 7, 9, 10, 13, 14, 22, 25, 28, 33], "none": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 21, 22, 25, 28, 32, 33, 35], "param": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 16, 19, 20, 24, 27, 28, 29, 32, 33, 35], "header": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 17, 32, 33, 35], "show": [3, 7, 9, 10, 13, 15, 32], "about": [3, 4, 7, 9, 10, 13, 14, 25], "current": [3, 4, 7, 15, 16, 28, 29, 33], "configur": [3, 4, 7, 15, 25, 32, 35], "filter": [3, 7, 10, 22, 25, 28, 29], "rout": [3, 7, 10], "info": [3, 9, 10, 13, 17], "paramet": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 21, 22, 23, 25, 28, 29, 32, 33, 35], "comma": [3, 4, 7, 8, 9, 10, 13, 14], "separ": [3, 4, 7, 8, 9, 10, 13, 14, 15], "list": [3, 4, 6, 7, 8, 9, 10, 13, 14, 16, 21, 35], "alia": [3, 7, 10, 15, 17, 21, 25, 35], "expand_wildcard": [3, 4, 7, 10], "whether": [3, 4, 7, 9, 10, 13, 15, 23, 25, 35], "expand": [3, 4, 7, 10], "wildcard": [3, 4, 7, 8, 9, 10, 13, 28], "express": [3, 4, 7, 10, 29], "concret": [3, 4, 7, 10], "ar": [3, 4, 7, 9, 10, 13, 15, 16, 21, 22, 25, 28, 32, 35], "close": [3, 4, 7, 10, 15, 16, 25, 35], "both": [3, 4, 7, 10, 21], "valid": [3, 4, 7, 9, 10, 14, 17, 21, 25], "choic": [3, 4, 7, 9, 10, 14, 15], "all": [3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17, 21, 22, 25, 28, 29, 32, 35], "hidden": [3, 4, 7, 10], "format": [3, 4, 7, 9, 10, 25], "A": [3, 4, 7, 10, 13, 16, 17], "short": 3, "version": [3, 4, 6, 7, 10, 15, 21, 25, 33], "accept": [3, 28, 29], "e": [3, 4, 13, 28], "g": [3, 4, 13, 28], "json": [3, 35], "yaml": 3, "h": 3, "column": 3, "displai": [3, 7, 8], "return": [3, 4, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17, 21, 22, 25, 26, 28, 29, 30, 32, 35], "default": [3, 4, 7, 9, 10, 13, 15, 17, 21, 25, 28, 29, 35], "fals": [3, 4, 7, 9, 10, 13, 15, 16, 21, 23, 28, 35], "local": [3, 4, 7, 10, 13], "do": [3, 4, 7, 10, 13, 21], "retriev": [3, 4, 7, 10, 13, 16, 21, 25, 35], "state": [3, 4, 6, 7, 10, 13, 28, 29, 33], "from": [3, 4, 7, 9, 10, 13, 14, 15, 16, 17, 21, 25, 28, 29, 33, 35], "": [3, 7, 16, 17, 21, 22, 25, 28, 32, 35], "sort": [3, 10, 22, 28], "v": 3, "verbos": [3, 7, 8, 13], "mode": [3, 8, 10, 28], "all_pit_seg": 3, "activ": [3, 4, 7, 10], "point": [3, 7, 10], "time": [3, 4, 10, 16, 21, 25, 28, 29, 35], "segment": [3, 7, 9, 25], "alloc": [3, 4], "node_id": [3, 4, 9, 14], "provid": [3, 4, 7, 9, 10, 15, 25, 28, 35], "how": [3, 10, 15, 21, 25, 28], "mani": [3, 4, 10, 21], "shard": [3, 4, 7, 9, 10, 25], "each": [3, 7, 8, 9, 10, 13, 16, 25, 28, 35], "data": [3, 7, 8, 10, 13, 17, 21, 28, 29, 35], "much": [3, 25], "disk": [3, 4, 7, 9, 10], "space": 3, "thei": [3, 10, 13, 21, 25], "us": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 17, 21, 22, 25, 28, 29, 35], "id": [3, 4, 7, 8, 9, 10, 14, 15, 21, 32], "limit": [3, 4, 7, 9, 10, 14, 28, 29], "byte": 3, "The": [3, 4, 5, 7, 8, 9, 10, 13, 16, 17, 21, 25, 28, 32, 33], "unit": 3, "which": [3, 4, 6, 7, 10, 13, 15, 16, 22, 25, 28, 35], "valu": [3, 7, 10, 13, 15, 21, 22, 23, 28], "b": 3, "k": 3, "kb": 3, "m": 3, "mb": 3, "gb": 3, "t": [3, 9, 10, 16, 17, 21, 25, 35], "tb": 3, "p": 3, "pb": 3, "cluster_manager_timeout": [3, 4, 5, 6, 7, 8, 10, 13], "oper": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 17, 21, 25, 33, 35], "timeout": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 17, 35], "deprec": [3, 4, 5, 6, 7, 8, 10, 13, 17], "master_timeout": [3, 4, 5, 6, 7, 8, 10, 13], "promot": [3, 5, 7, 8], "inclus": [3, 5, 8], "languag": [3, 5, 8, 10], "instead": [3, 5, 7, 8, 10, 21, 35], "master": [3, 4, 5, 6, 7, 8, 10, 13], "cluster_manag": [3, 4, 6, 7, 10, 13], "count": [3, 10, 16, 28, 35], "quick": 3, "access": [3, 10, 22], "entir": [3, 10, 28], "individu": [3, 4, 10, 35], "fielddata": [3, 7, 9], "heap": 3, "memori": [3, 7, 10], "being": [3, 17, 21], "everi": [3, 10, 25], "output": [3, 8], "health": [3, 4], "concis": 3, "represent": [3, 10], "d": [3, 22, 28, 29], "micro": 3, "nano": 3, "set": [3, 4, 5, 7, 9, 10, 14, 15, 17, 21, 25, 28, 35], "disabl": [3, 15, 21], "timestamp": [3, 7], "true": [3, 4, 5, 7, 9, 10, 13, 15, 16, 19, 20, 21, 22, 24, 25, 27, 28, 29, 35], "number": [3, 4, 7, 9, 10, 13, 15, 16, 25, 28, 35], "primari": [3, 4, 7, 10, 25], "replica": [3, 10, 25], "size": [3, 4, 10, 13, 15, 28], "statu": [3, 7, 13, 17, 35], "green": [3, 4, 7], "yellow": [3, 4, 7], "red": [3, 4, 7], "onli": [3, 4, 7, 9, 10, 13, 15, 16, 21, 25, 28, 29], "match": [3, 7, 10, 25, 28], "specifi": [3, 4, 5, 7, 9, 10, 14, 16, 21, 23, 25, 28, 35], "include_unloaded_seg": [3, 7], "If": [3, 4, 7, 10, 15, 16, 21, 25, 28, 32, 35], "stat": [3, 4, 7, 9, 10, 25], "load": [3, 7], "pri": 3, "nodeattr": 3, "custom": [3, 10, 15, 22, 25, 32, 35], "attribut": [3, 10, 35], "basic": [3, 4, 10, 13], "statist": [3, 4, 7, 9, 10, 25], "perform": [3, 4, 7, 10, 13, 25, 28, 29, 35], "full_id": 3, "full": [3, 10], "shorten": 3, "doe": [3, 25, 33], "caus": [3, 7, 17, 21], "act": 3, "pending_task": [3, 4], "pend": 3, "pit_seg": 3, "bodi": [3, 4, 7, 8, 9, 10, 13, 15, 22, 28, 29, 32, 33, 35], "one": [3, 4, 7, 9, 10, 13, 16, 21, 33, 35], "pit": 3, "instal": 3, "across": [3, 16], "recoveri": [3, 7, 9, 25], "go": [3, 7, 25], "complet": [3, 7, 9, 10, 13, 14, 25], "active_onli": [3, 7], "ongo": [3, 7], "repositori": [3, 13, 37], "regist": [3, 25], "segment_repl": 3, "latest": [3, 15, 21, 25], "replic": [3, 7], "event": [3, 4], "completed_onli": 3, "low": [3, 4, 7, 9, 10, 25], "level": [3, 4, 7, 9, 10, 25], "an": [3, 4, 7, 9, 10, 13, 14, 15, 17, 21, 22, 25, 28, 29, 32, 33, 35], "view": [3, 10], "specif": [3, 4, 7, 9, 10, 21, 25, 32], "ignore_unavail": [3, 4, 7, 10, 13], "should": [3, 4, 7, 9, 10, 13, 14, 16, 35], "ignor": [3, 4, 7, 10, 13, 21, 28, 35], "when": [3, 4, 6, 7, 10, 15, 16, 17, 21, 22, 25, 28, 29, 35], "unavail": [3, 4, 7, 10, 13], "miss": [3, 4, 7, 10, 21], "execut": [3, 4, 7, 8, 10, 22, 25, 28, 29, 32, 35], "action": [3, 7, 9, 10, 13, 14, 16, 29, 32, 33], "leav": [3, 4, 7, 9, 10, 14], "empti": [3, 4, 7, 9, 10, 14, 21], "_local": [3, 4, 9, 14], "you": [3, 4, 7, 9, 10, 14, 21, 22, 25, 28, 35], "re": [3, 4, 9, 14, 35], "parent_task_id": [3, 14], "parent": [3, 14], "task_numb": [3, 14], "1": [3, 10, 14, 15, 16, 25, 28, 35], "templat": [3, 4, 7, 10, 25], "exist": [3, 4, 7, 10, 21, 25, 35], "thread_pool": [3, 9], "thread_pool_pattern": 3, "wide": 3, "thread": [3, 9, 15], "pool": [3, 15, 16, 35], "per": [3, 7, 10, 21, 35], "By": [3, 10, 21], "queue": [3, 9], "reject": 3, "regular": [3, 7], "multipli": 3, "clustercli": [4, 10], "allocation_explain": 4, "explan": [4, 7], "flag": [4, 17, 28, 35], "explain": [4, 7, 10, 33], "mean": [4, 10, 13, 25], "first": 4, "unassign": 4, "include_disk_info": 4, "usag": [4, 7, 9, 17], "include_yes_decis": 4, "ye": 4, "decis": 4, "delete_component_templ": 4, "delet": [4, 5, 6, 7, 8, 10, 13, 16, 21, 25, 28, 32, 33], "compon": 4, "explicit": [4, 6, 7, 10, 13], "delete_voting_config_exclus": 4, "clear": [4, 7, 10, 25], "vote": 4, "config": [4, 17], "exclus": 4, "wait_for_remov": 4, "wait": [4, 7, 9, 10, 13, 14], "exclud": [4, 10, 28], "remov": [4, 6, 7, 10, 13, 16, 28, 33], "befor": [4, 7, 10, 13, 14, 15, 21, 25, 35], "exists_component_templ": 4, "particular": [4, 7, 10], "get_component_templ": 4, "get_set": [4, 7, 25], "flat_set": [4, 7, 9], "flat": [4, 7, 9], "include_default": [4, 7], "wait_for_active_shard": [4, 7, 10], "until": [4, 7, 10, 13, 14, 25], "wait_for_ev": 4, "queu": 4, "given": [4, 7, 10, 16, 25], "prioriti": 4, "process": [4, 7, 9, 10, 16, 21, 25, 35], "immedi": [4, 21], "urgent": 4, "high": 4, "normal": [4, 7], "languid": 4, "wait_for_no_initializing_shard": 4, "initi": [4, 16, 35], "wait_for_no_relocating_shard": 4, "reloc": 4, "wait_for_nod": 4, "avail": [4, 10, 13, 15, 16, 17], "wait_for_statu": 4, "chang": [4, 6, 7, 10, 21, 25, 33], "creat": [4, 6, 7, 8, 10, 13, 16, 21, 22, 25, 32, 33, 35], "updat": [4, 7, 8, 10, 21, 25, 28, 29, 32, 33], "fail": [4, 10, 16, 17, 21, 25, 33, 35], "have": [4, 7, 10, 16, 21, 25, 28], "yet": [4, 25], "been": [4, 7, 10, 16], "post_voting_config_exclus": 4, "persist": [4, 15, 21], "mai": [4, 6, 7, 10], "also": [4, 7, 10, 13, 15, 16, 25, 35], "node_nam": 4, "30": [4, 13], "put_component_templ": 4, "definit": [4, 7, 8, 10, 13, 25], "ad": [4, 7, 22, 28], "new": [4, 7, 10, 21, 25, 28, 29, 33, 35], "can": [4, 6, 7, 10, 14, 16, 21, 22, 23, 25, 28, 29], "replac": [4, 7, 28], "put_set": [4, 7, 25], "either": [4, 10, 15, 28], "transient": 4, "surviv": 4, "restart": 4, "remote_info": 4, "rerout": 4, "allow": [4, 7, 8, 10, 25, 35], "manual": 4, "command": 4, "move": 4, "cancel": [4, 14], "dry_run": [4, 7], "simul": [4, 7, 8], "result": [4, 10, 13, 21, 22, 28, 32], "why": [4, 10], "cannot": [4, 25], "metric": [4, 7, 9, 10], "metadata": [4, 7, 10, 21], "_all": [4, 7, 9, 10], "block": [4, 7, 9, 10, 25], "routing_t": 4, "master_nod": 4, "retry_fail": 4, "retri": [4, 10, 17, 21, 33, 35], "due": 4, "too": [4, 7], "subsequ": [4, 10], "failur": [4, 7, 10, 16, 25, 35], "comprehens": 4, "routing_nod": 4, "string": [4, 7, 10, 15, 17, 28], "allow_no_indic": [4, 7, 10], "resolv": [4, 7, 10, 35], "wait_for_metadata_vers": 4, "equal": [4, 10], "greater": 4, "than": [4, 10, 16], "wait_for_timeout": 4, "maximum": [4, 10, 13, 15, 35], "out": [4, 21], "overview": 4, "dangling_indic": 5, "danglingindicescli": 5, "delete_dangling_index": 5, "index_uuid": 5, "uuid": 5, "accept_data_loss": 5, "must": [5, 7, 10, 25, 28, 29], "order": [5, 7, 10, 21, 28], "import_dangling_index": 5, "import": [5, 10, 25], "list_dangling_indic": 5, "featurescli": 6, "get_featur": 6, "feature_st": 6, "reset_featur": 6, "reset": [6, 16, 35], "intern": [6, 7, 10, 28, 29], "usual": [6, 9], "system": [6, 7], "experiment": [6, 7, 10], "so": [6, 7, 10, 13, 21, 28, 29, 35], "break": [6, 7, 10], "futur": [6, 7, 10, 16], "indicescli": [7, 10], "add_block": 7, "add": [7, 15, 22, 25, 28, 33, 35], "read": [7, 13], "write": [7, 13], "read_onli": 7, "analyz": [7, 10, 13, 20, 25], "token": [7, 25], "breakdown": [7, 25], "defin": [7, 10, 25, 28, 29], "scope": 7, "clear_cach": [7, 25], "cach": [7, 10, 25, 28], "request": [7, 9, 10, 13, 14, 15, 16, 21, 22, 25, 28, 29, 35], "clone": [7, 13, 25, 28, 29], "target": [7, 25, 35], "accord": 7, "integ": [7, 10, 15], "option": [7, 10, 15, 16, 17, 21, 28, 29, 35], "create_data_stream": 7, "stream": 7, "data_streams_stat": 7, "happen": [7, 17, 25], "delete_alia": [7, 25], "support": [7, 8, 9, 10, 13, 22, 28, 35], "delete_data_stream": 7, "delete_index_templ": 7, "delete_templ": 7, "disk_usag": 7, "flush": [7, 9, 25], "run_expensive_task": 7, "exists_alia": [7, 25], "exists_index_templ": 7, "exists_templ": 7, "field_usage_stat": 7, "subset": 7, "forc": [7, 10, 16, 25], "even": [7, 10, 16], "necessarili": 7, "ie": [7, 10], "commit": 7, "transact": 7, "log": [7, 10, 15], "increment": [7, 10], "uncommit": 7, "present": [7, 22, 25], "consid": 7, "wait_if_ongo": 7, "anoth": [7, 10, 13, 21, 25], "alreadi": [7, 10, 21, 25, 33, 35], "skip": [7, 21], "iff": 7, "run": [7, 10, 13, 32], "flush_sync": 7, "sync": [7, 25], "forcemerg": [7, 25], "merg": [7, 9, 25], "after": [7, 10, 13, 16], "max_num_seg": 7, "dynam": 7, "only_expunge_delet": 7, "expung": 7, "freez": 7, "frozen": 7, "almost": 7, "overhead": [7, 10], "its": [7, 10, 15, 16, 21, 25, 35], "get_alia": [7, 25], "get_data_stream": 7, "get_field_map": [7, 25], "well": [7, 22, 35], "get_index_templ": 7, "get_map": [7, 25], "get_templ": 7, "get_upgrad": [7, 25], "progress": 7, "upgrad": [7, 25], "migrate_to_data_stream": 7, "migrat": [7, 28, 29], "promote_data_stream": 7, "ccr": 7, "put_alia": [7, 25], "put_index_templ": 7, "user": [7, 10, 15], "reason": 7, "put_map": [7, 25], "omit": [7, 21, 28, 29], "write_index_onli": 7, "appli": [7, 9, 10, 17, 28, 29], "preserve_exist": 7, "remain": 7, "unchang": [7, 21, 25, 35], "put_templ": 7, "multipl": [7, 10, 21, 25, 28, 29], "ones": [7, 28], "higher": 7, "later": [7, 25, 28, 29], "overrid": [7, 22, 25, 28, 29, 35], "lower": 7, "those": [7, 10, 13, 15, 21, 25], "refresh": [7, 9, 10, 21, 25], "reload_search_analyz": 7, "reload": [7, 9], "resourc": 7, "resolve_index": 7, "rollov": 7, "new_index": 7, "larg": [7, 10], "old": 7, "condit": 7, "met": 7, "actual": [7, 17, 28, 35], "newli": 7, "lucen": [7, 9, 10, 25], "shard_stor": [7, 25], "store": [7, 9, 10, 16, 25], "copi": [7, 10, 25, 28, 29], "status": 7, "shrink": [7, 25], "fewer": [7, 25], "copy_set": 7, "shrunken": 7, "simulate_index_templ": 7, "against": [7, 10], "dry": 7, "purpos": [7, 10], "we": [7, 10, 16, 28, 32, 35], "simulate_templ": 7, "split": 7, "query_cach": [7, 9], "request_cach": [7, 9, 10], "warmer": [7, 9], "suggest": [7, 9, 10, 28], "completion_field": [7, 9], "fielddata_field": [7, 9], "forbid_closed_indic": 7, "collect": [7, 10], "explicitli": [7, 10, 15, 16, 25, 35], "group": [7, 9, 14], "include_segment_file_s": [7, 9], "report": [7, 9, 25], "aggreg": [7, 9, 10, 22, 28], "file": [7, 9, 15], "type": [7, 9, 10, 22, 25, 28, 29], "unfreez": 7, "unfrozen": 7, "goe": 7, "through": [7, 14, 25], "becom": 7, "writeabl": 7, "again": 7, "update_alias": 7, "only_ancient_seg": 7, "ancient": 7, "older": 7, "major": 7, "wait_for_complet": [7, 10, 13, 14], "validate_queri": [7, 25], "potenti": [7, 10, 22, 25, 35], "expens": [7, 25], "without": [7, 10, 25, 28, 32, 35], "dsl": [7, 10, 19, 23, 24], "restrict": [7, 10], "all_shard": 7, "random": [7, 10, 13], "analyze_wildcard": [7, 10], "prefix": [7, 10, 15], "default_oper": [7, 10], "AND": [7, 10], "OR": [7, 10], "df": [7, 10], "where": [7, 10, 16, 17], "error": [7, 10, 17], "lenient": [7, 10], "numer": [7, 10], "q": [7, 10, 25], "syntax": [7, 10], "rewrit": [7, 10], "ingestcli": [8, 10], "delete_pipelin": 8, "pipelin": [8, 10], "get_pipelin": 8, "processor_grok": 8, "built": [8, 25], "pattern": [8, 13], "put_pipelin": 8, "exampl": [8, 10, 16, 25, 28, 29], "processor": 8, "nodescli": [9, 10], "hot_thread": 9, "hot": 9, "doc_typ": [9, 22, 28, 29], "sampl": 9, "cpu": 9, "ignore_idle_thread": 9, "don": [9, 10, 35], "known": 9, "idl": 9, "place": [9, 28, 29], "socket": 9, "select": [9, 16, 22, 28], "pull": 9, "interv": [9, 22], "second": [9, 10, 15, 16, 35], "stacktrac": 9, "10": [9, 10, 13, 15, 22], "3": [9, 15, 25, 28, 29, 35], "wish": [9, 21, 22], "o": 9, "jvm": 9, "http": [9, 10, 15, 17, 21, 25, 35], "reload_secure_set": 9, "object": [9, 10, 15, 16, 19, 22, 23, 24, 25, 26, 28, 29, 35], "contain": [9, 10, 15, 16, 23, 25, 28, 29, 35], "password": 9, "keystor": 9, "span": 9, "reinit": 9, "call": [9, 15, 16, 21, 25, 28, 29, 35], "stai": 9, "becaus": 9, "involv": [9, 10], "index_metr": 9, "breaker": 9, "f": [9, 29], "discoveri": 9, "indexing_pressur": 9, "isn": [9, 10, 35], "translog": 9, "rest": [9, 10, 21, 25], "rest_act": 9, "host": [10, 15, 16, 35], "transport_class": 10, "kwarg": [10, 15, 16, 21, 23, 25, 28, 29, 30, 35], "straightforward": 10, "endpoint": 10, "instanc": [10, 16, 21, 25, 28, 29, 35], "snapshotcli": [10, 13], "tasksclient": [10, 14], "respect": [10, 28, 29], "prefer": [10, 15], "wai": [10, 35], "method": [10, 15, 16, 22, 25, 28, 29, 35], "your": [10, 15, 22, 35], "own": [10, 16, 22], "connection_class": [10, 35], "localhost": [10, 15], "thriftconnect": 10, "want": [10, 28, 35], "turn": [10, 28], "snif": [10, 16, 35], "describ": 10, "automat": [10, 35], "inspect": 10, "opensearchnode1": 10, "opensearchnode2": 10, "sniff": [10, 35], "anyth": 10, "sniff_on_start": [10, 35], "respond": 10, "sniff_on_connection_fail": [10, 35], "60": [10, 16], "sniffer_timeout": [10, 35], "differ": [10, 21, 25, 28, 35], "dictionari": [10, 16, 21, 28, 29, 35], "directli": 10, "ssl": [10, 15, 17], "port": [10, 15], "443": 10, "url_prefix": [10, 15], "note": [10, 25, 28, 29], "int": 10, "othernod": 10, "use_ssl": [10, 15], "control": [10, 21, 28, 35], "deal": 10, "certif": [10, 15], "urllib3httpconnect": [10, 15, 35], "descript": [10, 22, 28], "other_host": 10, "make": [10, 21], "sure": 10, "verifi": [10, 13, 15], "verify_cert": [10, 15], "path": [10, 15], "ca": [10, 15], "cert": [10, 15], "ca_cert": [10, 15], "warn": [10, 15, 17], "messag": [10, 17, 32], "verif": [10, 15], "ssl_show_warn": [10, 15], "authent": 10, "pem": 10, "client_cert": [10, 15], "clientcert": 10, "kei": [10, 15, 25, 28, 35], "client_kei": [10, 15], "clientkei": 10, "altern": [10, 35], "rfc": 10, "1738": 10, "url": [10, 15, 35], "long": 10, "conflict": [10, 21], "other": [10, 15, 16, 25, 28], "secret": 10, "9200": [10, 15], "product": 10, "jsonseri": [10, 34, 35], "encod": 10, "outgo": 10, "howev": 10, "implement": [10, 15, 17], "setencod": 10, "def": [10, 22], "self": [10, 15, 16, 17, 21, 22, 26, 30], "obj": 10, "isinst": 10, "someth": 10, "customsomethingrepresent": 10, "singl": [10, 21, 25, 29], "pass": [10, 15, 16, 17, 21, 22, 25, 28, 35], "translat": 10, "subclass": [10, 16, 25, 35], "argument": [10, 21, 25, 28, 29, 35], "__repr__": [10, 15, 16, 21, 26, 30], "repr": [10, 15, 16, 21, 26, 30], "bulk": [10, 21], "pair": 10, "newlin": 10, "item": 10, "_sourc": [10, 28, 29], "overridden": [10, 28, 29, 35], "sub": 10, "_source_exclud": 10, "_source_includ": 10, "extract": [10, 35], "preprocess": 10, "incom": 10, "affect": 10, "visibl": [10, 21], "wait_for": 10, "noth": 10, "require_alia": 10, "unset": 10, "proceed": 10, "otherwis": [10, 21, 28], "non": [10, 17], "neg": 10, "less": 10, "total": [10, 13], "clear_scrol": 10, "scroll_id": 10, "context": 10, "scroll": 10, "wa": [10, 16, 17, 35], "via": [10, 16, 17], "ignore_throttl": 10, "throttl": 10, "min_scor": 10, "_score": 10, "terminate_aft": 10, "upon": [10, 16], "reach": 10, "termin": 10, "earli": [10, 13], "409": [10, 17], "same": [10, 13, 16, 21, 25, 28, 35], "concurr": [10, 13], "version_typ": 10, "extern": 10, "external_gt": 10, "create_pit": 10, "allow_partial_pit_cr": 10, "partial": [10, 21], "keep_al": 10, "keep": 10, "aliv": 10, "create_point_in_tim": 10, "live": [10, 16, 35], "if_primary_term": 10, "last": 10, "term": [10, 22, 25, 28, 29], "if_seq_no": 10, "sequenc": 10, "delete_all_pit": 10, "delete_by_queri": [10, 28], "what": [10, 13, 21], "hit": [10, 22, 28], "abort": [10, 13], "proce": 10, "offset": 10, "max_doc": 10, "effect": [10, 16, 21], "requests_per_second": 10, "consist": [10, 15], "scroll_siz": 10, "power": 10, "100": [10, 13, 28], "search_timeout": 10, "search_typ": 10, "query_then_fetch": 10, "dfs_query_then_fetch": 10, "pleas": 10, "slice": [10, 28], "divid": 10, "subtask": 10, "auto": 10, "direct": 10, "tag": 10, "1m": 10, "part": [10, 22, 35], "delete_by_query_rethrottl": 10, "task_id": [10, 14], "rethrottl": 10, "float": [10, 15], "delete_pit": 10, "delete_point_in_tim": 10, "delete_script": 10, "script": [10, 21, 28, 29], "realtim": 10, "stored_field": 10, "exists_sourc": 10, "doesn": [10, 16, 17, 21, 25], "field_cap": 10, "capabl": 10, "among": 10, "include_unmap": 10, "unmap": 10, "get_all_pit": 10, "get_script": 10, "get_script_context": 10, "get_script_languag": 10, "get_sourc": 10, "overwrit": [10, 13, 29], "op_typ": 10, "requir": [10, 23, 28], "destin": [10, 32], "list_all_point_in_tim": 10, "mget": [10, 21], "identifi": [10, 35], "msearch": 10, "ccs_minimize_roundtrip": 10, "network": [10, 17], "round": [10, 16], "trip": 10, "minim": 10, "cross": 10, "max_concurrent_search": 10, "multi": [10, 21, 23], "max_concurrent_shard_request": 10, "impact": 10, "5": [10, 16, 22, 25], "pre_filter_shard_s": 10, "threshold": 10, "enforc": 10, "pre": 10, "roundtrip": 10, "prefilt": 10, "exce": 10, "significantli": 10, "date": 10, "mandatori": 10, "bound": [10, 28], "disjoint": 10, "rest_total_hits_as_int": 10, "render": 10, "typed_kei": 10, "msearch_templ": 10, "mtermvector": 10, "termvector": 10, "here": [10, 25], "least": 10, "resid": 10, "field_statist": 10, "sum": 10, "frequenc": 10, "unless": [10, 35], "payload": 10, "posit": 10, "real": [10, 25], "oppos": 10, "term_statist": 10, "ping": 10, "put_script": 10, "compil": 10, "rank_ev": 10, "evalu": 10, "qualiti": 10, "rank": 10, "over": [10, 16, 21, 25, 28, 29, 35], "typic": 10, "rate": 10, "reindex": 10, "fetch": [10, 32], "prototyp": 10, "5m": 10, "reindex_rethrottl": 10, "render_search_templ": 10, "mustach": 10, "scripts_painless_execut": 10, "arbitrari": 10, "allow_partial_search_result": 10, "batched_reduce_s": 10, "reduc": [10, 25], "onc": 10, "coordin": 10, "protect": 10, "mechan": 10, "512": 10, "docvalue_field": 10, "docvalu": 10, "score": [10, 28], "comput": 10, "min_compatible_shard_nod": 10, "minimum": 10, "compat": 10, "success": [10, 15, 35], "seq_no_primary_term": 10, "modif": 10, "suggest_field": 10, "suggest_mod": 10, "popular": 10, "alwai": [10, 16], "suggest_s": 10, "suggest_text": 10, "track_scor": 10, "calcul": [10, 28], "track_total_hit": 10, "track": 10, "search_shard": 10, "would": [10, 16], "search_templ": 10, "profil": 10, "terms_enum": 10, "enum": 10, "discov": 10, "begin": 10, "It": [10, 15, 16, 35], "design": 10, "latenc": 10, "look": 10, "up": [10, 35], "scenario": 10, "beta": 10, "expect": 10, "max": 10, "suppli": [10, 15, 28, 29], "lang": [10, 28, 29], "painless": [10, 28], "retry_on_conflict": [10, 21], "occur": 10, "pick": 10, "made": [10, 15, 21], "update_by_query_rethrottl": 10, "remotecli": 11, "cleanup_repositori": 13, "stale": 13, "target_snapshot": 13, "create_repositori": 13, "creation": [13, 28, 29], "delete_repositori": 13, "unregist": 13, "snapshotmissingexcept": 13, "thrown": 13, "include_repositori": 13, "index_detail": 13, "found": [13, 21], "blob": 13, "get_repositori": 13, "repository_analyz": 13, "correct": 13, "blob_count": 13, "dure": [13, 16, 35], "test": 13, "summari": 13, "early_read_node_count": 13, "rare": [13, 35], "rare_action_prob": 13, "relev": 13, "2": [13, 16, 25, 28], "max_blob_s": 13, "1gb": 13, "100mb": 13, "10mb": 13, "max_total_data_s": 13, "1tb": 13, "100gb": 13, "probabl": 13, "take": [13, 15, 22, 29, 35], "02": 13, "rarely_abort_writ": 13, "read_node_count": 13, "seed": 13, "gener": [13, 28], "workload": 13, "restor": 13, "verify_repositori": 13, "group_bi": 14, "child": 14, "relationship": 14, "http_compress": 15, "opaque_id": 15, "hold": [15, 16, 25, 35], "main": [15, 35], "interfac": [15, 35], "perform_request": [15, 16, 35], "safe": 15, "hostnam": 15, "gzip": 15, "compress": 15, "send": [15, 21, 32], "x": 15, "opaqu": 15, "trace": 15, "__eq__": 15, "__hash__": 15, "hash": 15, "_raise_error": 15, "status_cod": [15, 17], "raw_data": 15, "content_typ": 15, "locat": [15, 16], "appropri": [15, 28], "rais": [15, 16, 17, 21, 35], "_raise_warn": 15, "warning_head": 15, "seen": 15, "iter": [15, 28], "static": 15, "default_ca_cert": 15, "bundl": 15, "standard": 15, "openssl": 15, "environ": [15, 35], "variabl": 15, "certifi": 15, "log_request_fail": 15, "full_url": 15, "durat": 15, "unsuccess": 15, "log_request_success": 15, "requestshttpconnect": 15, "http_auth": 15, "pool_maxs": 15, "librari": 15, "auth": 15, "tupl": [15, 16], "fall": [15, 16], "back": [15, 16], "improv": 15, "privat": 15, "session": 15, "ssl_version": 15, "ssl_assert_hostnam": 15, "ssl_assert_fingerprint": 15, "maxsiz": 15, "ssl_context": 15, "urllib3": 15, "protocol": 15, "readthedoc": 15, "io": 15, "en": 15, "html": 15, "instruct": 15, "sslv23": 15, "sslv2": 15, "sslv3": 15, "tlsv1": 15, "protocol_": 15, "constant": 15, "modul": 15, "exact": 15, "fingerprint": 15, "kept": 15, "4": [15, 25], "opt": [15, 16], "hostedtoolcach": 15, "7": 15, "17": 15, "x64": 15, "lib": 15, "python3": 15, "site": 15, "packag": [15, 17], "connectionpool": [16, 35], "dead_timeout": 16, "timeout_cutoff": 16, "selector_class": 16, "roundrobinselector": 16, "randomize_host": 16, "connectionselector": 16, "dead": [16, 35], "interact": 16, "drive": 16, "within": [16, 25], "along": [16, 35], "refer": [16, 37], "ask": 16, "get_connect": [16, 35], "connectionerror": [16, 17], "mark": [16, 35], "mark_dead": [16, 35], "put": 16, "n": [16, 17, 28], "row": 16, "exponenti": 16, "longer": 16, "formula": 16, "default_timeout": 16, "fail_count": 16, "resurrect": 16, "previous": [16, 35], "succe": 16, "retir": 16, "increas": 16, "consecut": [16, 28], "shuffl": 16, "arriv": 16, "avoid": 16, "dog": 16, "pile": 16, "tri": [16, 35], "elig": 16, "selector": 16, "choos": 16, "now": [16, 25], "mark_liv": 16, "healthi": 16, "counter": 16, "redeem": 16, "attempt": [16, 35], "simpl": 16, "In": [16, 21, 35], "init": [16, 21], "construct": [16, 22, 28, 29], "itself": 16, "host_info_callback": [16, 35], "zone": 16, "awar": 16, "robin": 16, "authenticationexcept": 17, "transporterror": 17, "repres": [17, 22], "401": 17, "code": [17, 35], "authorizationexcept": 17, "403": 17, "conflicterror": 17, "while": [17, 25, 28], "talk": [17, 35], "origin": 17, "underli": [17, 25, 28, 29, 35], "__str__": 17, "str": 17, "connectiontimeout": 17, "improperlyconfigur": 17, "inconsist": 17, "invalid": 17, "notfounderror": [17, 21], "404": 17, "opensearchdeprecationwarn": 17, "opensearchwarn": 17, "opensearchexcept": 17, "incorrect": 17, "requesterror": 17, "400": 17, "serializationerror": 17, "properli": [17, 25], "sslerror": 17, "encount": [17, 25], "ok": 17, "Or": 17, "case": [17, 35], "properti": 17, "dict": [17, 19, 23, 24, 28, 29, 35], "precipit": 17, "applic": [17, 35], "opensearchdslexcept": 17, "opensearchdsl": 17, "illegaloper": 17, "unknowndslobject": 17, "validationexcept": 17, "valueerror": 17, "_expand__to_dot": [19, 20, 24, 27], "dslbase": [19, 20, 23, 24, 27], "to_dict": [19, 21, 23, 24, 28, 29], "plain": [19, 23, 24], "analysisbas": 20, "meta": 21, "objectbas": 21, "model": 21, "like": [21, 29, 35], "associ": [21, 25], "keyword": [21, 25, 28, 29, 35], "classmethod": [21, 28, 29], "check": 21, "popul": 21, "raise_on_error": 21, "save": [21, 25], "skip_empti": 21, "return_doc_meta": 21, "overwritten": 21, "left": 21, "strip": 21, "include_meta": 21, "_index": 21, "_id": 21, "etc": [21, 28], "just": 21, "detect_noop": 21, "doc_as_upsert": 21, "script_id": 21, "scripted_upsert": 21, "upsert": 21, "mydocu": 21, "titl": [21, 22, 25, 28], "noop": 21, "detect": 21, "between": [21, 35], "phase": 21, "possibl": [21, 35], "might": [21, 35], "final": 21, "throw": 21, "plu": 21, "content": 21, "facetedsearch": 22, "abstract": 22, "facet": 22, "navig": 22, "care": 22, "compos": 22, "easi": 22, "consum": 22, "fashion": 22, "blogsearch": 22, "blog": [22, 25], "post": [22, 25, 35], "categori": [22, 28], "termsfacet": 22, "_type": 22, "weekly_post": 22, "datehistogramfacet": 22, "published_from": 22, "week": 22, "super": 22, "publish": [22, 25, 28, 29], "blog_search": 22, "web": 22, "framework": 22, "pagin": [22, 28], "20": 22, "hit_count": 22, "is_select": 22, "print": 22, "chosen": 22, "els": 22, "add_filt": 22, "filter_valu": 22, "build_search": 22, "post_filt": 22, "narrow": 22, "highlight": [22, 28], "modifi": [22, 28, 29], "arg": [23, 25, 30], "bool": [23, 28, 29], "arrai": [23, 28], "scorefunct": 24, "my_analyz": 25, "trigram": 25, "ngram": 25, "min_gram": 25, "max_gram": 25, "lowercas": 25, "share": 25, "number_of_shard": 25, "i2": 25, "decor": 25, "deseri": [25, 35], "boolean": 25, "relat": [25, 35], "them": [25, 28, 35], "lost": 25, "continu": 25, "background": 25, "previou": [25, 28], "monitor": [25, 32], "insight": 25, "some": [25, 28], "done": 25, "belong": [25, 32], "number_of_replica": 25, "earlier": 25, "recent": 25, "engin": 25, "factor": 25, "8": 25, "shrunk": 25, "15": 25, "prime": 25, "updatebyqueri": [25, 29], "criteria": 25, "__getitem__": 28, "equat": 28, "25": 28, "equival": 28, "extra": [28, 35], "from_": 28, "__iter__": 28, "_clone": [28, 29], "shallow": [28, 29], "most": [28, 29], "collaps": 28, "inner_hit": 28, "max_concurrent_group_search": 28, "thu": 28, "chain": 28, "deleg": 28, "ignore_cach": 28, "wrap": [28, 29], "from_dict": [28, 29], "raw": [28, 29], "fragment_s": 28, "50": 28, "produc": [28, 35], "twice": 28, "highlight_opt": 28, "global": 28, "response_class": [28, 29], "cl": [28, 29], "scan": 28, "script_field": 28, "times_two": 28, "times_thre": 28, "price": 28, "asc": 28, "avg": 28, "descend": 28, "ascend": 28, "obj1": 28, "sent": [28, 29], "interest": 28, "update_from_dict": [28, 29], "mostli": [28, 29], "ubq": 29, "ctx": 29, "rang": 30, "attrdict": 30, "alertingcli": 32, "acknowledge_alert": 32, "monitor_id": 32, "acknowledg": 32, "create_destin": 32, "slack": 32, "mail": 32, "webhook": 32, "create_monitor": 32, "input": 32, "trigger": [32, 35], "delete_destin": 32, "destination_id": 32, "delete_monitor": 32, "get_alert": 32, "get_destin": 32, "get_monitor": 32, "run_monitor": 32, "dryrun": 32, "search_monitor": 32, "update_destin": 32, "update_monitor": 32, "index_manag": 33, "indexmanagementcli": 33, "add_polici": 33, "polici": 33, "change_polici": 33, "delete_polici": 33, "policy_id": 33, "explain_index": 33, "get_polici": 33, "put_polici": 33, "remove_policy_from_index": 33, "ism": 33, "whose": 33, "connection_pool_class": 35, "get_host_info": 35, "sniff_timeout": 35, "default_mimetyp": 35, "max_retri": 35, "retry_on_statu": 35, "502": 35, "503": 35, "504": 35, "retry_on_timeout": 35, "send_get_body_a": 35, "encapsul": 35, "logic": 35, "handl": 35, "instanti": 35, "callback": 35, "_cluster": 35, "obtain": 35, "startup": 35, "fast": 35, "quickli": 35, "Not": 35, "still": 35, "come": 35, "server": 35, "mimetyp": 35, "assum": 35, "propag": 35, "default_connection_class": 35, "_get_sniff_data": 35, "last_sniff": 35, "serv": 35, "_resolve_request_arg": 35, "add_connect": 35, "enabl": 35, "absolut": 35, "hand": 35, "set_connect": 35, "__init__": 35, "sniff_host": 35, "nodes_to_host_callback": 35, "develop": 37, "github": 37}, "objects": {"opensearchpy": [[17, 0, 1, "", "AuthenticationException"], [17, 0, 1, "", "AuthorizationException"], [17, 0, 1, "", "ConflictError"], [15, 0, 1, "", "Connection"], [17, 0, 1, "", "ConnectionError"], [16, 0, 1, "", "ConnectionPool"], [16, 0, 1, "", "ConnectionSelector"], [17, 0, 1, "", "ConnectionTimeout"], [17, 0, 1, "", "IllegalOperation"], [17, 0, 1, "", "ImproperlyConfigured"], [34, 0, 1, "", "JSONSerializer"], [17, 0, 1, "", "NotFoundError"], [10, 0, 1, "", "OpenSearch"], [17, 2, 1, "", "OpenSearchDeprecationWarning"], [17, 0, 1, "", "OpenSearchDslException"], [17, 0, 1, "", "OpenSearchException"], [17, 0, 1, "", "OpenSearchWarning"], [17, 0, 1, "", "RequestError"], [15, 0, 1, "", "RequestsHttpConnection"], [16, 0, 1, "", "RoundRobinSelector"], [17, 0, 1, "", "SSLError"], [17, 0, 1, "", "SerializationError"], [35, 0, 1, "", "Transport"], [17, 0, 1, "", "TransportError"], [17, 0, 1, "", "UnknownDslObject"], [15, 0, 1, "", "Urllib3HttpConnection"], [17, 0, 1, "", "ValidationException"], [15, 2, 1, "", "connections"]], "opensearchpy.Connection": [[15, 1, 1, "", "__eq__"], [15, 1, 1, "", "__hash__"], [15, 1, 1, "", "__repr__"], [15, 1, 1, "", "_raise_error"], [15, 1, 1, "", "_raise_warnings"], [15, 1, 1, "", "default_ca_certs"], [15, 1, 1, "", "log_request_fail"], [15, 1, 1, "", "log_request_success"]], "opensearchpy.ConnectionError": [[17, 1, 1, "", "__str__"]], "opensearchpy.ConnectionPool": [[16, 1, 1, "", "__repr__"], [16, 1, 1, "", "close"], [16, 1, 1, "", "get_connection"], [16, 1, 1, "", "mark_dead"], [16, 1, 1, "", "mark_live"], [16, 1, 1, "", "resurrect"]], "opensearchpy.ConnectionSelector": [[16, 1, 1, "", "select"]], "opensearchpy.ConnectionTimeout": [[17, 1, 1, "", "__str__"]], "opensearchpy.OpenSearch": [[10, 1, 1, "", "__repr__"], [10, 1, 1, "", "bulk"], [10, 1, 1, "", "clear_scroll"], [10, 1, 1, "", "close"], [10, 1, 1, "", "count"], [10, 1, 1, "", "create"], [10, 1, 1, "", "create_pit"], [10, 1, 1, "", "create_point_in_time"], [10, 1, 1, "", "delete"], [10, 1, 1, "", "delete_all_pits"], [10, 1, 1, "", "delete_by_query"], [10, 1, 1, "", "delete_by_query_rethrottle"], [10, 1, 1, "", "delete_pit"], [10, 1, 1, "", "delete_point_in_time"], [10, 1, 1, "", "delete_script"], [10, 1, 1, "", "exists"], [10, 1, 1, "", "exists_source"], [10, 1, 1, "", "explain"], [10, 1, 1, "", "field_caps"], [10, 1, 1, "", "get"], [10, 1, 1, "", "get_all_pits"], [10, 1, 1, "", "get_script"], [10, 1, 1, "", "get_script_context"], [10, 1, 1, "", "get_script_languages"], [10, 1, 1, "", "get_source"], [10, 1, 1, "", "index"], [10, 1, 1, "", "info"], [10, 1, 1, "", "list_all_point_in_time"], [10, 1, 1, "", "mget"], [10, 1, 1, "", "msearch"], [10, 1, 1, "", "msearch_template"], [10, 1, 1, "", "mtermvectors"], [10, 1, 1, "", "ping"], [10, 1, 1, "", "put_script"], [10, 1, 1, "", "rank_eval"], [10, 1, 1, "", "reindex"], [10, 1, 1, "", "reindex_rethrottle"], [10, 1, 1, "", "render_search_template"], [10, 1, 1, "", "scripts_painless_execute"], [10, 1, 1, "", "scroll"], [10, 1, 1, "", "search"], [10, 1, 1, "", "search_shards"], [10, 1, 1, "", "search_template"], [10, 1, 1, "", "terms_enum"], [10, 1, 1, "", "termvectors"], [10, 1, 1, "", "update"], [10, 1, 1, "", "update_by_query"], [10, 1, 1, "", "update_by_query_rethrottle"]], "opensearchpy.RequestsHttpConnection": [[15, 1, 1, "", "close"]], "opensearchpy.RoundRobinSelector": [[16, 1, 1, "", "select"]], "opensearchpy.Transport": [[35, 2, 1, "", "DEFAULT_CONNECTION_CLASS"], [35, 1, 1, "", "_get_sniff_data"], [35, 1, 1, "", "_resolve_request_args"], [35, 1, 1, "", "add_connection"], [35, 1, 1, "", "close"], [35, 1, 1, "", "get_connection"], [35, 1, 1, "", "mark_dead"], [35, 1, 1, "", "perform_request"], [35, 1, 1, "", "set_connections"], [35, 1, 1, "", "sniff_hosts"]], "opensearchpy.TransportError": [[17, 1, 1, "", "__str__"], [17, 3, 1, "", "error"], [17, 3, 1, "", "info"], [17, 3, 1, "", "status_code"]], "opensearchpy.Urllib3HttpConnection": [[15, 1, 1, "", "close"]], "opensearchpy.client.cat": [[3, 0, 1, "", "CatClient"]], "opensearchpy.client.cat.CatClient": [[3, 1, 1, "", "aliases"], [3, 1, 1, "", "all_pit_segments"], [3, 1, 1, "", "allocation"], [3, 1, 1, "", "cluster_manager"], [3, 1, 1, "", "count"], [3, 1, 1, "", "fielddata"], [3, 1, 1, "", "health"], [3, 1, 1, "", "help"], [3, 1, 1, "", "indices"], [3, 1, 1, "", "master"], [3, 1, 1, "", "nodeattrs"], [3, 1, 1, "", "nodes"], [3, 1, 1, "", "pending_tasks"], [3, 1, 1, "", "pit_segments"], [3, 1, 1, "", "plugins"], [3, 1, 1, "", "recovery"], [3, 1, 1, "", "repositories"], [3, 1, 1, "", "segment_replication"], [3, 1, 1, "", "segments"], [3, 1, 1, "", "shards"], [3, 1, 1, "", "snapshots"], [3, 1, 1, "", "tasks"], [3, 1, 1, "", "templates"], [3, 1, 1, "", "thread_pool"]], "opensearchpy.client.cluster": [[4, 0, 1, "", "ClusterClient"]], "opensearchpy.client.cluster.ClusterClient": [[4, 1, 1, "", "allocation_explain"], [4, 1, 1, "", "delete_component_template"], [4, 1, 1, "", "delete_voting_config_exclusions"], [4, 1, 1, "", "exists_component_template"], [4, 1, 1, "", "get_component_template"], [4, 1, 1, "", "get_settings"], [4, 1, 1, "", "health"], [4, 1, 1, "", "pending_tasks"], [4, 1, 1, "", "post_voting_config_exclusions"], [4, 1, 1, "", "put_component_template"], [4, 1, 1, "", "put_settings"], [4, 1, 1, "", "remote_info"], [4, 1, 1, "", "reroute"], [4, 1, 1, "", "state"], [4, 1, 1, "", "stats"]], "opensearchpy.client.dangling_indices": [[5, 0, 1, "", "DanglingIndicesClient"]], "opensearchpy.client.dangling_indices.DanglingIndicesClient": [[5, 1, 1, "", "delete_dangling_index"], [5, 1, 1, "", "import_dangling_index"], [5, 1, 1, "", "list_dangling_indices"]], "opensearchpy.client.features": [[6, 0, 1, "", "FeaturesClient"]], "opensearchpy.client.features.FeaturesClient": [[6, 1, 1, "", "get_features"], [6, 1, 1, "", "reset_features"]], "opensearchpy.client.indices": [[7, 0, 1, "", "IndicesClient"]], "opensearchpy.client.indices.IndicesClient": [[7, 1, 1, "", "add_block"], [7, 1, 1, "", "analyze"], [7, 1, 1, "", "clear_cache"], [7, 1, 1, "", "clone"], [7, 1, 1, "", "close"], [7, 1, 1, "", "create"], [7, 1, 1, "", "create_data_stream"], [7, 1, 1, "", "data_streams_stats"], [7, 1, 1, "", "delete"], [7, 1, 1, "", "delete_alias"], [7, 1, 1, "", "delete_data_stream"], [7, 1, 1, "", "delete_index_template"], [7, 1, 1, "", "delete_template"], [7, 1, 1, "", "disk_usage"], [7, 1, 1, "", "exists"], [7, 1, 1, "", "exists_alias"], [7, 1, 1, "", "exists_index_template"], [7, 1, 1, "", "exists_template"], [7, 1, 1, "", "field_usage_stats"], [7, 1, 1, "", "flush"], [7, 1, 1, "", "flush_synced"], [7, 1, 1, "", "forcemerge"], [7, 1, 1, "", "freeze"], [7, 1, 1, "", "get"], [7, 1, 1, "", "get_alias"], [7, 1, 1, "", "get_data_stream"], [7, 1, 1, "", "get_field_mapping"], [7, 1, 1, "", "get_index_template"], [7, 1, 1, "", "get_mapping"], [7, 1, 1, "", "get_settings"], [7, 1, 1, "", "get_template"], [7, 1, 1, "", "get_upgrade"], [7, 1, 1, "", "migrate_to_data_stream"], [7, 1, 1, "", "open"], [7, 1, 1, "", "promote_data_stream"], [7, 1, 1, "", "put_alias"], [7, 1, 1, "", "put_index_template"], [7, 1, 1, "", "put_mapping"], [7, 1, 1, "", "put_settings"], [7, 1, 1, "", "put_template"], [7, 1, 1, "", "recovery"], [7, 1, 1, "", "refresh"], [7, 1, 1, "", "reload_search_analyzers"], [7, 1, 1, "", "resolve_index"], [7, 1, 1, "", "rollover"], [7, 1, 1, "", "segments"], [7, 1, 1, "", "shard_stores"], [7, 1, 1, "", "shrink"], [7, 1, 1, "", "simulate_index_template"], [7, 1, 1, "", "simulate_template"], [7, 1, 1, "", "split"], [7, 1, 1, "", "stats"], [7, 1, 1, "", "unfreeze"], [7, 1, 1, "", "update_aliases"], [7, 1, 1, "", "upgrade"], [7, 1, 1, "", "validate_query"]], "opensearchpy.client.ingest": [[8, 0, 1, "", "IngestClient"]], "opensearchpy.client.ingest.IngestClient": [[8, 1, 1, "", "delete_pipeline"], [8, 1, 1, "", "get_pipeline"], [8, 1, 1, "", "processor_grok"], [8, 1, 1, "", "put_pipeline"], [8, 1, 1, "", "simulate"]], "opensearchpy.client.nodes": [[9, 0, 1, "", "NodesClient"]], "opensearchpy.client.nodes.NodesClient": [[9, 1, 1, "", "hot_threads"], [9, 1, 1, "", "info"], [9, 1, 1, "", "reload_secure_settings"], [9, 1, 1, "", "stats"], [9, 1, 1, "", "usage"]], "opensearchpy.client.remote": [[11, 0, 1, "", "RemoteClient"]], "opensearchpy.client.snapshot": [[13, 0, 1, "", "SnapshotClient"]], "opensearchpy.client.snapshot.SnapshotClient": [[13, 1, 1, "", "cleanup_repository"], [13, 1, 1, "", "clone"], [13, 1, 1, "", "create"], [13, 1, 1, "", "create_repository"], [13, 1, 1, "", "delete"], [13, 1, 1, "", "delete_repository"], [13, 1, 1, "", "get"], [13, 1, 1, "", "get_repository"], [13, 1, 1, "", "repository_analyze"], [13, 1, 1, "", "restore"], [13, 1, 1, "", "status"], [13, 1, 1, "", "verify_repository"]], "opensearchpy.client.tasks": [[14, 0, 1, "", "TasksClient"]], "opensearchpy.client.tasks.TasksClient": [[14, 1, 1, "", "cancel"], [14, 1, 1, "", "get"], [14, 1, 1, "", "list"]], "opensearchpy.helpers.aggs": [[19, 0, 1, "", "Agg"]], "opensearchpy.helpers.aggs.Agg": [[19, 1, 1, "", "to_dict"]], "opensearchpy.helpers.analysis": [[20, 0, 1, "", "Analyzer"]], "opensearchpy.helpers.document": [[21, 0, 1, "", "Document"]], "opensearchpy.helpers.document.Document": [[21, 1, 1, "", "__repr__"], [21, 1, 1, "", "delete"], [21, 1, 1, "", "exists"], [21, 1, 1, "", "get"], [21, 1, 1, "", "init"], [21, 1, 1, "", "mget"], [21, 1, 1, "", "save"], [21, 1, 1, "", "search"], [21, 1, 1, "", "to_dict"], [21, 1, 1, "", "update"]], "opensearchpy.helpers.faceted_search": [[22, 0, 1, "", "FacetedSearch"]], "opensearchpy.helpers.faceted_search.FacetedSearch": [[22, 1, 1, "", "add_filter"], [22, 1, 1, "", "aggregate"], [22, 1, 1, "", "build_search"], [22, 1, 1, "", "execute"], [22, 1, 1, "", "filter"], [22, 1, 1, "", "highlight"], [22, 1, 1, "", "query"], [22, 1, 1, "", "search"], [22, 1, 1, "", "sort"]], "opensearchpy.helpers.field": [[23, 0, 1, "", "Field"]], "opensearchpy.helpers.field.Field": [[23, 1, 1, "", "to_dict"]], "opensearchpy.helpers.function": [[24, 0, 1, "", "ScoreFunction"]], "opensearchpy.helpers.function.ScoreFunction": [[24, 1, 1, "", "to_dict"]], "opensearchpy.helpers.index": [[25, 0, 1, "", "Index"]], "opensearchpy.helpers.index.Index": [[25, 1, 1, "", "aliases"], [25, 1, 1, "", "analyze"], [25, 1, 1, "", "analyzer"], [25, 1, 1, "", "clear_cache"], [25, 1, 1, "", "clone"], [25, 1, 1, "", "close"], [25, 1, 1, "", "create"], [25, 1, 1, "", "delete"], [25, 1, 1, "", "delete_alias"], [25, 1, 1, "", "document"], [25, 1, 1, "", "exists"], [25, 1, 1, "", "exists_alias"], [25, 1, 1, "", "flush"], [25, 1, 1, "", "forcemerge"], [25, 1, 1, "", "get"], [25, 1, 1, "", "get_alias"], [25, 1, 1, "", "get_field_mapping"], [25, 1, 1, "", "get_mapping"], [25, 1, 1, "", "get_settings"], [25, 1, 1, "", "get_upgrade"], [25, 1, 1, "", "mapping"], [25, 1, 1, "", "open"], [25, 1, 1, "", "put_alias"], [25, 1, 1, "", "put_mapping"], [25, 1, 1, "", "put_settings"], [25, 1, 1, "", "recovery"], [25, 1, 1, "", "refresh"], [25, 1, 1, "", "save"], [25, 1, 1, "", "search"], [25, 1, 1, "", "segments"], [25, 1, 1, "", "settings"], [25, 1, 1, "", "shard_stores"], [25, 1, 1, "", "shrink"], [25, 1, 1, "", "stats"], [25, 1, 1, "", "updateByQuery"], [25, 1, 1, "", "upgrade"], [25, 1, 1, "", "validate_query"]], "opensearchpy.helpers.mapping": [[26, 0, 1, "", "Mapping"]], "opensearchpy.helpers.mapping.Mapping": [[26, 1, 1, "", "__repr__"]], "opensearchpy.helpers.query": [[27, 0, 1, "", "Query"]], "opensearchpy.helpers.search": [[28, 0, 1, "", "Search"]], "opensearchpy.helpers.search.Search": [[28, 1, 1, "", "__getitem__"], [28, 1, 1, "", "__iter__"], [28, 1, 1, "", "_clone"], [28, 1, 1, "", "collapse"], [28, 1, 1, "", "count"], [28, 1, 1, "", "delete"], [28, 1, 1, "", "execute"], [28, 1, 1, "", "from_dict"], [28, 1, 1, "", "highlight"], [28, 1, 1, "", "highlight_options"], [28, 1, 1, "", "response_class"], [28, 1, 1, "", "scan"], [28, 1, 1, "", "script_fields"], [28, 1, 1, "", "sort"], [28, 1, 1, "", "source"], [28, 1, 1, "", "suggest"], [28, 1, 1, "", "to_dict"], [28, 1, 1, "", "update_from_dict"]], "opensearchpy.helpers.update_by_query": [[29, 0, 1, "", "UpdateByQuery"]], "opensearchpy.helpers.update_by_query.UpdateByQuery": [[29, 1, 1, "", "_clone"], [29, 1, 1, "", "execute"], [29, 1, 1, "", "from_dict"], [29, 1, 1, "", "response_class"], [29, 1, 1, "", "script"], [29, 1, 1, "", "to_dict"], [29, 1, 1, "", "update_from_dict"]], "opensearchpy.helpers.wrappers": [[30, 0, 1, "", "Range"]], "opensearchpy.helpers.wrappers.Range": [[30, 1, 1, "", "__repr__"]], "opensearchpy.plugins.alerting": [[32, 0, 1, "", "AlertingClient"]], "opensearchpy.plugins.alerting.AlertingClient": [[32, 1, 1, "", "acknowledge_alert"], [32, 1, 1, "", "create_destination"], [32, 1, 1, "", "create_monitor"], [32, 1, 1, "", "delete_destination"], [32, 1, 1, "", "delete_monitor"], [32, 1, 1, "", "get_alerts"], [32, 1, 1, "", "get_destination"], [32, 1, 1, "", "get_monitor"], [32, 1, 1, "", "run_monitor"], [32, 1, 1, "", "search_monitor"], [32, 1, 1, "", "update_destination"], [32, 1, 1, "", "update_monitor"]], "opensearchpy.plugins.index_management": [[33, 0, 1, "", "IndexManagementClient"]], "opensearchpy.plugins.index_management.IndexManagementClient": [[33, 1, 1, "", "add_policy"], [33, 1, 1, "", "change_policy"], [33, 1, 1, "", "delete_policy"], [33, 1, 1, "", "explain_index"], [33, 1, 1, "", "get_policy"], [33, 1, 1, "", "put_policy"], [33, 1, 1, "", "remove_policy_from_index"], [33, 1, 1, "", "retry"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:attribute", "3": "py:property"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "property", "Python property"]}, "titleterms": {"welcom": [0, 37], "user": [0, 37], "guid": [0, 37], "compat": [0, 37], "opensearch": [0, 2, 10, 37], "project": [0, 37], "resourc": [0, 37], "code": [0, 37], "conduct": [0, 37], "licens": [0, 37], "copyright": [0, 37], "api": 1, "refer": 1, "client": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 37], "within": 2, "compact": 3, "align": 3, "text": 3, "cat": 3, "cluster": 4, "dangl": 5, "indic": [5, 7], "featur": 6, "ingest": 8, "node": 9, "remot": 11, "secur": 12, "snapshot": 13, "task": 14, "connect": 15, "connection_pool": 16, "except": 17, "helper": 18, "agg": 19, "analysi": 20, "document": [21, 37], "faceted_search": 22, "field": 23, "function": 24, "index": [25, 33, 36], "map": 26, "queri": 27, "search": 28, "update_by_queri": 29, "wrapper": 30, "plugin": [31, 32, 33], "alert": 32, "manag": 33, "serial": 34, "transport": 35, "python": 37, "tabl": 37, "content": 37}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Welcome!": [[0, "welcome"], [37, "welcome"]], "User Guide": [[0, "user-guide"], [37, "user-guide"]], "Compatibility with OpenSearch": [[0, "compatibility-with-opensearch"], [37, "compatibility-with-opensearch"]], "Project Resources": [[0, "project-resources"], [37, "project-resources"]], "Code of Conduct": [[0, "code-of-conduct"], [37, "code-of-conduct"]], "License": [[0, "license"], [37, "license"]], "Copyright": [[0, "copyright"], [37, "copyright"]], "API Reference": [[1, "api-reference"]], "Clients": [[2, "clients"]], "Clients within Opensearch": [[2, "clients-within-opensearch"]], "Compact and aligned text (CAT) Client": [[3, "compact-and-aligned-text-cat-client"]], "Cluster Client": [[4, "cluster-client"]], "Dangling Indices Client": [[5, "dangling-indices-client"]], "Features Client": [[6, "features-client"]], "Indices Client": [[7, "indices-client"]], "Ingest Client": [[8, "ingest-client"]], "Nodes Client": [[9, "nodes-client"]], "OpenSearch Client": [[10, "opensearch-client"]], "Remote Client": [[11, "remote-client"]], "Security Client": [[12, "security-client"]], "Snapshot Client": [[13, "snapshot-client"]], "Tasks Client": [[14, "tasks-client"]], "connection": [[15, "connection"]], "connection_pool": [[16, "connection-pool"]], "exceptions": [[17, "exceptions"]], "helpers": [[18, "helpers"]], "aggs": [[19, "aggs"]], "analysis": [[20, "analysis"]], "document": [[21, "document"]], "faceted_search": [[22, "faceted-search"]], "field": [[23, "field"]], "function": [[24, "function"]], "index": [[25, "index"]], "mapping": [[26, "mapping"]], "query": [[27, "query"]], "search": [[28, "search"]], "update_by_query": [[29, "update-by-query"]], "wrappers": [[30, "wrappers"]], "Plugins": [[31, "plugins"]], "Alerting Plugin": [[32, "alerting-plugin"]], "Index Management Plugin": [[33, "index-management-plugin"]], "serializer": [[34, "serializer"]], "transport": [[35, "transport"]], "Index": [[36, "index"]], "OpenSearch Python Client Documentation": [[37, "opensearch-python-client-documentation"]], "Table of Contents": [[37, "table-of-contents"]]}, "indexentries": {"catclient (class in opensearchpy.client.cat)": [[3, "opensearchpy.client.cat.CatClient"]], "aliases() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.aliases"]], "all_pit_segments() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.all_pit_segments"]], "allocation() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.allocation"]], "cluster_manager() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.cluster_manager"]], "count() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.count"]], "fielddata() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.fielddata"]], "health() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.health"]], "help() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.help"]], "indices() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.indices"]], "master() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.master"]], "nodeattrs() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.nodeattrs"]], "nodes() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.nodes"]], "pending_tasks() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.pending_tasks"]], "pit_segments() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.pit_segments"]], "plugins() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.plugins"]], "recovery() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.recovery"]], "repositories() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.repositories"]], "segment_replication() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.segment_replication"]], "segments() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.segments"]], "shards() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.shards"]], "snapshots() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.snapshots"]], "tasks() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.tasks"]], "templates() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.templates"]], "thread_pool() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.thread_pool"]], "clusterclient (class in opensearchpy.client.cluster)": [[4, "opensearchpy.client.cluster.ClusterClient"]], "allocation_explain() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.allocation_explain"]], "delete_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.delete_component_template"]], "delete_voting_config_exclusions() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.delete_voting_config_exclusions"]], "exists_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.exists_component_template"]], "get_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.get_component_template"]], "get_settings() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.get_settings"]], "health() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.health"]], "pending_tasks() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.pending_tasks"]], "post_voting_config_exclusions() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.post_voting_config_exclusions"]], "put_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.put_component_template"]], "put_settings() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.put_settings"]], "remote_info() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.remote_info"]], "reroute() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.reroute"]], "state() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.state"]], "stats() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.stats"]], "danglingindicesclient (class in opensearchpy.client.dangling_indices)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient"]], "delete_dangling_index() (opensearchpy.client.dangling_indices.danglingindicesclient method)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient.delete_dangling_index"]], "import_dangling_index() (opensearchpy.client.dangling_indices.danglingindicesclient method)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient.import_dangling_index"]], "list_dangling_indices() (opensearchpy.client.dangling_indices.danglingindicesclient method)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient.list_dangling_indices"]], "featuresclient (class in opensearchpy.client.features)": [[6, "opensearchpy.client.features.FeaturesClient"]], "get_features() (opensearchpy.client.features.featuresclient method)": [[6, "opensearchpy.client.features.FeaturesClient.get_features"]], "reset_features() (opensearchpy.client.features.featuresclient method)": [[6, "opensearchpy.client.features.FeaturesClient.reset_features"]], "indicesclient (class in opensearchpy.client.indices)": [[7, "opensearchpy.client.indices.IndicesClient"]], "add_block() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.add_block"]], "analyze() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.analyze"]], "clear_cache() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.clear_cache"]], "clone() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.clone"]], "close() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.close"]], "create() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.create"]], "create_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.create_data_stream"]], "data_streams_stats() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.data_streams_stats"]], "delete() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete"]], "delete_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_alias"]], "delete_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_data_stream"]], "delete_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_index_template"]], "delete_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_template"]], "disk_usage() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.disk_usage"]], "exists() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists"]], "exists_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists_alias"]], "exists_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists_index_template"]], "exists_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists_template"]], "field_usage_stats() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.field_usage_stats"]], "flush() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.flush"]], "flush_synced() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.flush_synced"]], "forcemerge() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.forcemerge"]], "freeze() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.freeze"]], "get() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get"]], "get_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_alias"]], "get_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_data_stream"]], "get_field_mapping() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_field_mapping"]], "get_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_index_template"]], "get_mapping() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_mapping"]], "get_settings() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_settings"]], "get_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_template"]], "get_upgrade() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_upgrade"]], "migrate_to_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.migrate_to_data_stream"]], "open() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.open"]], "promote_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.promote_data_stream"]], "put_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_alias"]], "put_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_index_template"]], "put_mapping() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_mapping"]], "put_settings() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_settings"]], "put_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_template"]], "recovery() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.recovery"]], "refresh() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.refresh"]], "reload_search_analyzers() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.reload_search_analyzers"]], "resolve_index() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.resolve_index"]], "rollover() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.rollover"]], "segments() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.segments"]], "shard_stores() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.shard_stores"]], "shrink() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.shrink"]], "simulate_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.simulate_index_template"]], "simulate_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.simulate_template"]], "split() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.split"]], "stats() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.stats"]], "unfreeze() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.unfreeze"]], "update_aliases() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.update_aliases"]], "upgrade() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.upgrade"]], "validate_query() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.validate_query"]], "ingestclient (class in opensearchpy.client.ingest)": [[8, "opensearchpy.client.ingest.IngestClient"]], "delete_pipeline() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.delete_pipeline"]], "get_pipeline() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.get_pipeline"]], "processor_grok() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.processor_grok"]], "put_pipeline() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.put_pipeline"]], "simulate() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.simulate"]], "nodesclient (class in opensearchpy.client.nodes)": [[9, "opensearchpy.client.nodes.NodesClient"]], "hot_threads() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.hot_threads"]], "info() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.info"]], "reload_secure_settings() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.reload_secure_settings"]], "stats() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.stats"]], "usage() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.usage"]], "opensearch (class in opensearchpy)": [[10, "opensearchpy.OpenSearch"]], "__repr__() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.__repr__"]], "bulk() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.bulk"]], "clear_scroll() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.clear_scroll"]], "close() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.close"]], "count() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.count"]], "create() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.create"]], "create_pit() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.create_pit"]], "create_point_in_time() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.create_point_in_time"]], "delete() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete"]], "delete_all_pits() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_all_pits"]], "delete_by_query() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_by_query"]], "delete_by_query_rethrottle() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_by_query_rethrottle"]], "delete_pit() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_pit"]], "delete_point_in_time() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_point_in_time"]], "delete_script() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_script"]], "exists() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.exists"]], "exists_source() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.exists_source"]], "explain() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.explain"]], "field_caps() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.field_caps"]], "get() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get"]], "get_all_pits() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_all_pits"]], "get_script() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_script"]], "get_script_context() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_script_context"]], "get_script_languages() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_script_languages"]], "get_source() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_source"]], "index() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.index"]], "info() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.info"]], "list_all_point_in_time() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.list_all_point_in_time"]], "mget() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.mget"]], "msearch() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.msearch"]], "msearch_template() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.msearch_template"]], "mtermvectors() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.mtermvectors"]], "ping() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.ping"]], "put_script() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.put_script"]], "rank_eval() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.rank_eval"]], "reindex() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.reindex"]], "reindex_rethrottle() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.reindex_rethrottle"]], "render_search_template() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.render_search_template"]], "scripts_painless_execute() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.scripts_painless_execute"]], "scroll() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.scroll"]], "search() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.search"]], "search_shards() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.search_shards"]], "search_template() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.search_template"]], "terms_enum() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.terms_enum"]], "termvectors() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.termvectors"]], "update() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.update"]], "update_by_query() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.update_by_query"]], "update_by_query_rethrottle() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.update_by_query_rethrottle"]], "remoteclient (class in opensearchpy.client.remote)": [[11, "opensearchpy.client.remote.RemoteClient"]], "snapshotclient (class in opensearchpy.client.snapshot)": [[13, "opensearchpy.client.snapshot.SnapshotClient"]], "cleanup_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.cleanup_repository"]], "clone() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.clone"]], "create() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.create"]], "create_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.create_repository"]], "delete() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.delete"]], "delete_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.delete_repository"]], "get() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.get"]], "get_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.get_repository"]], "repository_analyze() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.repository_analyze"]], "restore() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.restore"]], "status() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.status"]], "verify_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.verify_repository"]], "tasksclient (class in opensearchpy.client.tasks)": [[14, "opensearchpy.client.tasks.TasksClient"]], "cancel() (opensearchpy.client.tasks.tasksclient method)": [[14, "opensearchpy.client.tasks.TasksClient.cancel"]], "get() (opensearchpy.client.tasks.tasksclient method)": [[14, "opensearchpy.client.tasks.TasksClient.get"]], "list() (opensearchpy.client.tasks.tasksclient method)": [[14, "opensearchpy.client.tasks.TasksClient.list"]], "connection (class in opensearchpy)": [[15, "opensearchpy.Connection"]], "requestshttpconnection (class in opensearchpy)": [[15, "opensearchpy.RequestsHttpConnection"]], "urllib3httpconnection (class in opensearchpy)": [[15, "opensearchpy.Urllib3HttpConnection"]], "__eq__() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.__eq__"]], "__hash__() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.__hash__"]], "__repr__() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.__repr__"]], "_raise_error() (opensearchpy.connection method)": [[15, "opensearchpy.Connection._raise_error"]], "_raise_warnings() (opensearchpy.connection method)": [[15, "opensearchpy.Connection._raise_warnings"]], "close() (opensearchpy.requestshttpconnection method)": [[15, "opensearchpy.RequestsHttpConnection.close"]], "close() (opensearchpy.urllib3httpconnection method)": [[15, "opensearchpy.Urllib3HttpConnection.close"]], "connections (in module opensearchpy)": [[15, "opensearchpy.connections"]], "default_ca_certs() (opensearchpy.connection static method)": [[15, "opensearchpy.Connection.default_ca_certs"]], "log_request_fail() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.log_request_fail"]], "log_request_success() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.log_request_success"]], "connectionpool (class in opensearchpy)": [[16, "opensearchpy.ConnectionPool"]], "connectionselector (class in opensearchpy)": [[16, "opensearchpy.ConnectionSelector"]], "roundrobinselector (class in opensearchpy)": [[16, "opensearchpy.RoundRobinSelector"]], "__repr__() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.__repr__"]], "close() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.close"]], "get_connection() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.get_connection"]], "mark_dead() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.mark_dead"]], "mark_live() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.mark_live"]], "resurrect() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.resurrect"]], "select() (opensearchpy.connectionselector method)": [[16, "opensearchpy.ConnectionSelector.select"]], "select() (opensearchpy.roundrobinselector method)": [[16, "opensearchpy.RoundRobinSelector.select"]], "authenticationexception (class in opensearchpy)": [[17, "opensearchpy.AuthenticationException"]], "authorizationexception (class in opensearchpy)": [[17, "opensearchpy.AuthorizationException"]], "conflicterror (class in opensearchpy)": [[17, "opensearchpy.ConflictError"]], "connectionerror (class in opensearchpy)": [[17, "opensearchpy.ConnectionError"]], "connectiontimeout (class in opensearchpy)": [[17, "opensearchpy.ConnectionTimeout"]], "illegaloperation (class in opensearchpy)": [[17, "opensearchpy.IllegalOperation"]], "improperlyconfigured (class in opensearchpy)": [[17, "opensearchpy.ImproperlyConfigured"]], "notfounderror (class in opensearchpy)": [[17, "opensearchpy.NotFoundError"]], "opensearchdeprecationwarning (in module opensearchpy)": [[17, "opensearchpy.OpenSearchDeprecationWarning"]], "opensearchdslexception (class in opensearchpy)": [[17, "opensearchpy.OpenSearchDslException"]], "opensearchexception (class in opensearchpy)": [[17, "opensearchpy.OpenSearchException"]], "opensearchwarning (class in opensearchpy)": [[17, "opensearchpy.OpenSearchWarning"]], "requesterror (class in opensearchpy)": [[17, "opensearchpy.RequestError"]], "sslerror (class in opensearchpy)": [[17, "opensearchpy.SSLError"]], "serializationerror (class in opensearchpy)": [[17, "opensearchpy.SerializationError"]], "transporterror (class in opensearchpy)": [[17, "opensearchpy.TransportError"]], "unknowndslobject (class in opensearchpy)": [[17, "opensearchpy.UnknownDslObject"]], "validationexception (class in opensearchpy)": [[17, "opensearchpy.ValidationException"]], "__str__() (opensearchpy.connectionerror method)": [[17, "opensearchpy.ConnectionError.__str__"]], "__str__() (opensearchpy.connectiontimeout method)": [[17, "opensearchpy.ConnectionTimeout.__str__"]], "__str__() (opensearchpy.transporterror method)": [[17, "opensearchpy.TransportError.__str__"]], "error (opensearchpy.transporterror property)": [[17, "opensearchpy.TransportError.error"]], "info (opensearchpy.transporterror property)": [[17, "opensearchpy.TransportError.info"]], "status_code (opensearchpy.transporterror property)": [[17, "opensearchpy.TransportError.status_code"]], "agg (class in opensearchpy.helpers.aggs)": [[19, "opensearchpy.helpers.aggs.Agg"]], "to_dict() (opensearchpy.helpers.aggs.agg method)": [[19, "opensearchpy.helpers.aggs.Agg.to_dict"]], "analyzer (class in opensearchpy.helpers.analysis)": [[20, "opensearchpy.helpers.analysis.Analyzer"]], "document (class in opensearchpy.helpers.document)": [[21, "opensearchpy.helpers.document.Document"]], "__repr__() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.__repr__"]], "delete() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.delete"]], "exists() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.exists"]], "get() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.get"]], "init() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.init"]], "mget() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.mget"]], "save() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.save"]], "search() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.search"]], "to_dict() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.to_dict"]], "update() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.update"]], "facetedsearch (class in opensearchpy.helpers.faceted_search)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch"]], "add_filter() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.add_filter"]], "aggregate() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.aggregate"]], "build_search() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.build_search"]], "execute() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.execute"]], "filter() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.filter"]], "highlight() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.highlight"]], "query() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.query"]], "search() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.search"]], "sort() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.sort"]], "field (class in opensearchpy.helpers.field)": [[23, "opensearchpy.helpers.field.Field"]], "to_dict() (opensearchpy.helpers.field.field method)": [[23, "opensearchpy.helpers.field.Field.to_dict"]], "scorefunction (class in opensearchpy.helpers.function)": [[24, "opensearchpy.helpers.function.ScoreFunction"]], "to_dict() (opensearchpy.helpers.function.scorefunction method)": [[24, "opensearchpy.helpers.function.ScoreFunction.to_dict"]], "index (class in opensearchpy.helpers.index)": [[25, "opensearchpy.helpers.index.Index"]], "aliases() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.aliases"]], "analyze() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.analyze"]], "analyzer() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.analyzer"]], "clear_cache() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.clear_cache"]], "clone() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.clone"]], "close() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.close"]], "create() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.create"]], "delete() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.delete"]], "delete_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.delete_alias"]], "document() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.document"]], "exists() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.exists"]], "exists_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.exists_alias"]], "flush() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.flush"]], "forcemerge() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.forcemerge"]], "get() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get"]], "get_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_alias"]], "get_field_mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_field_mapping"]], "get_mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_mapping"]], "get_settings() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_settings"]], "get_upgrade() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_upgrade"]], "mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.mapping"]], "open() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.open"]], "put_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.put_alias"]], "put_mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.put_mapping"]], "put_settings() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.put_settings"]], "recovery() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.recovery"]], "refresh() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.refresh"]], "save() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.save"]], "search() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.search"]], "segments() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.segments"]], "settings() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.settings"]], "shard_stores() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.shard_stores"]], "shrink() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.shrink"]], "stats() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.stats"]], "updatebyquery() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.updateByQuery"]], "upgrade() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.upgrade"]], "validate_query() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.validate_query"]], "mapping (class in opensearchpy.helpers.mapping)": [[26, "opensearchpy.helpers.mapping.Mapping"]], "__repr__() (opensearchpy.helpers.mapping.mapping method)": [[26, "opensearchpy.helpers.mapping.Mapping.__repr__"]], "query (class in opensearchpy.helpers.query)": [[27, "opensearchpy.helpers.query.Query"]], "search (class in opensearchpy.helpers.search)": [[28, "opensearchpy.helpers.search.Search"]], "__getitem__() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.__getitem__"]], "__iter__() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.__iter__"]], "_clone() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search._clone"]], "collapse() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.collapse"]], "count() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.count"]], "delete() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.delete"]], "execute() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.execute"]], "from_dict() (opensearchpy.helpers.search.search class method)": [[28, "opensearchpy.helpers.search.Search.from_dict"]], "highlight() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.highlight"]], "highlight_options() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.highlight_options"]], "response_class() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.response_class"]], "scan() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.scan"]], "script_fields() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.script_fields"]], "sort() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.sort"]], "source() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.source"]], "suggest() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.suggest"]], "to_dict() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.to_dict"]], "update_from_dict() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.update_from_dict"]], "updatebyquery (class in opensearchpy.helpers.update_by_query)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery"]], "_clone() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery._clone"]], "execute() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.execute"]], "from_dict() (opensearchpy.helpers.update_by_query.updatebyquery class method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.from_dict"]], "response_class() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.response_class"]], "script() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.script"]], "to_dict() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.to_dict"]], "update_from_dict() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.update_from_dict"]], "range (class in opensearchpy.helpers.wrappers)": [[30, "opensearchpy.helpers.wrappers.Range"]], "__repr__() (opensearchpy.helpers.wrappers.range method)": [[30, "opensearchpy.helpers.wrappers.Range.__repr__"]], "alertingclient (class in opensearchpy.plugins.alerting)": [[32, "opensearchpy.plugins.alerting.AlertingClient"]], "acknowledge_alert() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.acknowledge_alert"]], "create_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.create_destination"]], "create_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.create_monitor"]], "delete_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.delete_destination"]], "delete_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.delete_monitor"]], "get_alerts() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.get_alerts"]], "get_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.get_destination"]], "get_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.get_monitor"]], "run_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.run_monitor"]], "search_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.search_monitor"]], "update_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.update_destination"]], "update_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.update_monitor"]], "indexmanagementclient (class in opensearchpy.plugins.index_management)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient"]], "add_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.add_policy"]], "change_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.change_policy"]], "delete_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.delete_policy"]], "explain_index() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.explain_index"]], "get_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.get_policy"]], "put_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.put_policy"]], "remove_policy_from_index() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.remove_policy_from_index"]], "retry() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.retry"]], "jsonserializer (class in opensearchpy)": [[34, "opensearchpy.JSONSerializer"]], "default_connection_class (opensearchpy.transport attribute)": [[35, "opensearchpy.Transport.DEFAULT_CONNECTION_CLASS"]], "transport (class in opensearchpy)": [[35, "opensearchpy.Transport"]], "_get_sniff_data() (opensearchpy.transport method)": [[35, "opensearchpy.Transport._get_sniff_data"]], "_resolve_request_args() (opensearchpy.transport method)": [[35, "opensearchpy.Transport._resolve_request_args"]], "add_connection() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.add_connection"]], "close() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.close"]], "get_connection() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.get_connection"]], "mark_dead() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.mark_dead"]], "perform_request() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.perform_request"]], "set_connections() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.set_connections"]], "sniff_hosts() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.sniff_hosts"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["README", "api-ref", "api-ref/client", "api-ref/clients/cat_client", "api-ref/clients/cluster_client", "api-ref/clients/dangling_indices_client", "api-ref/clients/features_client", "api-ref/clients/indices_client", "api-ref/clients/ingest_client", "api-ref/clients/nodes_client", "api-ref/clients/opensearch_client", "api-ref/clients/remote_client", "api-ref/clients/security_client", "api-ref/clients/snapshot_client", "api-ref/clients/tasks_client", "api-ref/connection", "api-ref/connection_pool", "api-ref/exceptions", "api-ref/helpers", "api-ref/helpers/aggs", "api-ref/helpers/analysis", "api-ref/helpers/document", "api-ref/helpers/faceted_search", "api-ref/helpers/field", "api-ref/helpers/function", "api-ref/helpers/index", "api-ref/helpers/mapping", "api-ref/helpers/query", "api-ref/helpers/search", "api-ref/helpers/update_by_query", "api-ref/helpers/wrappers", "api-ref/plugins", "api-ref/plugins/alerting_plugin", "api-ref/plugins/index_management_plugin", "api-ref/serializer", "api-ref/transport", "genindex", "index"], "filenames": ["README.md", "api-ref.md", "api-ref/client.md", "api-ref/clients/cat_client.md", "api-ref/clients/cluster_client.md", "api-ref/clients/dangling_indices_client.md", "api-ref/clients/features_client.md", "api-ref/clients/indices_client.md", "api-ref/clients/ingest_client.md", "api-ref/clients/nodes_client.md", "api-ref/clients/opensearch_client.md", "api-ref/clients/remote_client.md", "api-ref/clients/security_client.md", "api-ref/clients/snapshot_client.md", "api-ref/clients/tasks_client.md", "api-ref/connection.md", "api-ref/connection_pool.md", "api-ref/exceptions.md", "api-ref/helpers.md", "api-ref/helpers/aggs.md", "api-ref/helpers/analysis.md", "api-ref/helpers/document.md", "api-ref/helpers/faceted_search.md", "api-ref/helpers/field.md", "api-ref/helpers/function.md", "api-ref/helpers/index.md", "api-ref/helpers/mapping.md", "api-ref/helpers/query.md", "api-ref/helpers/search.md", "api-ref/helpers/update_by_query.md", "api-ref/helpers/wrappers.md", "api-ref/plugins.md", "api-ref/plugins/alerting_plugin.md", "api-ref/plugins/index_management_plugin.md", "api-ref/serializer.md", "api-ref/transport.md", "genindex.md", "index.md"], "titles": ["Welcome!", "API Reference", "Clients", "Compact and aligned text (CAT) Client", "Cluster Client", "Dangling Indices Client", "Features Client", "Indices Client", "Ingest Client", "Nodes Client", "OpenSearch Client", "Remote Client", "Security Client", "Snapshot Client", "Tasks Client", "connection", "connection_pool", "exceptions", "helpers", "aggs", "analysis", "document", "faceted_search", "field", "function", "index", "mapping", "query", "search", "update_by_query", "wrappers", "Plugins", "Alerting Plugin", "Index Management Plugin", "serializer", "transport", "Index", "OpenSearch Python Client Documentation"], "terms": {"python": [0, 10, 15, 22], "client": [0, 1, 17, 32, 33], "api": [0, 3, 6, 7, 10, 14, 15, 21, 25, 28, 29, 35, 37], "doc": [0, 7, 9, 10, 21, 25, 28, 37], "py": [0, 15, 37], "i": [0, 3, 4, 6, 7, 10, 13, 15, 16, 17, 21, 22, 23, 25, 28, 33, 35, 37], "commun": [0, 37], "driven": [0, 37], "open": [0, 3, 4, 7, 10, 15, 25, 37], "sourc": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35, 37], "fork": [0, 37], "elasticsearch": [0, 37], "under": [0, 37], "apach": [0, 37], "v2": [0, 25, 37], "0": [0, 7, 10, 13, 25, 28, 35, 37], "For": [0, 15, 25, 28, 37], "more": [0, 3, 4, 7, 10, 15, 16, 25, 35, 37], "inform": [0, 3, 4, 7, 9, 10, 13, 14, 15, 16, 22, 25, 28, 35, 37], "see": [0, 10, 15, 25, 37], "org": [0, 21, 25, 37], "To": [0, 3, 4, 5, 8, 35, 37], "get": [0, 3, 4, 6, 7, 9, 10, 13, 14, 15, 16, 21, 25, 33, 35, 37], "start": [0, 10, 37], "websit": [0, 37], "download": [0, 37], "document": [0, 1, 3, 7, 8, 9, 10, 18, 25, 28], "need": [0, 7, 10, 22, 37], "help": [0, 3, 37], "try": [0, 16, 32, 37], "forum": [0, 37], "principl": [0, 37], "contribut": [0, 37], "maintain": [0, 7, 10, 15, 37], "respons": [0, 3, 10, 15, 17, 22, 28, 29, 35, 37], "releas": [0, 7, 37], "manag": [0, 1, 3, 4, 5, 7, 8, 15, 16, 31, 35, 37], "admin": [0, 37], "secur": [0, 1, 2, 9, 15, 37], "thi": [0, 3, 4, 6, 7, 10, 13, 14, 15, 16, 17, 21, 22, 25, 28, 29, 33, 35, 37], "ha": [0, 7, 10, 13, 14, 16, 22, 33, 37], "adopt": [0, 37], "amazon": [0, 37], "faq": [0, 37], "contact": [0, 37], "opensourc": [0, 37], "codeofconduct": [0, 37], "com": [0, 37], "ani": [0, 4, 7, 10, 15, 16, 21, 25, 28, 32, 33, 35, 37], "addit": [0, 10, 21, 25, 28, 29, 37], "question": [0, 37], "comment": [0, 37], "contributor": [0, 37], "notic": [0, 37], "detail": [0, 3, 4, 7, 10, 13, 14, 32, 37], "opensearch": [1, 9, 15, 17, 21, 25, 28, 29], "compact": [1, 2], "align": [1, 2], "text": [1, 2, 7, 10, 22, 25, 28], "cat": [1, 2, 10], "cluster": [1, 2, 3, 5, 7, 8, 9, 10, 16, 35], "dangl": [1, 2], "indic": [1, 2, 3, 4, 6, 9, 10, 13, 25, 35], "ingest": [1, 2, 9, 10], "node": [1, 2, 3, 4, 5, 6, 7, 8, 10, 13, 14, 15, 17, 25, 35], "remot": [1, 2, 4, 10], "snapshot": [1, 2, 3, 6, 9, 10], "task": [1, 2, 3, 7, 9, 10], "featur": [1, 2], "connect": [1, 3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 16, 17, 21, 25, 35], "connection_pool": [1, 35], "except": [1, 7, 15, 21, 25, 35], "helper": [1, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30], "agg": [1, 18, 28], "analysi": [1, 7, 18, 25], "faceted_search": [1, 18], "field": [1, 3, 6, 7, 9, 10, 18, 21, 22, 25, 28], "function": [1, 18, 35], "index": [1, 3, 4, 5, 7, 9, 10, 13, 18, 21, 22, 28, 29, 31, 37], "map": [1, 4, 7, 10, 18, 21, 25], "queri": [1, 7, 10, 18, 22, 25, 28, 29, 35], "search": [1, 7, 9, 10, 18, 21, 22, 25, 29, 32], "update_by_queri": [1, 10, 18], "wrapper": [1, 18, 28, 29], "plugin": [1, 3, 9], "alert": [1, 31], "serial": [1, 10, 17, 19, 21, 23, 24, 28, 29, 35], "transport": [1, 9, 10, 15, 16], "includ": [2, 3, 4, 6, 7, 10, 13, 21, 22, 25, 28, 29], "sever": [2, 3, 10], "class": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35], "opensearchpi": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35], "catclient": [3, 10], "base": [3, 4, 5, 6, 7, 8, 9, 10, 11, 13, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35], "namespacedcli": [3, 4, 5, 6, 7, 8, 9, 11, 13, 14, 32, 33], "alias": [3, 7, 10, 25], "name": [3, 4, 7, 9, 10, 13, 14, 22, 25, 28, 33], "none": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 21, 22, 25, 28, 32, 33, 35], "param": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 16, 19, 20, 24, 27, 28, 29, 32, 33, 35], "header": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 17, 32, 33, 35], "show": [3, 7, 9, 10, 13, 15, 32], "about": [3, 4, 7, 9, 10, 13, 14, 25], "current": [3, 4, 7, 15, 16, 28, 29, 33], "configur": [3, 4, 7, 15, 25, 32, 35], "filter": [3, 7, 10, 22, 25, 28, 29], "rout": [3, 4, 7, 10], "info": [3, 9, 10, 13, 17], "paramet": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 21, 22, 23, 25, 28, 29, 32, 33, 35], "comma": [3, 4, 7, 8, 9, 10, 13, 14], "separ": [3, 4, 7, 8, 9, 10, 13, 14, 15], "list": [3, 4, 6, 7, 8, 9, 10, 13, 14, 16, 21, 35], "alia": [3, 7, 10, 15, 17, 21, 25, 35], "expand_wildcard": [3, 4, 7, 10], "whether": [3, 4, 7, 9, 10, 13, 15, 23, 25, 35], "expand": [3, 4, 7, 10], "wildcard": [3, 4, 7, 8, 9, 10, 13, 28], "express": [3, 4, 7, 10, 29], "concret": [3, 4, 7, 10], "ar": [3, 4, 7, 9, 10, 13, 15, 16, 21, 22, 25, 28, 32, 35], "close": [3, 4, 7, 10, 15, 16, 25, 35], "both": [3, 4, 7, 10, 21], "valid": [3, 4, 7, 9, 10, 14, 17, 21, 25], "choic": [3, 4, 7, 9, 10, 14, 15], "all": [3, 4, 5, 7, 9, 10, 13, 14, 15, 16, 17, 21, 22, 25, 28, 29, 32, 35], "hidden": [3, 4, 7, 10], "format": [3, 4, 7, 9, 10, 25], "A": [3, 7, 10, 13, 16, 17], "short": 3, "version": [3, 4, 6, 7, 10, 15, 21, 25, 33], "accept": [3, 28, 29], "e": [3, 4, 13, 28], "g": [3, 4, 13, 28], "json": [3, 35], "yaml": 3, "h": 3, "column": 3, "displai": [3, 7, 8], "return": [3, 4, 5, 7, 8, 9, 10, 13, 14, 15, 16, 17, 21, 22, 25, 26, 28, 29, 30, 32, 35], "default": [3, 4, 7, 9, 10, 13, 15, 17, 21, 25, 28, 29, 35], "fals": [3, 4, 7, 9, 10, 13, 15, 16, 21, 23, 28, 35], "local": [3, 4, 7, 10, 13], "do": [3, 4, 7, 10, 13, 21], "retriev": [3, 4, 7, 10, 13, 16, 21, 25, 35], "state": [3, 4, 6, 7, 10, 13, 28, 29, 33], "from": [3, 4, 7, 9, 10, 13, 14, 15, 16, 17, 21, 25, 28, 29, 33, 35], "": [3, 7, 16, 17, 21, 22, 25, 28, 32, 35], "sort": [3, 10, 22, 28], "v": 3, "verbos": [3, 7, 8, 13], "mode": [3, 8, 10, 28], "all_pit_seg": 3, "activ": [3, 4, 7, 10], "point": [3, 7, 10], "time": [3, 4, 10, 16, 21, 25, 28, 29, 35], "segment": [3, 7, 9, 25], "alloc": [3, 4], "node_id": [3, 4, 9, 14], "provid": [3, 4, 7, 9, 10, 15, 25, 28, 35], "how": [3, 10, 15, 21, 25, 28], "mani": [3, 4, 10, 21], "shard": [3, 4, 7, 9, 10, 25], "each": [3, 7, 8, 9, 10, 13, 16, 25, 28, 35], "data": [3, 7, 8, 10, 13, 17, 21, 28, 29, 35], "much": [3, 25], "disk": [3, 4, 7, 9, 10], "space": 3, "thei": [3, 10, 13, 21, 25], "us": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 17, 21, 22, 25, 28, 29, 35], "id": [3, 4, 7, 8, 9, 10, 14, 15, 21, 32], "limit": [3, 4, 7, 9, 10, 14, 28, 29], "byte": 3, "The": [3, 4, 5, 7, 8, 9, 10, 13, 16, 17, 21, 25, 28, 32, 33], "unit": 3, "which": [3, 4, 6, 7, 10, 13, 15, 16, 22, 25, 28, 35], "valu": [3, 4, 7, 10, 13, 15, 21, 22, 23, 28], "b": 3, "k": 3, "kb": 3, "m": 3, "mb": 3, "gb": 3, "t": [3, 9, 10, 16, 17, 21, 25, 35], "tb": 3, "p": 3, "pb": 3, "cluster_manager_timeout": [3, 4, 5, 6, 7, 8, 10, 13], "oper": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 17, 21, 25, 33, 35], "timeout": [3, 4, 5, 6, 7, 8, 9, 10, 13, 14, 15, 16, 17, 35], "deprec": [3, 4, 5, 6, 7, 8, 10, 13, 17], "master_timeout": [3, 4, 5, 6, 7, 8, 10, 13], "promot": [3, 4, 5, 7, 8], "inclus": [3, 4, 5, 8], "languag": [3, 4, 5, 8, 10], "instead": [3, 4, 5, 7, 8, 10, 21, 35], "master": [3, 4, 5, 6, 7, 8, 10, 13], "cluster_manag": [3, 6, 7, 10, 13], "count": [3, 10, 16, 28, 35], "quick": 3, "access": [3, 10, 22], "entir": [3, 10, 28], "individu": [3, 4, 10, 35], "fielddata": [3, 7, 9], "heap": 3, "memori": [3, 7, 10], "being": [3, 17, 21], "everi": [3, 10, 25], "output": [3, 8], "health": [3, 4], "concis": 3, "represent": [3, 10], "d": [3, 22, 28, 29], "micro": 3, "nano": 3, "set": [3, 4, 5, 7, 9, 10, 14, 15, 17, 21, 25, 28, 35], "disabl": [3, 15, 21], "timestamp": [3, 7], "true": [3, 4, 5, 7, 9, 10, 13, 15, 16, 19, 20, 21, 22, 24, 25, 27, 28, 29, 35], "number": [3, 4, 7, 9, 10, 13, 15, 16, 25, 28, 35], "primari": [3, 4, 7, 10, 25], "replica": [3, 10, 25], "size": [3, 4, 10, 13, 15, 28], "statu": [3, 4, 7, 13, 17, 35], "green": [3, 4, 7], "yellow": [3, 4, 7], "red": [3, 4, 7], "onli": [3, 4, 7, 9, 10, 13, 15, 16, 21, 25, 28, 29], "match": [3, 7, 10, 25, 28], "specifi": [3, 4, 5, 7, 9, 10, 14, 16, 21, 23, 25, 28, 35], "include_unloaded_seg": [3, 7], "If": [3, 4, 7, 10, 15, 16, 21, 25, 28, 32, 35], "stat": [3, 4, 7, 9, 10, 25], "load": [3, 7], "pri": 3, "nodeattr": 3, "custom": [3, 10, 15, 22, 25, 32, 35], "attribut": [3, 4, 10, 35], "basic": [3, 4, 10, 13], "statist": [3, 4, 7, 9, 10, 25], "perform": [3, 4, 7, 10, 13, 25, 28, 29, 35], "full_id": 3, "full": [3, 10], "shorten": 3, "doe": [3, 25, 33], "caus": [3, 7, 17, 21], "act": 3, "pending_task": [3, 4], "pend": 3, "pit_seg": 3, "bodi": [3, 4, 7, 8, 9, 10, 13, 15, 22, 28, 29, 32, 33, 35], "one": [3, 4, 7, 9, 10, 13, 16, 21, 33, 35], "pit": 3, "instal": 3, "across": [3, 16], "recoveri": [3, 7, 9, 25], "go": [3, 7, 25], "complet": [3, 7, 9, 10, 13, 14, 25], "active_onli": [3, 7], "ongo": [3, 7], "repositori": [3, 13, 37], "regist": [3, 25], "segment_repl": 3, "latest": [3, 15, 21, 25], "replic": [3, 7], "event": [3, 4], "completed_onli": 3, "low": [3, 4, 7, 9, 10, 25], "level": [3, 4, 7, 9, 10, 25], "an": [3, 4, 7, 9, 10, 13, 14, 15, 17, 21, 22, 25, 28, 29, 32, 33, 35], "view": [3, 10], "specif": [3, 4, 7, 9, 10, 21, 25, 32], "ignore_unavail": [3, 4, 7, 10, 13], "should": [3, 4, 7, 9, 10, 13, 14, 16, 35], "ignor": [3, 4, 7, 10, 13, 21, 28, 35], "when": [3, 4, 6, 7, 10, 15, 16, 17, 21, 22, 25, 28, 29, 35], "unavail": [3, 4, 7, 10, 13], "miss": [3, 4, 7, 10, 21], "execut": [3, 4, 7, 8, 10, 22, 25, 28, 29, 32, 35], "action": [3, 7, 9, 10, 13, 14, 16, 29, 32, 33], "leav": [3, 4, 7, 9, 10, 14], "empti": [3, 4, 7, 9, 10, 14, 21], "_local": [3, 4, 9, 14], "you": [3, 4, 7, 9, 10, 14, 21, 22, 25, 28, 35], "re": [3, 4, 9, 14, 35], "parent_task_id": [3, 14], "parent": [3, 14], "task_numb": [3, 14], "1": [3, 10, 14, 15, 16, 25, 28, 35], "templat": [3, 4, 7, 10, 25], "exist": [3, 4, 7, 10, 21, 25, 35], "thread_pool": [3, 9], "thread_pool_pattern": 3, "wide": 3, "thread": [3, 9, 15], "pool": [3, 15, 16, 35], "per": [3, 7, 10, 21, 35], "By": [3, 10, 21], "queue": [3, 9], "reject": 3, "regular": [3, 7], "multipli": 3, "clustercli": [4, 10], "allocation_explain": 4, "explan": [4, 7], "flag": [4, 17, 28, 35], "explain": [4, 7, 10, 33], "mean": [4, 10, 13, 25], "first": 4, "unassign": 4, "include_disk_info": 4, "usag": [4, 7, 9, 17], "include_yes_decis": 4, "ye": 4, "decis": 4, "delete_component_templ": 4, "delet": [4, 5, 6, 7, 8, 10, 13, 16, 21, 25, 28, 32, 33], "compon": 4, "delete_decommission_awar": 4, "decommiss": 4, "delete_voting_config_exclus": 4, "clear": [4, 7, 10, 25], "vote": 4, "config": [4, 17], "exclus": 4, "wait_for_remov": 4, "wait": [4, 7, 9, 10, 13, 14], "exclud": [4, 10, 28], "remov": [4, 6, 7, 10, 13, 16, 28, 33], "befor": [4, 7, 10, 13, 14, 15, 21, 25, 35], "delete_weighted_rout": 4, "weight": 4, "exists_component_templ": 4, "particular": [4, 7, 10], "get_component_templ": 4, "get_decommission_awar": 4, "awareness_attribute_nam": 4, "awar": [4, 16], "get_set": [4, 7, 25], "flat_set": [4, 7, 9], "flat": [4, 7, 9], "include_default": [4, 7], "get_weighted_rout": 4, "fetch": [4, 10, 32], "indici": 4, "awareness_attribut": 4, "requir": [4, 10, 23, 28], "wait_for_active_shard": [4, 7, 10], "until": [4, 7, 10, 13, 14, 25], "wait_for_ev": 4, "queu": 4, "given": [4, 7, 10, 16, 25], "prioriti": 4, "process": [4, 7, 9, 10, 16, 21, 25, 35], "immedi": [4, 21], "urgent": 4, "high": 4, "normal": [4, 7], "languid": 4, "wait_for_no_initializing_shard": 4, "initi": [4, 16, 35], "wait_for_no_relocating_shard": 4, "reloc": 4, "wait_for_nod": 4, "avail": [4, 10, 13, 15, 16, 17], "wait_for_statu": 4, "chang": [4, 6, 7, 10, 21, 25, 33], "creat": [4, 6, 7, 8, 10, 13, 16, 21, 22, 25, 32, 33, 35], "updat": [4, 7, 8, 10, 21, 25, 28, 29, 32, 33], "fail": [4, 10, 16, 17, 21, 25, 33, 35], "have": [4, 7, 10, 16, 21, 25, 28], "yet": [4, 25], "been": [4, 7, 10, 16], "post_voting_config_exclus": 4, "persist": [4, 15, 21], "mai": [4, 6, 7, 10], "also": [4, 7, 10, 13, 15, 16, 25, 35], "node_nam": 4, "put_component_templ": 4, "definit": [4, 7, 8, 10, 13, 25], "ad": [4, 7, 22, 28], "new": [4, 7, 10, 21, 25, 28, 29, 33, 35], "can": [4, 6, 7, 10, 14, 16, 21, 22, 23, 25, 28, 29], "replac": [4, 7, 28], "put_decommission_awar": 4, "awareness_attribute_valu": 4, "put_set": [4, 7, 25], "either": [4, 10, 15, 28], "transient": 4, "surviv": 4, "restart": 4, "put_weighted_rout": 4, "remote_info": 4, "rerout": 4, "allow": [4, 7, 8, 10, 25, 35], "manual": 4, "command": 4, "move": 4, "cancel": [4, 14], "dry_run": [4, 7], "simul": [4, 7, 8], "result": [4, 10, 13, 21, 22, 28, 32], "why": [4, 10], "cannot": [4, 25], "metric": [4, 7, 9, 10], "metadata": [4, 7, 10, 21], "retry_fail": 4, "retri": [4, 10, 17, 21, 33, 35], "block": [4, 7, 9, 10, 25], "due": 4, "too": [4, 7], "subsequ": [4, 10], "failur": [4, 7, 10, 16, 25, 35], "comprehens": 4, "_all": [4, 7, 9, 10], "routing_t": 4, "routing_nod": 4, "master_nod": 4, "cluster_manager_nod": 4, "string": [4, 7, 10, 15, 17, 28], "allow_no_indic": [4, 7, 10], "resolv": [4, 7, 10, 35], "wait_for_metadata_vers": 4, "equal": [4, 10], "greater": 4, "than": [4, 10, 16], "wait_for_timeout": 4, "maximum": [4, 10, 13, 15, 35], "out": [4, 21], "overview": 4, "dangling_indic": 5, "danglingindicescli": 5, "delete_dangling_index": 5, "index_uuid": 5, "uuid": 5, "accept_data_loss": 5, "must": [5, 7, 10, 25, 28, 29], "order": [5, 7, 10, 21, 28], "import_dangling_index": 5, "import": [5, 10, 25], "list_dangling_indic": 5, "featurescli": 6, "get_featur": 6, "feature_st": 6, "explicit": [6, 7, 10, 13], "reset_featur": 6, "reset": [6, 16, 35], "intern": [6, 7, 10, 28, 29], "usual": [6, 9], "system": [6, 7], "experiment": [6, 7, 10], "so": [6, 7, 10, 13, 21, 28, 29, 35], "break": [6, 7, 10], "futur": [6, 7, 10, 16], "indicescli": [7, 10], "add_block": 7, "add": [7, 15, 22, 25, 28, 33, 35], "read": [7, 13], "write": [7, 13], "read_onli": 7, "analyz": [7, 10, 13, 20, 25], "token": [7, 25], "breakdown": [7, 25], "defin": [7, 10, 25, 28, 29], "scope": 7, "clear_cach": [7, 25], "cach": [7, 10, 25, 28], "request": [7, 9, 10, 13, 14, 15, 16, 21, 22, 25, 28, 29, 35], "clone": [7, 13, 25, 28, 29], "target": [7, 25, 35], "accord": 7, "integ": [7, 10, 15], "option": [7, 10, 15, 16, 17, 21, 28, 29, 35], "create_data_stream": 7, "stream": 7, "data_streams_stat": 7, "happen": [7, 17, 25], "delete_alia": [7, 25], "support": [7, 8, 9, 10, 13, 22, 28, 35], "delete_data_stream": 7, "delete_index_templ": 7, "delete_templ": 7, "disk_usag": 7, "flush": [7, 9, 25], "run_expensive_task": 7, "exists_alia": [7, 25], "exists_index_templ": 7, "exists_templ": 7, "field_usage_stat": 7, "subset": 7, "forc": [7, 10, 16, 25], "even": [7, 10, 16], "necessarili": 7, "ie": [7, 10], "commit": 7, "transact": 7, "log": [7, 10, 15], "increment": [7, 10], "uncommit": 7, "present": [7, 22, 25], "consid": 7, "wait_if_ongo": 7, "anoth": [7, 10, 13, 21, 25], "alreadi": [7, 10, 21, 25, 33, 35], "skip": [7, 21], "iff": 7, "run": [7, 10, 13, 32], "flush_sync": 7, "sync": [7, 25], "forcemerg": [7, 25], "merg": [7, 9, 25], "after": [7, 10, 13, 16], "max_num_seg": 7, "dynam": 7, "only_expunge_delet": 7, "expung": 7, "freez": 7, "frozen": 7, "almost": 7, "overhead": [7, 10], "its": [7, 10, 15, 16, 21, 25, 35], "get_alia": [7, 25], "get_data_stream": 7, "get_field_map": [7, 25], "well": [7, 22, 35], "get_index_templ": 7, "get_map": [7, 25], "get_templ": 7, "get_upgrad": [7, 25], "progress": 7, "upgrad": [7, 25], "migrate_to_data_stream": 7, "migrat": [7, 28, 29], "promote_data_stream": 7, "ccr": 7, "put_alia": [7, 25], "put_index_templ": 7, "user": [7, 10, 15], "reason": 7, "put_map": [7, 25], "omit": [7, 21, 28, 29], "write_index_onli": 7, "appli": [7, 9, 10, 17, 28, 29], "preserve_exist": 7, "remain": 7, "unchang": [7, 21, 25, 35], "put_templ": 7, "multipl": [7, 10, 21, 25, 28, 29], "ones": [7, 28], "higher": 7, "later": [7, 25, 28, 29], "overrid": [7, 22, 25, 28, 29, 35], "lower": 7, "those": [7, 10, 13, 15, 21, 25], "refresh": [7, 9, 10, 21, 25], "reload_search_analyz": 7, "reload": [7, 9], "resourc": 7, "resolve_index": 7, "rollov": 7, "new_index": 7, "larg": [7, 10], "old": 7, "condit": 7, "met": 7, "actual": [7, 17, 28, 35], "newli": 7, "lucen": [7, 9, 10, 25], "shard_stor": [7, 25], "store": [7, 9, 10, 16, 25], "copi": [7, 10, 25, 28, 29], "status": 7, "shrink": [7, 25], "fewer": [7, 25], "copy_set": 7, "shrunken": 7, "simulate_index_templ": 7, "against": [7, 10], "dry": 7, "purpos": [7, 10], "we": [7, 10, 16, 28, 32, 35], "simulate_templ": 7, "split": 7, "query_cach": [7, 9], "request_cach": [7, 9, 10], "warmer": [7, 9], "suggest": [7, 9, 10, 28], "completion_field": [7, 9], "fielddata_field": [7, 9], "forbid_closed_indic": 7, "collect": [7, 10], "explicitli": [7, 10, 15, 16, 25, 35], "group": [7, 9, 14], "include_segment_file_s": [7, 9], "report": [7, 9, 25], "aggreg": [7, 9, 10, 22, 28], "file": [7, 9, 15], "type": [7, 9, 10, 22, 25, 28, 29], "unfreez": 7, "unfrozen": 7, "goe": 7, "through": [7, 14, 25], "becom": 7, "writeabl": 7, "again": 7, "update_alias": 7, "only_ancient_seg": 7, "ancient": 7, "older": 7, "major": 7, "wait_for_complet": [7, 10, 13, 14], "validate_queri": [7, 25], "potenti": [7, 10, 22, 25, 35], "expens": [7, 25], "without": [7, 10, 25, 28, 32, 35], "dsl": [7, 10, 19, 23, 24], "restrict": [7, 10], "all_shard": 7, "random": [7, 10, 13], "analyze_wildcard": [7, 10], "prefix": [7, 10, 15], "default_oper": [7, 10], "AND": [7, 10], "OR": [7, 10], "df": [7, 10], "where": [7, 10, 16, 17], "error": [7, 10, 17], "lenient": [7, 10], "numer": [7, 10], "q": [7, 10, 25], "syntax": [7, 10], "rewrit": [7, 10], "ingestcli": [8, 10], "delete_pipelin": 8, "pipelin": [8, 10], "get_pipelin": 8, "processor_grok": 8, "built": [8, 25], "pattern": [8, 13], "put_pipelin": 8, "exampl": [8, 10, 16, 25, 28, 29], "processor": 8, "nodescli": [9, 10], "hot_thread": 9, "hot": 9, "doc_typ": [9, 22, 28, 29], "sampl": 9, "cpu": 9, "ignore_idle_thread": 9, "don": [9, 10, 35], "known": 9, "idl": 9, "place": [9, 28, 29], "socket": 9, "select": [9, 16, 22, 28], "pull": 9, "interv": [9, 22], "second": [9, 10, 15, 16, 35], "stacktrac": 9, "10": [9, 10, 13, 15, 22], "3": [9, 15, 25, 28, 29, 35], "wish": [9, 21, 22], "o": 9, "jvm": 9, "http": [9, 10, 15, 17, 21, 25, 35], "reload_secure_set": 9, "object": [9, 10, 15, 16, 19, 22, 23, 24, 25, 26, 28, 29, 35], "contain": [9, 10, 15, 16, 23, 25, 28, 29, 35], "password": 9, "keystor": 9, "span": 9, "reinit": 9, "call": [9, 15, 16, 21, 25, 28, 29, 35], "stai": 9, "becaus": 9, "involv": [9, 10], "index_metr": 9, "breaker": 9, "f": [9, 29], "discoveri": 9, "indexing_pressur": 9, "isn": [9, 10, 35], "translog": 9, "rest": [9, 10, 21, 25], "rest_act": 9, "host": [10, 15, 16, 35], "transport_class": 10, "kwarg": [10, 15, 16, 21, 23, 25, 28, 29, 30, 35], "straightforward": 10, "endpoint": 10, "instanc": [10, 16, 21, 25, 28, 29, 35], "snapshotcli": [10, 13], "tasksclient": [10, 14], "respect": [10, 28, 29], "prefer": [10, 15], "wai": [10, 35], "method": [10, 15, 16, 22, 25, 28, 29, 35], "your": [10, 15, 22, 35], "own": [10, 16, 22], "connection_class": [10, 35], "localhost": [10, 15], "thriftconnect": 10, "want": [10, 28, 35], "turn": [10, 28], "snif": [10, 16, 35], "describ": 10, "automat": [10, 35], "inspect": 10, "opensearchnode1": 10, "opensearchnode2": 10, "sniff": [10, 35], "anyth": 10, "sniff_on_start": [10, 35], "respond": 10, "sniff_on_connection_fail": [10, 35], "60": [10, 16], "sniffer_timeout": [10, 35], "differ": [10, 21, 25, 28, 35], "dictionari": [10, 16, 21, 28, 29, 35], "directli": 10, "ssl": [10, 15, 17], "port": [10, 15], "443": 10, "url_prefix": [10, 15], "note": [10, 25, 28, 29], "int": 10, "othernod": 10, "use_ssl": [10, 15], "control": [10, 21, 28, 35], "deal": 10, "certif": [10, 15], "urllib3httpconnect": [10, 15, 35], "descript": [10, 22, 28], "other_host": 10, "make": [10, 21], "sure": 10, "verifi": [10, 13, 15], "verify_cert": [10, 15], "path": [10, 15], "ca": [10, 15], "cert": [10, 15], "ca_cert": [10, 15], "warn": [10, 15, 17], "messag": [10, 17, 32], "verif": [10, 15], "ssl_show_warn": [10, 15], "authent": 10, "pem": 10, "client_cert": [10, 15], "clientcert": 10, "kei": [10, 15, 25, 28, 35], "client_kei": [10, 15], "clientkei": 10, "altern": [10, 35], "rfc": 10, "1738": 10, "url": [10, 15, 35], "long": 10, "conflict": [10, 21], "other": [10, 15, 16, 25, 28], "secret": 10, "9200": [10, 15], "product": 10, "jsonseri": [10, 34, 35], "encod": 10, "outgo": 10, "howev": 10, "implement": [10, 15, 17], "setencod": 10, "def": [10, 22], "self": [10, 15, 16, 17, 21, 22, 26, 30], "obj": 10, "isinst": 10, "someth": 10, "customsomethingrepresent": 10, "singl": [10, 21, 25, 29], "pass": [10, 15, 16, 17, 21, 22, 25, 28, 35], "translat": 10, "subclass": [10, 16, 25, 35], "argument": [10, 21, 25, 28, 29, 35], "__repr__": [10, 15, 16, 21, 26, 30], "repr": [10, 15, 16, 21, 26, 30], "bulk": [10, 21], "pair": 10, "newlin": 10, "item": 10, "_sourc": [10, 28, 29], "overridden": [10, 28, 29, 35], "sub": 10, "_source_exclud": 10, "_source_includ": 10, "extract": [10, 35], "preprocess": 10, "incom": 10, "affect": 10, "visibl": [10, 21], "wait_for": 10, "noth": 10, "require_alia": 10, "unset": 10, "proceed": 10, "otherwis": [10, 21, 28], "non": [10, 17], "neg": 10, "less": 10, "total": [10, 13], "clear_scrol": 10, "scroll_id": 10, "context": 10, "scroll": 10, "wa": [10, 16, 17, 35], "via": [10, 16, 17], "ignore_throttl": 10, "throttl": 10, "min_scor": 10, "_score": 10, "terminate_aft": 10, "upon": [10, 16], "reach": 10, "termin": 10, "earli": [10, 13], "409": [10, 17], "same": [10, 13, 16, 21, 25, 28, 35], "concurr": [10, 13], "version_typ": 10, "extern": 10, "external_gt": 10, "create_pit": 10, "allow_partial_pit_cr": 10, "partial": [10, 21], "keep_al": 10, "keep": 10, "aliv": 10, "create_point_in_tim": 10, "live": [10, 16, 35], "if_primary_term": 10, "last": 10, "term": [10, 22, 25, 28, 29], "if_seq_no": 10, "sequenc": 10, "delete_all_pit": 10, "delete_by_queri": [10, 28], "what": [10, 13, 21], "hit": [10, 22, 28], "abort": [10, 13], "proce": 10, "offset": 10, "max_doc": 10, "effect": [10, 16, 21], "requests_per_second": 10, "consist": [10, 15], "scroll_siz": 10, "power": 10, "100": [10, 13, 28], "search_timeout": 10, "search_typ": 10, "query_then_fetch": 10, "dfs_query_then_fetch": 10, "pleas": 10, "slice": [10, 28], "divid": 10, "subtask": 10, "auto": 10, "direct": 10, "tag": 10, "1m": 10, "part": [10, 22, 35], "delete_by_query_rethrottl": 10, "task_id": [10, 14], "rethrottl": 10, "float": [10, 15], "delete_pit": 10, "delete_point_in_tim": 10, "delete_script": 10, "script": [10, 21, 28, 29], "realtim": 10, "stored_field": 10, "exists_sourc": 10, "doesn": [10, 16, 17, 21, 25], "field_cap": 10, "capabl": 10, "among": 10, "include_unmap": 10, "unmap": 10, "get_all_pit": 10, "get_script": 10, "get_script_context": 10, "get_script_languag": 10, "get_sourc": 10, "overwrit": [10, 13, 29], "op_typ": 10, "destin": [10, 32], "list_all_point_in_tim": 10, "mget": [10, 21], "identifi": [10, 35], "msearch": 10, "ccs_minimize_roundtrip": 10, "network": [10, 17], "round": [10, 16], "trip": 10, "minim": 10, "cross": 10, "max_concurrent_search": 10, "multi": [10, 21, 23], "max_concurrent_shard_request": 10, "impact": 10, "5": [10, 16, 22, 25], "pre_filter_shard_s": 10, "threshold": 10, "enforc": 10, "pre": 10, "roundtrip": 10, "prefilt": 10, "exce": 10, "significantli": 10, "date": 10, "mandatori": 10, "bound": [10, 28], "disjoint": 10, "rest_total_hits_as_int": 10, "render": 10, "typed_kei": 10, "msearch_templ": 10, "mtermvector": 10, "termvector": 10, "here": [10, 25], "least": 10, "resid": 10, "field_statist": 10, "sum": 10, "frequenc": 10, "unless": [10, 35], "payload": 10, "posit": 10, "real": [10, 25], "oppos": 10, "term_statist": 10, "ping": 10, "put_script": 10, "compil": 10, "rank_ev": 10, "evalu": 10, "qualiti": 10, "rank": 10, "over": [10, 16, 21, 25, 28, 29, 35], "typic": 10, "rate": 10, "reindex": 10, "prototyp": 10, "5m": 10, "reindex_rethrottl": 10, "render_search_templ": 10, "mustach": 10, "scripts_painless_execut": 10, "arbitrari": 10, "allow_partial_search_result": 10, "batched_reduce_s": 10, "reduc": [10, 25], "onc": 10, "coordin": 10, "protect": 10, "mechan": 10, "512": 10, "docvalue_field": 10, "docvalu": 10, "score": [10, 28], "comput": 10, "min_compatible_shard_nod": 10, "minimum": 10, "compat": 10, "success": [10, 15, 35], "seq_no_primary_term": 10, "modif": 10, "suggest_field": 10, "suggest_mod": 10, "popular": 10, "alwai": [10, 16], "suggest_s": 10, "suggest_text": 10, "track_scor": 10, "calcul": [10, 28], "track_total_hit": 10, "track": 10, "search_shard": 10, "would": [10, 16], "search_templ": 10, "profil": 10, "terms_enum": 10, "enum": 10, "discov": 10, "begin": 10, "It": [10, 15, 16, 35], "design": 10, "latenc": 10, "look": 10, "up": [10, 35], "scenario": 10, "beta": 10, "expect": 10, "max": 10, "suppli": [10, 15, 28, 29], "lang": [10, 28, 29], "painless": [10, 28], "retry_on_conflict": [10, 21], "occur": 10, "pick": 10, "made": [10, 15, 21], "update_by_query_rethrottl": 10, "remotecli": 11, "cleanup_repositori": 13, "stale": 13, "target_snapshot": 13, "create_repositori": 13, "creation": [13, 28, 29], "delete_repositori": 13, "unregist": 13, "snapshotmissingexcept": 13, "thrown": 13, "include_repositori": 13, "index_detail": 13, "found": [13, 21], "blob": 13, "get_repositori": 13, "repository_analyz": 13, "correct": 13, "blob_count": 13, "dure": [13, 16, 35], "test": 13, "summari": 13, "early_read_node_count": 13, "rare": [13, 35], "rare_action_prob": 13, "relev": 13, "2": [13, 16, 25, 28], "max_blob_s": 13, "1gb": 13, "100mb": 13, "10mb": 13, "max_total_data_s": 13, "1tb": 13, "100gb": 13, "probabl": 13, "take": [13, 15, 22, 29, 35], "02": 13, "rarely_abort_writ": 13, "read_node_count": 13, "seed": 13, "gener": [13, 28], "workload": 13, "30": 13, "restor": 13, "verify_repositori": 13, "group_bi": 14, "child": 14, "relationship": 14, "http_compress": 15, "opaque_id": 15, "hold": [15, 16, 25, 35], "main": [15, 35], "interfac": [15, 35], "perform_request": [15, 16, 35], "safe": 15, "hostnam": 15, "gzip": 15, "compress": 15, "send": [15, 21, 32], "x": 15, "opaqu": 15, "trace": 15, "__eq__": 15, "__hash__": 15, "hash": 15, "_raise_error": 15, "status_cod": [15, 17], "raw_data": 15, "content_typ": 15, "locat": [15, 16], "appropri": [15, 28], "rais": [15, 16, 17, 21, 35], "_raise_warn": 15, "warning_head": 15, "seen": 15, "iter": [15, 28], "static": 15, "default_ca_cert": 15, "bundl": 15, "standard": 15, "openssl": 15, "environ": [15, 35], "variabl": 15, "certifi": 15, "log_request_fail": 15, "full_url": 15, "durat": 15, "unsuccess": 15, "log_request_success": 15, "requestshttpconnect": 15, "http_auth": 15, "pool_maxs": 15, "librari": 15, "auth": 15, "tupl": [15, 16], "fall": [15, 16], "back": [15, 16], "improv": 15, "privat": 15, "session": 15, "ssl_version": 15, "ssl_assert_hostnam": 15, "ssl_assert_fingerprint": 15, "maxsiz": 15, "ssl_context": 15, "urllib3": 15, "protocol": 15, "readthedoc": 15, "io": 15, "en": 15, "html": 15, "instruct": 15, "sslv23": 15, "sslv2": 15, "sslv3": 15, "tlsv1": 15, "protocol_": 15, "constant": 15, "modul": 15, "exact": 15, "fingerprint": 15, "kept": 15, "4": [15, 25], "opt": [15, 16], "hostedtoolcach": 15, "7": 15, "17": 15, "x64": 15, "lib": 15, "python3": 15, "site": 15, "packag": [15, 17], "connectionpool": [16, 35], "dead_timeout": 16, "timeout_cutoff": 16, "selector_class": 16, "roundrobinselector": 16, "randomize_host": 16, "connectionselector": 16, "dead": [16, 35], "interact": 16, "drive": 16, "within": [16, 25], "along": [16, 35], "refer": [16, 37], "ask": 16, "get_connect": [16, 35], "connectionerror": [16, 17], "mark": [16, 35], "mark_dead": [16, 35], "put": 16, "n": [16, 17, 28], "row": 16, "exponenti": 16, "longer": 16, "formula": 16, "default_timeout": 16, "fail_count": 16, "resurrect": 16, "previous": [16, 35], "succe": 16, "retir": 16, "increas": 16, "consecut": [16, 28], "shuffl": 16, "arriv": 16, "avoid": 16, "dog": 16, "pile": 16, "tri": [16, 35], "elig": 16, "selector": 16, "choos": 16, "now": [16, 25], "mark_liv": 16, "healthi": 16, "counter": 16, "redeem": 16, "attempt": [16, 35], "simpl": 16, "In": [16, 21, 35], "init": [16, 21], "construct": [16, 22, 28, 29], "itself": 16, "host_info_callback": [16, 35], "zone": 16, "robin": 16, "authenticationexcept": 17, "transporterror": 17, "repres": [17, 22], "401": 17, "code": [17, 35], "authorizationexcept": 17, "403": 17, "conflicterror": 17, "while": [17, 25, 28], "talk": [17, 35], "origin": 17, "underli": [17, 25, 28, 29, 35], "__str__": 17, "str": 17, "connectiontimeout": 17, "improperlyconfigur": 17, "inconsist": 17, "invalid": 17, "notfounderror": [17, 21], "404": 17, "opensearchdeprecationwarn": 17, "opensearchwarn": 17, "opensearchexcept": 17, "incorrect": 17, "requesterror": 17, "400": 17, "serializationerror": 17, "properli": [17, 25], "sslerror": 17, "encount": [17, 25], "ok": 17, "Or": 17, "case": [17, 35], "properti": 17, "dict": [17, 19, 23, 24, 28, 29, 35], "precipit": 17, "applic": [17, 35], "opensearchdslexcept": 17, "opensearchdsl": 17, "illegaloper": 17, "unknowndslobject": 17, "validationexcept": 17, "valueerror": 17, "_expand__to_dot": [19, 20, 24, 27], "dslbase": [19, 20, 23, 24, 27], "to_dict": [19, 21, 23, 24, 28, 29], "plain": [19, 23, 24], "analysisbas": 20, "meta": 21, "objectbas": 21, "model": 21, "like": [21, 29, 35], "associ": [21, 25], "keyword": [21, 25, 28, 29, 35], "classmethod": [21, 28, 29], "check": 21, "popul": 21, "raise_on_error": 21, "save": [21, 25], "skip_empti": 21, "return_doc_meta": 21, "overwritten": 21, "left": 21, "strip": 21, "include_meta": 21, "_index": 21, "_id": 21, "etc": [21, 28], "just": 21, "detect_noop": 21, "doc_as_upsert": 21, "script_id": 21, "scripted_upsert": 21, "upsert": 21, "mydocu": 21, "titl": [21, 22, 25, 28], "noop": 21, "detect": 21, "between": [21, 35], "phase": 21, "possibl": [21, 35], "might": [21, 35], "final": 21, "throw": 21, "plu": 21, "content": 21, "facetedsearch": 22, "abstract": 22, "facet": 22, "navig": 22, "care": 22, "compos": 22, "easi": 22, "consum": 22, "fashion": 22, "blogsearch": 22, "blog": [22, 25], "post": [22, 25, 35], "categori": [22, 28], "termsfacet": 22, "_type": 22, "weekly_post": 22, "datehistogramfacet": 22, "published_from": 22, "week": 22, "super": 22, "publish": [22, 25, 28, 29], "blog_search": 22, "web": 22, "framework": 22, "pagin": [22, 28], "20": 22, "hit_count": 22, "is_select": 22, "print": 22, "chosen": 22, "els": 22, "add_filt": 22, "filter_valu": 22, "build_search": 22, "post_filt": 22, "narrow": 22, "highlight": [22, 28], "modifi": [22, 28, 29], "arg": [23, 25, 30], "bool": [23, 28, 29], "arrai": [23, 28], "scorefunct": 24, "my_analyz": 25, "trigram": 25, "ngram": 25, "min_gram": 25, "max_gram": 25, "lowercas": 25, "share": 25, "number_of_shard": 25, "i2": 25, "decor": 25, "deseri": [25, 35], "boolean": 25, "relat": [25, 35], "them": [25, 28, 35], "lost": 25, "continu": 25, "background": 25, "previou": [25, 28], "monitor": [25, 32], "insight": 25, "some": [25, 28], "done": 25, "belong": [25, 32], "number_of_replica": 25, "earlier": 25, "recent": 25, "engin": 25, "factor": 25, "8": 25, "shrunk": 25, "15": 25, "prime": 25, "updatebyqueri": [25, 29], "criteria": 25, "__getitem__": 28, "equat": 28, "25": 28, "equival": 28, "extra": [28, 35], "from_": 28, "__iter__": 28, "_clone": [28, 29], "shallow": [28, 29], "most": [28, 29], "collaps": 28, "inner_hit": 28, "max_concurrent_group_search": 28, "thu": 28, "chain": 28, "deleg": 28, "ignore_cach": 28, "wrap": [28, 29], "from_dict": [28, 29], "raw": [28, 29], "fragment_s": 28, "50": 28, "produc": [28, 35], "twice": 28, "highlight_opt": 28, "global": 28, "response_class": [28, 29], "cl": [28, 29], "scan": 28, "script_field": 28, "times_two": 28, "times_thre": 28, "price": 28, "asc": 28, "avg": 28, "descend": 28, "ascend": 28, "obj1": 28, "sent": [28, 29], "interest": 28, "update_from_dict": [28, 29], "mostli": [28, 29], "ubq": 29, "ctx": 29, "rang": 30, "attrdict": 30, "alertingcli": 32, "acknowledge_alert": 32, "monitor_id": 32, "acknowledg": 32, "create_destin": 32, "slack": 32, "mail": 32, "webhook": 32, "create_monitor": 32, "input": 32, "trigger": [32, 35], "delete_destin": 32, "destination_id": 32, "delete_monitor": 32, "get_alert": 32, "get_destin": 32, "get_monitor": 32, "run_monitor": 32, "dryrun": 32, "search_monitor": 32, "update_destin": 32, "update_monitor": 32, "index_manag": 33, "indexmanagementcli": 33, "add_polici": 33, "polici": 33, "change_polici": 33, "delete_polici": 33, "policy_id": 33, "explain_index": 33, "get_polici": 33, "put_polici": 33, "remove_policy_from_index": 33, "ism": 33, "whose": 33, "connection_pool_class": 35, "get_host_info": 35, "sniff_timeout": 35, "default_mimetyp": 35, "max_retri": 35, "retry_on_statu": 35, "502": 35, "503": 35, "504": 35, "retry_on_timeout": 35, "send_get_body_a": 35, "encapsul": 35, "logic": 35, "handl": 35, "instanti": 35, "callback": 35, "_cluster": 35, "obtain": 35, "startup": 35, "fast": 35, "quickli": 35, "Not": 35, "still": 35, "come": 35, "server": 35, "mimetyp": 35, "assum": 35, "propag": 35, "default_connection_class": 35, "_get_sniff_data": 35, "last_sniff": 35, "serv": 35, "_resolve_request_arg": 35, "add_connect": 35, "enabl": 35, "absolut": 35, "hand": 35, "set_connect": 35, "__init__": 35, "sniff_host": 35, "nodes_to_host_callback": 35, "develop": 37, "github": 37}, "objects": {"opensearchpy": [[17, 0, 1, "", "AuthenticationException"], [17, 0, 1, "", "AuthorizationException"], [17, 0, 1, "", "ConflictError"], [15, 0, 1, "", "Connection"], [17, 0, 1, "", "ConnectionError"], [16, 0, 1, "", "ConnectionPool"], [16, 0, 1, "", "ConnectionSelector"], [17, 0, 1, "", "ConnectionTimeout"], [17, 0, 1, "", "IllegalOperation"], [17, 0, 1, "", "ImproperlyConfigured"], [34, 0, 1, "", "JSONSerializer"], [17, 0, 1, "", "NotFoundError"], [10, 0, 1, "", "OpenSearch"], [17, 2, 1, "", "OpenSearchDeprecationWarning"], [17, 0, 1, "", "OpenSearchDslException"], [17, 0, 1, "", "OpenSearchException"], [17, 0, 1, "", "OpenSearchWarning"], [17, 0, 1, "", "RequestError"], [15, 0, 1, "", "RequestsHttpConnection"], [16, 0, 1, "", "RoundRobinSelector"], [17, 0, 1, "", "SSLError"], [17, 0, 1, "", "SerializationError"], [35, 0, 1, "", "Transport"], [17, 0, 1, "", "TransportError"], [17, 0, 1, "", "UnknownDslObject"], [15, 0, 1, "", "Urllib3HttpConnection"], [17, 0, 1, "", "ValidationException"], [15, 2, 1, "", "connections"]], "opensearchpy.Connection": [[15, 1, 1, "", "__eq__"], [15, 1, 1, "", "__hash__"], [15, 1, 1, "", "__repr__"], [15, 1, 1, "", "_raise_error"], [15, 1, 1, "", "_raise_warnings"], [15, 1, 1, "", "default_ca_certs"], [15, 1, 1, "", "log_request_fail"], [15, 1, 1, "", "log_request_success"]], "opensearchpy.ConnectionError": [[17, 1, 1, "", "__str__"]], "opensearchpy.ConnectionPool": [[16, 1, 1, "", "__repr__"], [16, 1, 1, "", "close"], [16, 1, 1, "", "get_connection"], [16, 1, 1, "", "mark_dead"], [16, 1, 1, "", "mark_live"], [16, 1, 1, "", "resurrect"]], "opensearchpy.ConnectionSelector": [[16, 1, 1, "", "select"]], "opensearchpy.ConnectionTimeout": [[17, 1, 1, "", "__str__"]], "opensearchpy.OpenSearch": [[10, 1, 1, "", "__repr__"], [10, 1, 1, "", "bulk"], [10, 1, 1, "", "clear_scroll"], [10, 1, 1, "", "close"], [10, 1, 1, "", "count"], [10, 1, 1, "", "create"], [10, 1, 1, "", "create_pit"], [10, 1, 1, "", "create_point_in_time"], [10, 1, 1, "", "delete"], [10, 1, 1, "", "delete_all_pits"], [10, 1, 1, "", "delete_by_query"], [10, 1, 1, "", "delete_by_query_rethrottle"], [10, 1, 1, "", "delete_pit"], [10, 1, 1, "", "delete_point_in_time"], [10, 1, 1, "", "delete_script"], [10, 1, 1, "", "exists"], [10, 1, 1, "", "exists_source"], [10, 1, 1, "", "explain"], [10, 1, 1, "", "field_caps"], [10, 1, 1, "", "get"], [10, 1, 1, "", "get_all_pits"], [10, 1, 1, "", "get_script"], [10, 1, 1, "", "get_script_context"], [10, 1, 1, "", "get_script_languages"], [10, 1, 1, "", "get_source"], [10, 1, 1, "", "index"], [10, 1, 1, "", "info"], [10, 1, 1, "", "list_all_point_in_time"], [10, 1, 1, "", "mget"], [10, 1, 1, "", "msearch"], [10, 1, 1, "", "msearch_template"], [10, 1, 1, "", "mtermvectors"], [10, 1, 1, "", "ping"], [10, 1, 1, "", "put_script"], [10, 1, 1, "", "rank_eval"], [10, 1, 1, "", "reindex"], [10, 1, 1, "", "reindex_rethrottle"], [10, 1, 1, "", "render_search_template"], [10, 1, 1, "", "scripts_painless_execute"], [10, 1, 1, "", "scroll"], [10, 1, 1, "", "search"], [10, 1, 1, "", "search_shards"], [10, 1, 1, "", "search_template"], [10, 1, 1, "", "terms_enum"], [10, 1, 1, "", "termvectors"], [10, 1, 1, "", "update"], [10, 1, 1, "", "update_by_query"], [10, 1, 1, "", "update_by_query_rethrottle"]], "opensearchpy.RequestsHttpConnection": [[15, 1, 1, "", "close"]], "opensearchpy.RoundRobinSelector": [[16, 1, 1, "", "select"]], "opensearchpy.Transport": [[35, 2, 1, "", "DEFAULT_CONNECTION_CLASS"], [35, 1, 1, "", "_get_sniff_data"], [35, 1, 1, "", "_resolve_request_args"], [35, 1, 1, "", "add_connection"], [35, 1, 1, "", "close"], [35, 1, 1, "", "get_connection"], [35, 1, 1, "", "mark_dead"], [35, 1, 1, "", "perform_request"], [35, 1, 1, "", "set_connections"], [35, 1, 1, "", "sniff_hosts"]], "opensearchpy.TransportError": [[17, 1, 1, "", "__str__"], [17, 3, 1, "", "error"], [17, 3, 1, "", "info"], [17, 3, 1, "", "status_code"]], "opensearchpy.Urllib3HttpConnection": [[15, 1, 1, "", "close"]], "opensearchpy.client.cat": [[3, 0, 1, "", "CatClient"]], "opensearchpy.client.cat.CatClient": [[3, 1, 1, "", "aliases"], [3, 1, 1, "", "all_pit_segments"], [3, 1, 1, "", "allocation"], [3, 1, 1, "", "cluster_manager"], [3, 1, 1, "", "count"], [3, 1, 1, "", "fielddata"], [3, 1, 1, "", "health"], [3, 1, 1, "", "help"], [3, 1, 1, "", "indices"], [3, 1, 1, "", "master"], [3, 1, 1, "", "nodeattrs"], [3, 1, 1, "", "nodes"], [3, 1, 1, "", "pending_tasks"], [3, 1, 1, "", "pit_segments"], [3, 1, 1, "", "plugins"], [3, 1, 1, "", "recovery"], [3, 1, 1, "", "repositories"], [3, 1, 1, "", "segment_replication"], [3, 1, 1, "", "segments"], [3, 1, 1, "", "shards"], [3, 1, 1, "", "snapshots"], [3, 1, 1, "", "tasks"], [3, 1, 1, "", "templates"], [3, 1, 1, "", "thread_pool"]], "opensearchpy.client.cluster": [[4, 0, 1, "", "ClusterClient"]], "opensearchpy.client.cluster.ClusterClient": [[4, 1, 1, "", "allocation_explain"], [4, 1, 1, "", "delete_component_template"], [4, 1, 1, "", "delete_decommission_awareness"], [4, 1, 1, "", "delete_voting_config_exclusions"], [4, 1, 1, "", "delete_weighted_routing"], [4, 1, 1, "", "exists_component_template"], [4, 1, 1, "", "get_component_template"], [4, 1, 1, "", "get_decommission_awareness"], [4, 1, 1, "", "get_settings"], [4, 1, 1, "", "get_weighted_routing"], [4, 1, 1, "", "health"], [4, 1, 1, "", "pending_tasks"], [4, 1, 1, "", "post_voting_config_exclusions"], [4, 1, 1, "", "put_component_template"], [4, 1, 1, "", "put_decommission_awareness"], [4, 1, 1, "", "put_settings"], [4, 1, 1, "", "put_weighted_routing"], [4, 1, 1, "", "remote_info"], [4, 1, 1, "", "reroute"], [4, 1, 1, "", "state"], [4, 1, 1, "", "stats"]], "opensearchpy.client.dangling_indices": [[5, 0, 1, "", "DanglingIndicesClient"]], "opensearchpy.client.dangling_indices.DanglingIndicesClient": [[5, 1, 1, "", "delete_dangling_index"], [5, 1, 1, "", "import_dangling_index"], [5, 1, 1, "", "list_dangling_indices"]], "opensearchpy.client.features": [[6, 0, 1, "", "FeaturesClient"]], "opensearchpy.client.features.FeaturesClient": [[6, 1, 1, "", "get_features"], [6, 1, 1, "", "reset_features"]], "opensearchpy.client.indices": [[7, 0, 1, "", "IndicesClient"]], "opensearchpy.client.indices.IndicesClient": [[7, 1, 1, "", "add_block"], [7, 1, 1, "", "analyze"], [7, 1, 1, "", "clear_cache"], [7, 1, 1, "", "clone"], [7, 1, 1, "", "close"], [7, 1, 1, "", "create"], [7, 1, 1, "", "create_data_stream"], [7, 1, 1, "", "data_streams_stats"], [7, 1, 1, "", "delete"], [7, 1, 1, "", "delete_alias"], [7, 1, 1, "", "delete_data_stream"], [7, 1, 1, "", "delete_index_template"], [7, 1, 1, "", "delete_template"], [7, 1, 1, "", "disk_usage"], [7, 1, 1, "", "exists"], [7, 1, 1, "", "exists_alias"], [7, 1, 1, "", "exists_index_template"], [7, 1, 1, "", "exists_template"], [7, 1, 1, "", "field_usage_stats"], [7, 1, 1, "", "flush"], [7, 1, 1, "", "flush_synced"], [7, 1, 1, "", "forcemerge"], [7, 1, 1, "", "freeze"], [7, 1, 1, "", "get"], [7, 1, 1, "", "get_alias"], [7, 1, 1, "", "get_data_stream"], [7, 1, 1, "", "get_field_mapping"], [7, 1, 1, "", "get_index_template"], [7, 1, 1, "", "get_mapping"], [7, 1, 1, "", "get_settings"], [7, 1, 1, "", "get_template"], [7, 1, 1, "", "get_upgrade"], [7, 1, 1, "", "migrate_to_data_stream"], [7, 1, 1, "", "open"], [7, 1, 1, "", "promote_data_stream"], [7, 1, 1, "", "put_alias"], [7, 1, 1, "", "put_index_template"], [7, 1, 1, "", "put_mapping"], [7, 1, 1, "", "put_settings"], [7, 1, 1, "", "put_template"], [7, 1, 1, "", "recovery"], [7, 1, 1, "", "refresh"], [7, 1, 1, "", "reload_search_analyzers"], [7, 1, 1, "", "resolve_index"], [7, 1, 1, "", "rollover"], [7, 1, 1, "", "segments"], [7, 1, 1, "", "shard_stores"], [7, 1, 1, "", "shrink"], [7, 1, 1, "", "simulate_index_template"], [7, 1, 1, "", "simulate_template"], [7, 1, 1, "", "split"], [7, 1, 1, "", "stats"], [7, 1, 1, "", "unfreeze"], [7, 1, 1, "", "update_aliases"], [7, 1, 1, "", "upgrade"], [7, 1, 1, "", "validate_query"]], "opensearchpy.client.ingest": [[8, 0, 1, "", "IngestClient"]], "opensearchpy.client.ingest.IngestClient": [[8, 1, 1, "", "delete_pipeline"], [8, 1, 1, "", "get_pipeline"], [8, 1, 1, "", "processor_grok"], [8, 1, 1, "", "put_pipeline"], [8, 1, 1, "", "simulate"]], "opensearchpy.client.nodes": [[9, 0, 1, "", "NodesClient"]], "opensearchpy.client.nodes.NodesClient": [[9, 1, 1, "", "hot_threads"], [9, 1, 1, "", "info"], [9, 1, 1, "", "reload_secure_settings"], [9, 1, 1, "", "stats"], [9, 1, 1, "", "usage"]], "opensearchpy.client.remote": [[11, 0, 1, "", "RemoteClient"]], "opensearchpy.client.snapshot": [[13, 0, 1, "", "SnapshotClient"]], "opensearchpy.client.snapshot.SnapshotClient": [[13, 1, 1, "", "cleanup_repository"], [13, 1, 1, "", "clone"], [13, 1, 1, "", "create"], [13, 1, 1, "", "create_repository"], [13, 1, 1, "", "delete"], [13, 1, 1, "", "delete_repository"], [13, 1, 1, "", "get"], [13, 1, 1, "", "get_repository"], [13, 1, 1, "", "repository_analyze"], [13, 1, 1, "", "restore"], [13, 1, 1, "", "status"], [13, 1, 1, "", "verify_repository"]], "opensearchpy.client.tasks": [[14, 0, 1, "", "TasksClient"]], "opensearchpy.client.tasks.TasksClient": [[14, 1, 1, "", "cancel"], [14, 1, 1, "", "get"], [14, 1, 1, "", "list"]], "opensearchpy.helpers.aggs": [[19, 0, 1, "", "Agg"]], "opensearchpy.helpers.aggs.Agg": [[19, 1, 1, "", "to_dict"]], "opensearchpy.helpers.analysis": [[20, 0, 1, "", "Analyzer"]], "opensearchpy.helpers.document": [[21, 0, 1, "", "Document"]], "opensearchpy.helpers.document.Document": [[21, 1, 1, "", "__repr__"], [21, 1, 1, "", "delete"], [21, 1, 1, "", "exists"], [21, 1, 1, "", "get"], [21, 1, 1, "", "init"], [21, 1, 1, "", "mget"], [21, 1, 1, "", "save"], [21, 1, 1, "", "search"], [21, 1, 1, "", "to_dict"], [21, 1, 1, "", "update"]], "opensearchpy.helpers.faceted_search": [[22, 0, 1, "", "FacetedSearch"]], "opensearchpy.helpers.faceted_search.FacetedSearch": [[22, 1, 1, "", "add_filter"], [22, 1, 1, "", "aggregate"], [22, 1, 1, "", "build_search"], [22, 1, 1, "", "execute"], [22, 1, 1, "", "filter"], [22, 1, 1, "", "highlight"], [22, 1, 1, "", "query"], [22, 1, 1, "", "search"], [22, 1, 1, "", "sort"]], "opensearchpy.helpers.field": [[23, 0, 1, "", "Field"]], "opensearchpy.helpers.field.Field": [[23, 1, 1, "", "to_dict"]], "opensearchpy.helpers.function": [[24, 0, 1, "", "ScoreFunction"]], "opensearchpy.helpers.function.ScoreFunction": [[24, 1, 1, "", "to_dict"]], "opensearchpy.helpers.index": [[25, 0, 1, "", "Index"]], "opensearchpy.helpers.index.Index": [[25, 1, 1, "", "aliases"], [25, 1, 1, "", "analyze"], [25, 1, 1, "", "analyzer"], [25, 1, 1, "", "clear_cache"], [25, 1, 1, "", "clone"], [25, 1, 1, "", "close"], [25, 1, 1, "", "create"], [25, 1, 1, "", "delete"], [25, 1, 1, "", "delete_alias"], [25, 1, 1, "", "document"], [25, 1, 1, "", "exists"], [25, 1, 1, "", "exists_alias"], [25, 1, 1, "", "flush"], [25, 1, 1, "", "forcemerge"], [25, 1, 1, "", "get"], [25, 1, 1, "", "get_alias"], [25, 1, 1, "", "get_field_mapping"], [25, 1, 1, "", "get_mapping"], [25, 1, 1, "", "get_settings"], [25, 1, 1, "", "get_upgrade"], [25, 1, 1, "", "mapping"], [25, 1, 1, "", "open"], [25, 1, 1, "", "put_alias"], [25, 1, 1, "", "put_mapping"], [25, 1, 1, "", "put_settings"], [25, 1, 1, "", "recovery"], [25, 1, 1, "", "refresh"], [25, 1, 1, "", "save"], [25, 1, 1, "", "search"], [25, 1, 1, "", "segments"], [25, 1, 1, "", "settings"], [25, 1, 1, "", "shard_stores"], [25, 1, 1, "", "shrink"], [25, 1, 1, "", "stats"], [25, 1, 1, "", "updateByQuery"], [25, 1, 1, "", "upgrade"], [25, 1, 1, "", "validate_query"]], "opensearchpy.helpers.mapping": [[26, 0, 1, "", "Mapping"]], "opensearchpy.helpers.mapping.Mapping": [[26, 1, 1, "", "__repr__"]], "opensearchpy.helpers.query": [[27, 0, 1, "", "Query"]], "opensearchpy.helpers.search": [[28, 0, 1, "", "Search"]], "opensearchpy.helpers.search.Search": [[28, 1, 1, "", "__getitem__"], [28, 1, 1, "", "__iter__"], [28, 1, 1, "", "_clone"], [28, 1, 1, "", "collapse"], [28, 1, 1, "", "count"], [28, 1, 1, "", "delete"], [28, 1, 1, "", "execute"], [28, 1, 1, "", "from_dict"], [28, 1, 1, "", "highlight"], [28, 1, 1, "", "highlight_options"], [28, 1, 1, "", "response_class"], [28, 1, 1, "", "scan"], [28, 1, 1, "", "script_fields"], [28, 1, 1, "", "sort"], [28, 1, 1, "", "source"], [28, 1, 1, "", "suggest"], [28, 1, 1, "", "to_dict"], [28, 1, 1, "", "update_from_dict"]], "opensearchpy.helpers.update_by_query": [[29, 0, 1, "", "UpdateByQuery"]], "opensearchpy.helpers.update_by_query.UpdateByQuery": [[29, 1, 1, "", "_clone"], [29, 1, 1, "", "execute"], [29, 1, 1, "", "from_dict"], [29, 1, 1, "", "response_class"], [29, 1, 1, "", "script"], [29, 1, 1, "", "to_dict"], [29, 1, 1, "", "update_from_dict"]], "opensearchpy.helpers.wrappers": [[30, 0, 1, "", "Range"]], "opensearchpy.helpers.wrappers.Range": [[30, 1, 1, "", "__repr__"]], "opensearchpy.plugins.alerting": [[32, 0, 1, "", "AlertingClient"]], "opensearchpy.plugins.alerting.AlertingClient": [[32, 1, 1, "", "acknowledge_alert"], [32, 1, 1, "", "create_destination"], [32, 1, 1, "", "create_monitor"], [32, 1, 1, "", "delete_destination"], [32, 1, 1, "", "delete_monitor"], [32, 1, 1, "", "get_alerts"], [32, 1, 1, "", "get_destination"], [32, 1, 1, "", "get_monitor"], [32, 1, 1, "", "run_monitor"], [32, 1, 1, "", "search_monitor"], [32, 1, 1, "", "update_destination"], [32, 1, 1, "", "update_monitor"]], "opensearchpy.plugins.index_management": [[33, 0, 1, "", "IndexManagementClient"]], "opensearchpy.plugins.index_management.IndexManagementClient": [[33, 1, 1, "", "add_policy"], [33, 1, 1, "", "change_policy"], [33, 1, 1, "", "delete_policy"], [33, 1, 1, "", "explain_index"], [33, 1, 1, "", "get_policy"], [33, 1, 1, "", "put_policy"], [33, 1, 1, "", "remove_policy_from_index"], [33, 1, 1, "", "retry"]]}, "objtypes": {"0": "py:class", "1": "py:method", "2": "py:attribute", "3": "py:property"}, "objnames": {"0": ["py", "class", "Python class"], "1": ["py", "method", "Python method"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "property", "Python property"]}, "titleterms": {"welcom": [0, 37], "user": [0, 37], "guid": [0, 37], "compat": [0, 37], "opensearch": [0, 2, 10, 37], "project": [0, 37], "resourc": [0, 37], "code": [0, 37], "conduct": [0, 37], "licens": [0, 37], "copyright": [0, 37], "api": 1, "refer": 1, "client": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 37], "within": 2, "compact": 3, "align": 3, "text": 3, "cat": 3, "cluster": 4, "dangl": 5, "indic": [5, 7], "featur": 6, "ingest": 8, "node": 9, "remot": 11, "secur": 12, "snapshot": 13, "task": 14, "connect": 15, "connection_pool": 16, "except": 17, "helper": 18, "agg": 19, "analysi": 20, "document": [21, 37], "faceted_search": 22, "field": 23, "function": 24, "index": [25, 33, 36], "map": 26, "queri": 27, "search": 28, "update_by_queri": 29, "wrapper": 30, "plugin": [31, 32, 33], "alert": 32, "manag": 33, "serial": 34, "transport": 35, "python": 37, "tabl": 37, "content": 37}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx.ext.todo": 2, "sphinx": 57}, "alltitles": {"Welcome!": [[0, "welcome"], [37, "welcome"]], "User Guide": [[0, "user-guide"], [37, "user-guide"]], "Compatibility with OpenSearch": [[0, "compatibility-with-opensearch"], [37, "compatibility-with-opensearch"]], "Project Resources": [[0, "project-resources"], [37, "project-resources"]], "Code of Conduct": [[0, "code-of-conduct"], [37, "code-of-conduct"]], "License": [[0, "license"], [37, "license"]], "Copyright": [[0, "copyright"], [37, "copyright"]], "API Reference": [[1, "api-reference"]], "Clients": [[2, "clients"]], "Clients within Opensearch": [[2, "clients-within-opensearch"]], "Compact and aligned text (CAT) Client": [[3, "compact-and-aligned-text-cat-client"]], "Cluster Client": [[4, "cluster-client"]], "Dangling Indices Client": [[5, "dangling-indices-client"]], "Features Client": [[6, "features-client"]], "Indices Client": [[7, "indices-client"]], "Ingest Client": [[8, "ingest-client"]], "Nodes Client": [[9, "nodes-client"]], "OpenSearch Client": [[10, "opensearch-client"]], "Remote Client": [[11, "remote-client"]], "Security Client": [[12, "security-client"]], "Snapshot Client": [[13, "snapshot-client"]], "Tasks Client": [[14, "tasks-client"]], "connection": [[15, "connection"]], "connection_pool": [[16, "connection-pool"]], "exceptions": [[17, "exceptions"]], "helpers": [[18, "helpers"]], "aggs": [[19, "aggs"]], "analysis": [[20, "analysis"]], "document": [[21, "document"]], "faceted_search": [[22, "faceted-search"]], "field": [[23, "field"]], "function": [[24, "function"]], "index": [[25, "index"]], "mapping": [[26, "mapping"]], "query": [[27, "query"]], "search": [[28, "search"]], "update_by_query": [[29, "update-by-query"]], "wrappers": [[30, "wrappers"]], "Plugins": [[31, "plugins"]], "Alerting Plugin": [[32, "alerting-plugin"]], "Index Management Plugin": [[33, "index-management-plugin"]], "serializer": [[34, "serializer"]], "transport": [[35, "transport"]], "Index": [[36, "index"]], "OpenSearch Python Client Documentation": [[37, "opensearch-python-client-documentation"]], "Table of Contents": [[37, "table-of-contents"]]}, "indexentries": {"catclient (class in opensearchpy.client.cat)": [[3, "opensearchpy.client.cat.CatClient"]], "aliases() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.aliases"]], "all_pit_segments() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.all_pit_segments"]], "allocation() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.allocation"]], "cluster_manager() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.cluster_manager"]], "count() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.count"]], "fielddata() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.fielddata"]], "health() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.health"]], "help() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.help"]], "indices() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.indices"]], "master() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.master"]], "nodeattrs() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.nodeattrs"]], "nodes() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.nodes"]], "pending_tasks() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.pending_tasks"]], "pit_segments() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.pit_segments"]], "plugins() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.plugins"]], "recovery() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.recovery"]], "repositories() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.repositories"]], "segment_replication() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.segment_replication"]], "segments() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.segments"]], "shards() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.shards"]], "snapshots() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.snapshots"]], "tasks() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.tasks"]], "templates() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.templates"]], "thread_pool() (opensearchpy.client.cat.catclient method)": [[3, "opensearchpy.client.cat.CatClient.thread_pool"]], "clusterclient (class in opensearchpy.client.cluster)": [[4, "opensearchpy.client.cluster.ClusterClient"]], "allocation_explain() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.allocation_explain"]], "delete_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.delete_component_template"]], "delete_decommission_awareness() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.delete_decommission_awareness"]], "delete_voting_config_exclusions() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.delete_voting_config_exclusions"]], "delete_weighted_routing() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.delete_weighted_routing"]], "exists_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.exists_component_template"]], "get_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.get_component_template"]], "get_decommission_awareness() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.get_decommission_awareness"]], "get_settings() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.get_settings"]], "get_weighted_routing() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.get_weighted_routing"]], "health() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.health"]], "pending_tasks() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.pending_tasks"]], "post_voting_config_exclusions() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.post_voting_config_exclusions"]], "put_component_template() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.put_component_template"]], "put_decommission_awareness() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.put_decommission_awareness"]], "put_settings() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.put_settings"]], "put_weighted_routing() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.put_weighted_routing"]], "remote_info() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.remote_info"]], "reroute() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.reroute"]], "state() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.state"]], "stats() (opensearchpy.client.cluster.clusterclient method)": [[4, "opensearchpy.client.cluster.ClusterClient.stats"]], "danglingindicesclient (class in opensearchpy.client.dangling_indices)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient"]], "delete_dangling_index() (opensearchpy.client.dangling_indices.danglingindicesclient method)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient.delete_dangling_index"]], "import_dangling_index() (opensearchpy.client.dangling_indices.danglingindicesclient method)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient.import_dangling_index"]], "list_dangling_indices() (opensearchpy.client.dangling_indices.danglingindicesclient method)": [[5, "opensearchpy.client.dangling_indices.DanglingIndicesClient.list_dangling_indices"]], "featuresclient (class in opensearchpy.client.features)": [[6, "opensearchpy.client.features.FeaturesClient"]], "get_features() (opensearchpy.client.features.featuresclient method)": [[6, "opensearchpy.client.features.FeaturesClient.get_features"]], "reset_features() (opensearchpy.client.features.featuresclient method)": [[6, "opensearchpy.client.features.FeaturesClient.reset_features"]], "indicesclient (class in opensearchpy.client.indices)": [[7, "opensearchpy.client.indices.IndicesClient"]], "add_block() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.add_block"]], "analyze() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.analyze"]], "clear_cache() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.clear_cache"]], "clone() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.clone"]], "close() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.close"]], "create() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.create"]], "create_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.create_data_stream"]], "data_streams_stats() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.data_streams_stats"]], "delete() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete"]], "delete_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_alias"]], "delete_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_data_stream"]], "delete_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_index_template"]], "delete_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.delete_template"]], "disk_usage() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.disk_usage"]], "exists() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists"]], "exists_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists_alias"]], "exists_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists_index_template"]], "exists_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.exists_template"]], "field_usage_stats() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.field_usage_stats"]], "flush() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.flush"]], "flush_synced() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.flush_synced"]], "forcemerge() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.forcemerge"]], "freeze() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.freeze"]], "get() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get"]], "get_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_alias"]], "get_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_data_stream"]], "get_field_mapping() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_field_mapping"]], "get_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_index_template"]], "get_mapping() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_mapping"]], "get_settings() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_settings"]], "get_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_template"]], "get_upgrade() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.get_upgrade"]], "migrate_to_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.migrate_to_data_stream"]], "open() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.open"]], "promote_data_stream() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.promote_data_stream"]], "put_alias() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_alias"]], "put_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_index_template"]], "put_mapping() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_mapping"]], "put_settings() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_settings"]], "put_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.put_template"]], "recovery() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.recovery"]], "refresh() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.refresh"]], "reload_search_analyzers() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.reload_search_analyzers"]], "resolve_index() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.resolve_index"]], "rollover() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.rollover"]], "segments() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.segments"]], "shard_stores() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.shard_stores"]], "shrink() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.shrink"]], "simulate_index_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.simulate_index_template"]], "simulate_template() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.simulate_template"]], "split() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.split"]], "stats() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.stats"]], "unfreeze() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.unfreeze"]], "update_aliases() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.update_aliases"]], "upgrade() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.upgrade"]], "validate_query() (opensearchpy.client.indices.indicesclient method)": [[7, "opensearchpy.client.indices.IndicesClient.validate_query"]], "ingestclient (class in opensearchpy.client.ingest)": [[8, "opensearchpy.client.ingest.IngestClient"]], "delete_pipeline() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.delete_pipeline"]], "get_pipeline() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.get_pipeline"]], "processor_grok() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.processor_grok"]], "put_pipeline() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.put_pipeline"]], "simulate() (opensearchpy.client.ingest.ingestclient method)": [[8, "opensearchpy.client.ingest.IngestClient.simulate"]], "nodesclient (class in opensearchpy.client.nodes)": [[9, "opensearchpy.client.nodes.NodesClient"]], "hot_threads() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.hot_threads"]], "info() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.info"]], "reload_secure_settings() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.reload_secure_settings"]], "stats() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.stats"]], "usage() (opensearchpy.client.nodes.nodesclient method)": [[9, "opensearchpy.client.nodes.NodesClient.usage"]], "opensearch (class in opensearchpy)": [[10, "opensearchpy.OpenSearch"]], "__repr__() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.__repr__"]], "bulk() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.bulk"]], "clear_scroll() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.clear_scroll"]], "close() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.close"]], "count() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.count"]], "create() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.create"]], "create_pit() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.create_pit"]], "create_point_in_time() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.create_point_in_time"]], "delete() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete"]], "delete_all_pits() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_all_pits"]], "delete_by_query() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_by_query"]], "delete_by_query_rethrottle() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_by_query_rethrottle"]], "delete_pit() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_pit"]], "delete_point_in_time() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_point_in_time"]], "delete_script() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.delete_script"]], "exists() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.exists"]], "exists_source() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.exists_source"]], "explain() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.explain"]], "field_caps() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.field_caps"]], "get() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get"]], "get_all_pits() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_all_pits"]], "get_script() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_script"]], "get_script_context() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_script_context"]], "get_script_languages() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_script_languages"]], "get_source() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.get_source"]], "index() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.index"]], "info() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.info"]], "list_all_point_in_time() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.list_all_point_in_time"]], "mget() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.mget"]], "msearch() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.msearch"]], "msearch_template() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.msearch_template"]], "mtermvectors() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.mtermvectors"]], "ping() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.ping"]], "put_script() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.put_script"]], "rank_eval() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.rank_eval"]], "reindex() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.reindex"]], "reindex_rethrottle() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.reindex_rethrottle"]], "render_search_template() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.render_search_template"]], "scripts_painless_execute() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.scripts_painless_execute"]], "scroll() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.scroll"]], "search() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.search"]], "search_shards() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.search_shards"]], "search_template() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.search_template"]], "terms_enum() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.terms_enum"]], "termvectors() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.termvectors"]], "update() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.update"]], "update_by_query() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.update_by_query"]], "update_by_query_rethrottle() (opensearchpy.opensearch method)": [[10, "opensearchpy.OpenSearch.update_by_query_rethrottle"]], "remoteclient (class in opensearchpy.client.remote)": [[11, "opensearchpy.client.remote.RemoteClient"]], "snapshotclient (class in opensearchpy.client.snapshot)": [[13, "opensearchpy.client.snapshot.SnapshotClient"]], "cleanup_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.cleanup_repository"]], "clone() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.clone"]], "create() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.create"]], "create_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.create_repository"]], "delete() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.delete"]], "delete_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.delete_repository"]], "get() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.get"]], "get_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.get_repository"]], "repository_analyze() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.repository_analyze"]], "restore() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.restore"]], "status() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.status"]], "verify_repository() (opensearchpy.client.snapshot.snapshotclient method)": [[13, "opensearchpy.client.snapshot.SnapshotClient.verify_repository"]], "tasksclient (class in opensearchpy.client.tasks)": [[14, "opensearchpy.client.tasks.TasksClient"]], "cancel() (opensearchpy.client.tasks.tasksclient method)": [[14, "opensearchpy.client.tasks.TasksClient.cancel"]], "get() (opensearchpy.client.tasks.tasksclient method)": [[14, "opensearchpy.client.tasks.TasksClient.get"]], "list() (opensearchpy.client.tasks.tasksclient method)": [[14, "opensearchpy.client.tasks.TasksClient.list"]], "connection (class in opensearchpy)": [[15, "opensearchpy.Connection"]], "requestshttpconnection (class in opensearchpy)": [[15, "opensearchpy.RequestsHttpConnection"]], "urllib3httpconnection (class in opensearchpy)": [[15, "opensearchpy.Urllib3HttpConnection"]], "__eq__() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.__eq__"]], "__hash__() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.__hash__"]], "__repr__() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.__repr__"]], "_raise_error() (opensearchpy.connection method)": [[15, "opensearchpy.Connection._raise_error"]], "_raise_warnings() (opensearchpy.connection method)": [[15, "opensearchpy.Connection._raise_warnings"]], "close() (opensearchpy.requestshttpconnection method)": [[15, "opensearchpy.RequestsHttpConnection.close"]], "close() (opensearchpy.urllib3httpconnection method)": [[15, "opensearchpy.Urllib3HttpConnection.close"]], "connections (in module opensearchpy)": [[15, "opensearchpy.connections"]], "default_ca_certs() (opensearchpy.connection static method)": [[15, "opensearchpy.Connection.default_ca_certs"]], "log_request_fail() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.log_request_fail"]], "log_request_success() (opensearchpy.connection method)": [[15, "opensearchpy.Connection.log_request_success"]], "connectionpool (class in opensearchpy)": [[16, "opensearchpy.ConnectionPool"]], "connectionselector (class in opensearchpy)": [[16, "opensearchpy.ConnectionSelector"]], "roundrobinselector (class in opensearchpy)": [[16, "opensearchpy.RoundRobinSelector"]], "__repr__() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.__repr__"]], "close() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.close"]], "get_connection() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.get_connection"]], "mark_dead() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.mark_dead"]], "mark_live() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.mark_live"]], "resurrect() (opensearchpy.connectionpool method)": [[16, "opensearchpy.ConnectionPool.resurrect"]], "select() (opensearchpy.connectionselector method)": [[16, "opensearchpy.ConnectionSelector.select"]], "select() (opensearchpy.roundrobinselector method)": [[16, "opensearchpy.RoundRobinSelector.select"]], "authenticationexception (class in opensearchpy)": [[17, "opensearchpy.AuthenticationException"]], "authorizationexception (class in opensearchpy)": [[17, "opensearchpy.AuthorizationException"]], "conflicterror (class in opensearchpy)": [[17, "opensearchpy.ConflictError"]], "connectionerror (class in opensearchpy)": [[17, "opensearchpy.ConnectionError"]], "connectiontimeout (class in opensearchpy)": [[17, "opensearchpy.ConnectionTimeout"]], "illegaloperation (class in opensearchpy)": [[17, "opensearchpy.IllegalOperation"]], "improperlyconfigured (class in opensearchpy)": [[17, "opensearchpy.ImproperlyConfigured"]], "notfounderror (class in opensearchpy)": [[17, "opensearchpy.NotFoundError"]], "opensearchdeprecationwarning (in module opensearchpy)": [[17, "opensearchpy.OpenSearchDeprecationWarning"]], "opensearchdslexception (class in opensearchpy)": [[17, "opensearchpy.OpenSearchDslException"]], "opensearchexception (class in opensearchpy)": [[17, "opensearchpy.OpenSearchException"]], "opensearchwarning (class in opensearchpy)": [[17, "opensearchpy.OpenSearchWarning"]], "requesterror (class in opensearchpy)": [[17, "opensearchpy.RequestError"]], "sslerror (class in opensearchpy)": [[17, "opensearchpy.SSLError"]], "serializationerror (class in opensearchpy)": [[17, "opensearchpy.SerializationError"]], "transporterror (class in opensearchpy)": [[17, "opensearchpy.TransportError"]], "unknowndslobject (class in opensearchpy)": [[17, "opensearchpy.UnknownDslObject"]], "validationexception (class in opensearchpy)": [[17, "opensearchpy.ValidationException"]], "__str__() (opensearchpy.connectionerror method)": [[17, "opensearchpy.ConnectionError.__str__"]], "__str__() (opensearchpy.connectiontimeout method)": [[17, "opensearchpy.ConnectionTimeout.__str__"]], "__str__() (opensearchpy.transporterror method)": [[17, "opensearchpy.TransportError.__str__"]], "error (opensearchpy.transporterror property)": [[17, "opensearchpy.TransportError.error"]], "info (opensearchpy.transporterror property)": [[17, "opensearchpy.TransportError.info"]], "status_code (opensearchpy.transporterror property)": [[17, "opensearchpy.TransportError.status_code"]], "agg (class in opensearchpy.helpers.aggs)": [[19, "opensearchpy.helpers.aggs.Agg"]], "to_dict() (opensearchpy.helpers.aggs.agg method)": [[19, "opensearchpy.helpers.aggs.Agg.to_dict"]], "analyzer (class in opensearchpy.helpers.analysis)": [[20, "opensearchpy.helpers.analysis.Analyzer"]], "document (class in opensearchpy.helpers.document)": [[21, "opensearchpy.helpers.document.Document"]], "__repr__() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.__repr__"]], "delete() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.delete"]], "exists() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.exists"]], "get() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.get"]], "init() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.init"]], "mget() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.mget"]], "save() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.save"]], "search() (opensearchpy.helpers.document.document class method)": [[21, "opensearchpy.helpers.document.Document.search"]], "to_dict() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.to_dict"]], "update() (opensearchpy.helpers.document.document method)": [[21, "opensearchpy.helpers.document.Document.update"]], "facetedsearch (class in opensearchpy.helpers.faceted_search)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch"]], "add_filter() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.add_filter"]], "aggregate() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.aggregate"]], "build_search() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.build_search"]], "execute() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.execute"]], "filter() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.filter"]], "highlight() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.highlight"]], "query() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.query"]], "search() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.search"]], "sort() (opensearchpy.helpers.faceted_search.facetedsearch method)": [[22, "opensearchpy.helpers.faceted_search.FacetedSearch.sort"]], "field (class in opensearchpy.helpers.field)": [[23, "opensearchpy.helpers.field.Field"]], "to_dict() (opensearchpy.helpers.field.field method)": [[23, "opensearchpy.helpers.field.Field.to_dict"]], "scorefunction (class in opensearchpy.helpers.function)": [[24, "opensearchpy.helpers.function.ScoreFunction"]], "to_dict() (opensearchpy.helpers.function.scorefunction method)": [[24, "opensearchpy.helpers.function.ScoreFunction.to_dict"]], "index (class in opensearchpy.helpers.index)": [[25, "opensearchpy.helpers.index.Index"]], "aliases() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.aliases"]], "analyze() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.analyze"]], "analyzer() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.analyzer"]], "clear_cache() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.clear_cache"]], "clone() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.clone"]], "close() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.close"]], "create() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.create"]], "delete() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.delete"]], "delete_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.delete_alias"]], "document() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.document"]], "exists() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.exists"]], "exists_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.exists_alias"]], "flush() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.flush"]], "forcemerge() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.forcemerge"]], "get() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get"]], "get_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_alias"]], "get_field_mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_field_mapping"]], "get_mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_mapping"]], "get_settings() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_settings"]], "get_upgrade() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.get_upgrade"]], "mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.mapping"]], "open() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.open"]], "put_alias() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.put_alias"]], "put_mapping() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.put_mapping"]], "put_settings() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.put_settings"]], "recovery() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.recovery"]], "refresh() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.refresh"]], "save() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.save"]], "search() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.search"]], "segments() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.segments"]], "settings() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.settings"]], "shard_stores() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.shard_stores"]], "shrink() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.shrink"]], "stats() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.stats"]], "updatebyquery() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.updateByQuery"]], "upgrade() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.upgrade"]], "validate_query() (opensearchpy.helpers.index.index method)": [[25, "opensearchpy.helpers.index.Index.validate_query"]], "mapping (class in opensearchpy.helpers.mapping)": [[26, "opensearchpy.helpers.mapping.Mapping"]], "__repr__() (opensearchpy.helpers.mapping.mapping method)": [[26, "opensearchpy.helpers.mapping.Mapping.__repr__"]], "query (class in opensearchpy.helpers.query)": [[27, "opensearchpy.helpers.query.Query"]], "search (class in opensearchpy.helpers.search)": [[28, "opensearchpy.helpers.search.Search"]], "__getitem__() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.__getitem__"]], "__iter__() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.__iter__"]], "_clone() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search._clone"]], "collapse() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.collapse"]], "count() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.count"]], "delete() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.delete"]], "execute() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.execute"]], "from_dict() (opensearchpy.helpers.search.search class method)": [[28, "opensearchpy.helpers.search.Search.from_dict"]], "highlight() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.highlight"]], "highlight_options() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.highlight_options"]], "response_class() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.response_class"]], "scan() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.scan"]], "script_fields() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.script_fields"]], "sort() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.sort"]], "source() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.source"]], "suggest() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.suggest"]], "to_dict() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.to_dict"]], "update_from_dict() (opensearchpy.helpers.search.search method)": [[28, "opensearchpy.helpers.search.Search.update_from_dict"]], "updatebyquery (class in opensearchpy.helpers.update_by_query)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery"]], "_clone() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery._clone"]], "execute() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.execute"]], "from_dict() (opensearchpy.helpers.update_by_query.updatebyquery class method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.from_dict"]], "response_class() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.response_class"]], "script() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.script"]], "to_dict() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.to_dict"]], "update_from_dict() (opensearchpy.helpers.update_by_query.updatebyquery method)": [[29, "opensearchpy.helpers.update_by_query.UpdateByQuery.update_from_dict"]], "range (class in opensearchpy.helpers.wrappers)": [[30, "opensearchpy.helpers.wrappers.Range"]], "__repr__() (opensearchpy.helpers.wrappers.range method)": [[30, "opensearchpy.helpers.wrappers.Range.__repr__"]], "alertingclient (class in opensearchpy.plugins.alerting)": [[32, "opensearchpy.plugins.alerting.AlertingClient"]], "acknowledge_alert() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.acknowledge_alert"]], "create_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.create_destination"]], "create_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.create_monitor"]], "delete_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.delete_destination"]], "delete_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.delete_monitor"]], "get_alerts() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.get_alerts"]], "get_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.get_destination"]], "get_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.get_monitor"]], "run_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.run_monitor"]], "search_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.search_monitor"]], "update_destination() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.update_destination"]], "update_monitor() (opensearchpy.plugins.alerting.alertingclient method)": [[32, "opensearchpy.plugins.alerting.AlertingClient.update_monitor"]], "indexmanagementclient (class in opensearchpy.plugins.index_management)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient"]], "add_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.add_policy"]], "change_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.change_policy"]], "delete_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.delete_policy"]], "explain_index() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.explain_index"]], "get_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.get_policy"]], "put_policy() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.put_policy"]], "remove_policy_from_index() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.remove_policy_from_index"]], "retry() (opensearchpy.plugins.index_management.indexmanagementclient method)": [[33, "opensearchpy.plugins.index_management.IndexManagementClient.retry"]], "jsonserializer (class in opensearchpy)": [[34, "opensearchpy.JSONSerializer"]], "default_connection_class (opensearchpy.transport attribute)": [[35, "opensearchpy.Transport.DEFAULT_CONNECTION_CLASS"]], "transport (class in opensearchpy)": [[35, "opensearchpy.Transport"]], "_get_sniff_data() (opensearchpy.transport method)": [[35, "opensearchpy.Transport._get_sniff_data"]], "_resolve_request_args() (opensearchpy.transport method)": [[35, "opensearchpy.Transport._resolve_request_args"]], "add_connection() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.add_connection"]], "close() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.close"]], "get_connection() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.get_connection"]], "mark_dead() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.mark_dead"]], "perform_request() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.perform_request"]], "set_connections() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.set_connections"]], "sniff_hosts() (opensearchpy.transport method)": [[35, "opensearchpy.Transport.sniff_hosts"]]}}) \ No newline at end of file