Update API and license tools

This commit is contained in:
Seth Michael Larson
2020-04-23 14:10:49 -05:00
committed by Seth Michael Larson
parent f0280d9302
commit 24c57840cb
12 changed files with 448 additions and 26 deletions
+31 -19
View File
@@ -12,7 +12,7 @@ easily enable or disable the features you want to use.
Info
----
`X-Pack info <https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html>`_
`X-Pack info <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/info-api.html>`_
provides general info about the installed X-Pack.
.. py:module:: elasticsearch.client.xpack
@@ -24,7 +24,7 @@ provides general info about the installed X-Pack.
Async Search APIs
-----------------
`Async Search API <https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html>`_
`Async Search API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/async-search.html>`_
lets you asynchronously execute a search request, monitor its progress,
and retrieve partial results as they become available.
@@ -37,7 +37,7 @@ and retrieve partial results as they become available.
Autoscaling APIs
-----------------
`Autoscaling API <https://www.elastic.co/guide/en/elasticsearch/reference/master/autoscaling-apis.html>`_
`Autoscaling API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-apis.html>`_
gets the current autoscaling decision based on the configured autoscaling policy.
.. py:module:: elasticsearch.client.autoscaling
@@ -49,7 +49,7 @@ gets the current autoscaling decision based on the configured autoscaling policy
EQL APIs
--------
`EQL API <https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html>`_
`EQL API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql.html>`_
allows querying with Event Query Language (EQL) to search logs and events and match
them with shared properties.
@@ -62,7 +62,7 @@ them with shared properties.
Graph Explore APIs
------------------
`Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html>`_
`Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/graph-explore-api.html>`_
enables you to extract and summarize information about the documents and terms in your Elasticsearch index.
.. py:module:: elasticsearch.client.graph
@@ -74,7 +74,7 @@ enables you to extract and summarize information about the documents and terms i
Licensing APIs
--------------
`Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/current/licensing-apis.html>`_
`Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/licensing-apis.html>`_
can be used to manage your licences.
@@ -87,7 +87,7 @@ can be used to manage your licences.
Machine Learning APIs
---------------------
`Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html>`_
`Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-apis.html>`_
can be useful for discovering new patterns about your data. For a more detailed explanation
about X-Pack's machine learning please refer to the official documentation.
@@ -101,7 +101,7 @@ about X-Pack's machine learning please refer to the official documentation.
Security APIs
-------------
`Security API <https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api.html>`_
`Security API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api.html>`_
can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.
.. py:module:: elasticsearch.client.security
@@ -113,7 +113,7 @@ can be used to help secure your Elasticsearch cluster. Integrating with LDAP and
Watcher APIs
-------------
`Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api.html>`_
`Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/watcher-api.html>`_
can be used to notify you when certain pre-defined thresholds have happened.
.. py:module:: elasticsearch.client.watcher
@@ -125,7 +125,7 @@ can be used to notify you when certain pre-defined thresholds have happened.
Migration APIs
---------------
`Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>`_
`Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/migration-api.html>`_
helps simplify upgrading X-Pack indices from one version to another.
.. py:module:: elasticsearch.client.migration
@@ -137,7 +137,7 @@ helps simplify upgrading X-Pack indices from one version to another.
Enrich APIs
------------
`Enrich API <https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-apis.html>`_
`Enrich API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/enrich-apis.html>`_
can be used to add data from your existing indices to incoming documents during ingest.
.. py:module:: elasticsearch.client.enrich
@@ -148,7 +148,7 @@ can be used to add data from your existing indices to incoming documents during
SQL APIs
--------
The `SQL REST API <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html>`_
The `SQL REST API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/sql-rest.html>`_
accepts SQL in a JSON document, executes it, and returns the results.
.. py:module:: elasticsearch.client.sql
@@ -159,7 +159,7 @@ accepts SQL in a JSON document, executes it, and returns the results.
Cross-Cluster Replication APIs
-------------------------------
`Cross-Cluster Replication API <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html>`_
`Cross-Cluster Replication API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ccr-apis.html>`_
used to perform cross-cluster replication operations.
.. py:module:: elasticsearch.client.ccr
@@ -171,7 +171,7 @@ used to perform cross-cluster replication operations.
Monitoring APIs
----------------
`Monitoring API <https://www.elastic.co/guide/en/elasticsearch/reference/master/es-monitoring.html>`_
`Monitoring API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/es-monitoring.html>`_
used to collect data from the Elasticsearch nodes, Logstash nodes, Kibana instances, and Beats in your cluster.
.. py:module:: elasticsearch.client.monitoring
@@ -183,7 +183,7 @@ used to collect data from the Elasticsearch nodes, Logstash nodes, Kibana instan
Rollup APIs
------------
`Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-apis.html>`_
`Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/rollup-apis.html>`_
enables searching through rolled-up data using the standard query DSL.
.. py:module:: elasticsearch.client.rollup
@@ -195,7 +195,7 @@ enables searching through rolled-up data using the standard query DSL.
Snapshot Lifecycle Management APIs
-----------------------------------
`Snapshot Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/current/snapshot-lifecycle-management-api.html>`_
`Snapshot Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/snapshot-lifecycle-management-api.html>`_
can be used to set up policies to automatically take snapshots and control how long they are retained.
.. py:module:: elasticsearch.client.slm
@@ -204,10 +204,22 @@ can be used to set up policies to automatically take snapshots and control how l
:members:
Searchable Snapshots APIs
-------------------------
`Searchable Snapshots API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html>`_
used to perform searchable snapshots operations.
.. py:module:: elasticsearch.client.searchable_snapshots
.. autoclass:: SearchableSnapshotsClient
:members:
Index Lifecycle Management APIs
--------------------------------
`Index Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management-api.html>`_
`Index Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/index-lifecycle-management-api.html>`_
used to set up policies to automatically manage the index lifecycle.
.. py:module:: elasticsearch.client.ilm
@@ -219,7 +231,7 @@ used to set up policies to automatically manage the index lifecycle.
Transform APIs
---------------
`Transform API <https://www.elastic.co/guide/en/elasticsearch/reference/current/transform-apis.html>`_
`Transform API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/transform-apis.html>`_
manages transformation operations from grabbing data from source indices, transforms it, and
saves it to a destination index.
@@ -232,7 +244,7 @@ saves it to a destination index.
Deprecation APIs
-----------------
`Deprecation API <https://www.elastic.co/guide/en/elasticsearch/reference/master/migration-api-deprecation.html>`_
`Deprecation API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/migration-api-deprecation.html>`_
used to retrieve information about different cluster, node, and index level settings that use deprecated features
that will be removed or changed in the next major version.