Skip to content

Commit

Permalink
deploy: 80b9681
Browse files Browse the repository at this point in the history
  • Loading branch information
@VachaShah
VachaShah committed Oct 3, 2023
1 parent 6c6b382 commit dc1a5bb
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 112 deletions.
118 changes: 62 additions & 56 deletions _modules/opensearchpy/client/nodes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,16 @@ <h1>Source code for opensearchpy.client.nodes</h1><div class="highlight"><pre>
<span class="c1"># under the License.</span>


<span class="c1"># ----------------------------------------------------</span>
<span class="c1"># THIS CODE IS GENERATED AND MANUAL EDITS WILL BE LOST.</span>
<span class="c1">#</span>
<span class="c1"># To contribute, kindly make essential modifications through either the &quot;opensearch-py client generator&quot;:</span>
<span class="c1"># https://github.com/opensearch-project/opensearch-py/blob/main/utils/generate-api.py</span>
<span class="c1"># or the &quot;OpenSearch API specification&quot; available at:</span>
<span class="c1"># https://github.com/opensearch-project/opensearch-api-specification/blob/main/OpenSearch.openapi.json</span>
<span class="c1"># -----------------------------------------------------</span>


<span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">NamespacedClient</span><span class="p">,</span> <span class="n">_make_path</span><span class="p">,</span> <span class="n">query_params</span>


Expand All @@ -120,12 +130,12 @@ <h1>Source code for opensearchpy.client.nodes</h1><div class="highlight"><pre>
<span class="sd"> Reloads secure settings.</span>


<span class="sd"> :arg body: An object containing the password for the</span>
<span class="sd"> opensearch keystore</span>
<span class="sd"> :arg node_id: A comma-separated list of node IDs to span the</span>
<span class="sd"> :arg body: An object containing the password for the opensearch</span>
<span class="sd"> keystore</span>
<span class="sd"> :arg node_id: Comma-separated list of node IDs to span the</span>
<span class="sd"> reload/reinit call. Should stay empty because reloading usually involves</span>
<span class="sd"> all cluster nodes.</span>
<span class="sd"> :arg timeout: Explicit operation timeout</span>
<span class="sd"> :arg timeout: Operation timeout.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">perform_request</span><span class="p">(</span>
<span class="s2">&quot;POST&quot;</span><span class="p">,</span>
Expand All @@ -141,16 +151,16 @@ <h1>Source code for opensearchpy.client.nodes</h1><div class="highlight"><pre>
<span class="sd"> Returns information about nodes in the cluster.</span>


