Skip to content

Commit efcee36

Browse files
sethmlarsonsethmlarson
authored
Update APIs and docs links to Elasticsearch 7.9
1 parent 3945042 commit efcee36

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+669
-667
lines changed

‎elasticsearch/_async/client/__init__.py

+36-36
Large diffs are not rendered by default.

‎elasticsearch/_async/client/async_search.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ async def delete(self, id, params=None, headers=None):
2424
"""
2525
Deletes an async search by ID. If the search is still running, the search
2626
request will be cancelled. Otherwise, the saved search results are deleted.
27-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/async-search.html>`_
27+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/async-search.html>`_
2828
2929
:arg id: The async search ID
3030
"""
@@ -40,7 +40,7 @@ async def get(self, id, params=None, headers=None):
4040
"""
4141
Retrieves the results of a previously submitted async search request given its
4242
ID.
43-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/async-search.html>`_
43+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/async-search.html>`_
4444
4545
:arg id: The async search ID
4646
:arg keep_alive: Specify the time interval in which the results
@@ -103,7 +103,7 @@ async def get(self, id, params=None, headers=None):
103103
async def submit(self, body=None, index=None, params=None, headers=None):
104104
"""
105105
Executes a search request asynchronously.
106-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/async-search.html>`_
106+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/async-search.html>`_
107107
108108
:arg body: The search definition using the Query DSL
109109
:arg index: A comma-separated list of index names to search; use