<span class="sd"> :arg node_id: A comma-separated list of node IDs or names to</span>
<span class="sd"> limit the returned information; use `_local` to return information from</span>
<span class="sd"> the node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes</span>
<span class="sd"> :arg metric: A comma-separated list of metrics you wish</span>
<span class="sd"> returned. Leave empty to return all. Valid choices: settings, os,</span>
<span class="sd"> process, jvm, thread_pool, transport, http, plugins, ingest</span>
<span class="sd"> :arg flat_settings: Return settings in flat format (default:</span>
<span class="sd"> :arg node_id: Comma-separated list of node IDs or names to limit</span>
<span class="sd"> the returned information; use `_local` to return information from the</span>
<span class="sd"> node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes.</span>
<span class="sd"> :arg metric: Comma-separated list of metrics you wish returned.</span>
<span class="sd"> Leave empty to return all. Valid choices: settings, os, process, jvm,</span>
<span class="sd"> thread_pool, transport, http, plugins, ingest</span>
<span class="sd"> :arg flat_settings: Return settings in flat format. (default:</span>
<span class="sd"> false)</span>
<span class="sd"> :arg timeout: Explicit operation timeout</span>
<span class="sd"> :arg timeout: Operation timeout.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">perform_request</span><span class="p">(</span>
<span class="s2">&quot;GET&quot;</span><span class="p">,</span> <span class="n">_make_path</span><span class="p">(</span><span class="s2">&quot;_nodes&quot;</span><span class="p">,</span> <span class="n">node_id</span><span class="p">,</span> <span class="n">metric</span><span class="p">),</span> <span class="n">params</span><span class="o">=</span><span class="n">params</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span>
Expand All @@ -162,7 +172,6 @@ <h1>Source code for opensearchpy.client.nodes</h1><div class="highlight"><pre>
<span class="s2">&quot;fields&quot;</span><span class="p">,</span>
<span class="s2">&quot;groups&quot;</span><span class="p">,</span>
<span class="s2">&quot;include_segment_file_sizes&quot;</span><span class="p">,</span>
<span class="s2">&quot;include_unloaded_segments&quot;</span><span class="p">,</span>
<span class="s2">&quot;level&quot;</span><span class="p">,</span>
<span class="s2">&quot;timeout&quot;</span><span class="p">,</span>
<span class="s2">&quot;types&quot;</span><span class="p">,</span>
Expand All @@ -174,37 +183,34 @@ <h1>Source code for opensearchpy.client.nodes</h1><div class="highlight"><pre>
<span class="sd"> Returns statistical information about nodes in the cluster.</span>


<span class="sd"> :arg node_id: A comma-separated list of node IDs or names to</span>
<span class="sd"> limit the returned information; use `_local` to return information from</span>
<span class="sd"> the node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes</span>
<span class="sd"> :arg node_id: Comma-separated list of node IDs or names to limit</span>
<span class="sd"> the returned information; use `_local` to return information from the</span>
<span class="sd"> node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes.</span>
<span class="sd"> :arg metric: Limit the information returned to the specified</span>
<span class="sd"> metrics Valid choices: _all, breaker, fs, http, indices, jvm, os,</span>
<span class="sd"> metrics. Valid choices: _all, breaker, fs, http, indices, jvm, os,</span>
<span class="sd"> process, thread_pool, transport, discovery, indexing_pressure</span>
<span class="sd"> :arg index_metric: Limit the information returned for `indices`</span>
<span class="sd"> metric to the specific index metrics. Isn&#39;t used if `indices` (or `all`)</span>
<span class="sd"> metric isn&#39;t specified. Valid choices: _all, completion, docs,</span>
<span class="sd"> fielddata, query_cache, flush, get, indexing, merge, request_cache,</span>
<span class="sd"> refresh, search, segments, store, warmer, suggest</span>
<span class="sd"> :arg completion_fields: A comma-separated list of fields for</span>
<span class="sd"> `fielddata` and `suggest` index metric (supports wildcards)</span>
<span class="sd"> :arg fielddata_fields: A comma-separated list of fields for</span>
<span class="sd"> `fielddata` index metric (supports wildcards)</span>
<span class="sd"> :arg fields: A comma-separated list of fields for `fielddata`</span>
<span class="sd"> and `completion` index metric (supports wildcards)</span>
<span class="sd"> :arg groups: A comma-separated list of search groups for</span>
<span class="sd"> `search` index metric</span>
<span class="sd"> metric isn&#39;t specified. Valid choices: _all, store, indexing, get,</span>
<span class="sd"> search, merge, flush, refresh, query_cache, fielddata, docs, warmer,</span>
<span class="sd"> completion, segments, translog, suggest, request_cache, recovery</span>
<span class="sd"> :arg completion_fields: Comma-separated list of fields for</span>
<span class="sd"> `fielddata` and `suggest` index metric (supports wildcards).</span>
<span class="sd"> :arg fielddata_fields: Comma-separated list of fields for</span>
<span class="sd"> `fielddata` index metric (supports wildcards).</span>
<span class="sd"> :arg fields: Comma-separated list of fields for `fielddata` and</span>
<span class="sd"> `completion` index metric (supports wildcards).</span>
<span class="sd"> :arg groups: Comma-separated list of search groups for `search`</span>
<span class="sd"> index metric.</span>
<span class="sd"> :arg include_segment_file_sizes: Whether to report the</span>
<span class="sd"> aggregated disk usage of each one of the Lucene index files (only</span>
<span class="sd"> applies if segment stats are requested)</span>
<span class="sd"> :arg include_unloaded_segments: If set to true segment stats</span>
<span class="sd"> will include stats for segments that are not currently loaded into</span>
<span class="sd"> memory</span>
<span class="sd"> applies if segment stats are requested). (default: false)</span>
<span class="sd"> :arg level: Return indices stats aggregated at index, node or</span>
<span class="sd"> shard level Valid choices: indices, node, shards Default: node</span>
<span class="sd"> :arg timeout: Explicit operation timeout</span>
<span class="sd"> :arg types: A comma-separated list of document types for the</span>
<span class="sd"> `indexing` index metric</span>
<span class="sd"> shard level. Valid choices: indices, node, shards</span>
<span class="sd"> :arg timeout: Operation timeout.</span>
<span class="sd"> :arg types: Comma-separated list of document types for the</span>
<span class="sd"> `indexing` index metric.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">perform_request</span><span class="p">(</span>
<span class="s2">&quot;GET&quot;</span><span class="p">,</span>
Expand All @@ -221,21 +227,21 @@ <h1>Source code for opensearchpy.client.nodes</h1><div class="highlight"><pre>
<span class="sd"> Returns information about hot threads on each node in the cluster.</span>


<span class="sd"> :arg node_id: A comma-separated list of node IDs or names to</span>
<span class="sd"> limit the returned information; use `_local` to return information from</span>
<span class="sd"> the node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes</span>
<span class="sd"> :arg doc_type: The type to sample (default: cpu) Valid choices:</span>
<span class="sd"> cpu, wait, block</span>
<span class="sd"> :arg node_id: Comma-separated list of node IDs or names to limit</span>
<span class="sd"> the returned information; use `_local` to return information from the</span>
<span class="sd"> node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes.</span>
<span class="sd"> :arg doc_type: The type to sample. Valid choices: cpu, wait,</span>
<span class="sd"> block</span>
<span class="sd"> :arg ignore_idle_threads: Don&#39;t show threads that are in known-</span>
<span class="sd"> idle places, such as waiting on a socket select or pulling from an empty</span>
<span class="sd"> task queue (default: true)</span>
<span class="sd"> :arg interval: The interval for the second sampling of threads</span>
<span class="sd"> :arg snapshots: Number of samples of thread stacktrace (default:</span>
<span class="sd"> 10)</span>
<span class="sd"> task queue. (default: True)</span>
<span class="sd"> :arg interval: The interval for the second sampling of threads.</span>
<span class="sd"> :arg snapshots: Number of samples of thread stacktrace.</span>
<span class="sd"> (default: 10)</span>
<span class="sd"> :arg threads: Specify the number of threads to provide</span>
<span class="sd"> information for (default: 3)</span>
<span class="sd"> :arg timeout: Explicit operation timeout</span>
<span class="sd"> information for. (default: 3)</span>
<span class="sd"> :arg timeout: Operation timeout.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># type is a reserved word so it cannot be used, use doc_type instead</span>
<span class="k">if</span> <span class="s2">&quot;doc_type&quot;</span> <span class="ow">in</span> <span class="n">params</span><span class="p">:</span>
Expand All @@ -254,13 +260,13 @@ <h1>Source code for opensearchpy.client.nodes</h1><div class="highlight"><pre>
<span class="sd"> Returns low-level information about REST actions usage on nodes.</span>


<span class="sd"> :arg node_id: A comma-separated list of node IDs or names to</span>
<span class="sd"> limit the returned information; use `_local` to return information from</span>
<span class="sd"> the node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes</span>
<span class="sd"> :arg node_id: Comma-separated list of node IDs or names to limit</span>
<span class="sd"> the returned information; use `_local` to return information from the</span>
<span class="sd"> node you&#39;re connecting to, leave empty to get information from all</span>
<span class="sd"> nodes.</span>
<span class="sd"> :arg metric: Limit the information returned to the specified</span>
<span class="sd"> metrics Valid choices: _all, rest_actions</span>
<span class="sd"> :arg timeout: Explicit operation timeout</span>
<span class="sd"> metrics. Valid choices: _all, rest_actions</span>
<span class="sd"> :arg timeout: Operation timeout.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">transport</span><span class="o">.</span><span class="n">perform_request</span><span class="p">(</span>
<span class="s2">&quot;GET&quot;</span><span class="p">,</span>
Expand Down
Loading

0 comments on commit dc1a5bb

Please sign in to comment.