‎elasticsearch/_async/client/autoscaling.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ async def get_autoscaling_decision(self, params=None, headers=None):
2424
"""
2525
Gets the current autoscaling decision based on the configured autoscaling
2626
policy, indicating whether or not autoscaling is needed.
27-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-get-autoscaling-decision.html>`_
27+
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-decision.html>`_
2828
"""
2929
return await self.transport.perform_request(
3030
"GET", "/_autoscaling/decision", params=params, headers=headers
@@ -34,7 +34,7 @@ async def get_autoscaling_decision(self, params=None, headers=None):
3434
async def delete_autoscaling_policy(self, name, params=None, headers=None):
3535
"""
3636
Deletes an autoscaling policy.
37-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-delete-autoscaling-policy.html>`_
37+
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html>`_
3838
3939
:arg name: the name of the autoscaling policy
4040
"""
@@ -52,7 +52,7 @@ async def delete_autoscaling_policy(self, name, params=None, headers=None):
5252
async def get_autoscaling_policy(self, name, params=None, headers=None):
5353
"""
5454
Retrieves an autoscaling policy.
55-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-get-autoscaling-policy.html>`_
55+
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html>`_
5656
5757
:arg name: the name of the autoscaling policy
5858
"""
@@ -70,7 +70,7 @@ async def get_autoscaling_policy(self, name, params=None, headers=None):
7070
async def put_autoscaling_policy(self, name, body, params=None, headers=None):
7171
"""
7272
Creates a new autoscaling policy.
73-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-put-autoscaling-policy.html>`_
73+
`<https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html>`_
7474
7575
:arg name: the name of the autoscaling policy
7676
:arg body: the specification of the autoscaling policy

‎elasticsearch/_async/client/cat.py

+25-25
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ async def aliases(self, name=None, params=None, headers=None):
2424
"""
2525
Shows information about currently configured aliases to indices including
2626
filter and routing infos.
27-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-alias.html>`_
27+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-alias.html>`_
2828
2929
:arg name: A comma-separated list of alias names to return
3030
:arg expand_wildcards: Whether to expand wildcard expression to
@@ -49,7 +49,7 @@ async def allocation(self, node_id=None, params=None, headers=None):
4949
"""
5050
Provides a snapshot of how many shards are allocated to each data node and how
5151
much disk space they are using.
52-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-allocation.html>`_
52+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-allocation.html>`_
5353
5454
:arg node_id: A comma-separated list of node IDs or names to
5555
limit the returned information
@@ -79,7 +79,7 @@ async def count(self, index=None, params=None, headers=None):
7979
"""
8080
Provides quick access to the document count of the entire cluster, or
8181
individual indices.
82-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-count.html>`_
82+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-count.html>`_
8383
8484
:arg index: A comma-separated list of index names to limit the
8585
returned information
@@ -99,7 +99,7 @@ async def count(self, index=None, params=None, headers=None):
9999
async def health(self, params=None, headers=None):
100100
"""
101101
Returns a concise representation of the cluster health.
102-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-health.html>`_
102+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-health.html>`_
103103
104104
:arg format: a short version of the Accept header, e.g. json,
105105
yaml
@@ -120,7 +120,7 @@ async def health(self, params=None, headers=None):
120120
async def help(self, params=None, headers=None):
121121
"""
122122
Returns help for the Cat APIs.
123-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat.html>`_
123+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat.html>`_
124124
125125
:arg help: Return help information
126126
:arg s: Comma-separated list of column names or column aliases
@@ -149,7 +149,7 @@ async def indices(self, index=None, params=None, headers=None):
149149
"""
150150
Returns information about indices: number of primaries and replicas, document
151151
counts, disk size, ...
152-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-indices.html>`_
152+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-indices.html>`_
153153
154154
:arg index: A comma-separated list of index names to limit the
155155
returned information
@@ -187,7 +187,7 @@ async def indices(self, index=None, params=None, headers=None):
187187
async def master(self, params=None, headers=None):
188188
"""
189189
Returns information about the master node.
190-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-master.html>`_
190+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-master.html>`_
191191
192192
:arg format: a short version of the Accept header, e.g. json,
193193
yaml
@@ -220,7 +220,7 @@ async def master(self, params=None, headers=None):
220220
async def nodes(self, params=None, headers=None):
221221
"""
222222
Returns basic statistics about performance of cluster nodes.
223-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-nodes.html>`_
223+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-nodes.html>`_
224224
225225
:arg bytes: The unit in which to display byte values Valid
226226
choices: b, k, kb, m, mb, g, gb, t, tb, p, pb
@@ -250,7 +250,7 @@ async def nodes(self, params=None, headers=None):
250250
async def recovery(self, index=None, params=None, headers=None):
251251
"""
252252
Returns information about index shard recoveries, both on-going completed.
253-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-recovery.html>`_
253+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-recovery.html>`_
254254
255255
:arg index: Comma-separated list or wildcard expression of index
256256
names to limit the returned information
@@ -280,7 +280,7 @@ async def recovery(self, index=None, params=None, headers=None):
280280
async def shards(self, index=None, params=None, headers=None):
281281
"""
282282
Provides a detailed view of shard allocation on nodes.
283-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-shards.html>`_
283+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-shards.html>`_
284284
285285
:arg index: A comma-separated list of index names to limit the
286286
returned information
@@ -308,7 +308,7 @@ async def shards(self, index=None, params=None, headers=None):
308308
async def segments(self, index=None, params=None, headers=None):
309309
"""
310310
Provides low-level information about the segments in the shards of an index.
311-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-segments.html>`_
311+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-segments.html>`_
312312
313313
:arg index: A comma-separated list of index names to limit the
314314
returned information
@@ -330,7 +330,7 @@ async def segments(self, index=None, params=None, headers=None):
330330
async def pending_tasks(self, params=None, headers=None):
331331
"""
332332
Returns a concise representation of the cluster pending tasks.
333-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-pending-tasks.html>`_
333+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-pending-tasks.html>`_
334334
335335
:arg format: a short version of the Accept header, e.g. json,
336336
yaml
@@ -355,7 +355,7 @@ async def thread_pool(self, thread_pool_patterns=None, params=None, headers=None
355355
"""
356356
Returns cluster-wide thread pool statistics per node. By default the active,
357357
queue and rejected statistics are returned for all thread pools.
358-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-thread-pool.html>`_
358+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-thread-pool.html>`_
359359
360360
:arg thread_pool_patterns: A comma-separated list of regular-
361361
expressions to filter the thread pools in the output
@@ -385,7 +385,7 @@ async def fielddata(self, fields=None, params=None, headers=None):
385385
"""
386386
Shows how much heap memory is currently being used by fielddata on every data
387387
node in the cluster.
388-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-fielddata.html>`_
388+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-fielddata.html>`_
389389
390390
:arg fields: A comma-separated list of fields to return in the
391391
output
@@ -410,7 +410,7 @@ async def fielddata(self, fields=None, params=None, headers=None):
410410
async def plugins(self, params=None, headers=None):
411411
"""
412412
Returns information about installed plugins across nodes node.
413-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-plugins.html>`_
413+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-plugins.html>`_
414414
415415
:arg format: a short version of the Accept header, e.g. json,
416416
yaml
@@ -432,7 +432,7 @@ async def plugins(self, params=None, headers=None):
432432
async def nodeattrs(self, params=None, headers=None):
433433
"""
434434
Returns information about custom node attributes.
435-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-nodeattrs.html>`_
435+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-nodeattrs.html>`_
436436
437437
:arg format: a short version of the Accept header, e.g. json,
438438
yaml
@@ -454,7 +454,7 @@ async def nodeattrs(self, params=None, headers=None):
454454
async def repositories(self, params=None, headers=None):
455455
"""
456456
Returns information about snapshot repositories registered in the cluster.
457-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-repositories.html>`_
457+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-repositories.html>`_
458458
459459
:arg format: a short version of the Accept header, e.g. json,
460460
yaml
@@ -478,7 +478,7 @@ async def repositories(self, params=None, headers=None):
478478
async def snapshots(self, repository=None, params=None, headers=None):
479479
"""
480480
Returns all snapshots in a specific repository.
481-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-snapshots.html>`_
481+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-snapshots.html>`_
482482
483483
:arg repository: Name of repository from which to fetch the
484484
snapshot information
@@ -519,7 +519,7 @@ async def tasks(self, params=None, headers=None):
519519
"""
520520
Returns information about the tasks currently executing on one or more nodes in
521521
the cluster.
522-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/tasks.html>`_
522+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/tasks.html>`_
523523
524524
:arg actions: A comma-separated list of actions that should be
525525
returned. Leave empty to return all.
@@ -548,7 +548,7 @@ async def tasks(self, params=None, headers=None):
548548
async def templates(self, name=None, params=None, headers=None):
549549
"""
550550
Returns information about existing templates.
551-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-templates.html>`_
551+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-templates.html>`_
552552
553553
:arg name: A pattern that returned template names must match
554554
:arg format: a short version of the Accept header, e.g. json,
@@ -571,7 +571,7 @@ async def templates(self, name=None, params=None, headers=None):
571571
async def ml_data_frame_analytics(self, id=None, params=None, headers=None):
572572
"""
573573
Gets configuration and usage information about data frame analytics jobs.
574-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-dfanalytics.html>`_
574+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-dfanalytics.html>`_
575575
576576
:arg id: The ID of the data frame analytics to fetch
577577
:arg allow_no_match: Whether to ignore if a wildcard expression
@@ -600,7 +600,7 @@ async def ml_data_frame_analytics(self, id=None, params=None, headers=None):
600600
async def ml_datafeeds(self, datafeed_id=None, params=None, headers=None):
601601
"""
602602
Gets configuration and usage information about datafeeds.
603-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-datafeeds.html>`_
603+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-datafeeds.html>`_
604604
605605
:arg datafeed_id: The ID of the datafeeds stats to fetch
606606
:arg allow_no_datafeeds: Whether to ignore if a wildcard
@@ -627,7 +627,7 @@ async def ml_datafeeds(self, datafeed_id=None, params=None, headers=None):
627627
async def ml_jobs(self, job_id=None, params=None, headers=None):
628628
"""
629629
Gets configuration and usage information about anomaly detection jobs.
630-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-anomaly-detectors.html>`_
630+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-anomaly-detectors.html>`_
631631
632632
:arg job_id: The ID of the jobs stats to fetch
633633
:arg allow_no_jobs: Whether to ignore if a wildcard expression
@@ -667,7 +667,7 @@ async def ml_jobs(self, job_id=None, params=None, headers=None):
667667
async def ml_trained_models(self, model_id=None, params=None, headers=None):
668668
"""
669669
Gets configuration and usage information about inference trained models.
670-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-trained-model.html>`_
670+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-trained-model.html>`_
671671
672672
:arg model_id: The ID of the trained models stats to fetch
673673
:arg allow_no_match: Whether to ignore if a wildcard expression
@@ -705,7 +705,7 @@ async def ml_trained_models(self, model_id=None, params=None, headers=None):
705705
async def transforms(self, transform_id=None, params=None, headers=None):
706706
"""
707707
Gets configuration and usage information about transforms.
708-
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/cat-transforms.html>`_
708+
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.9/cat-transforms.html>`_
709709
710710
:arg transform_id: The id of the transform for which to get
711711
stats. '_all' or '*' implies all transforms

0 commit comments

Comments
 (0)