[7.x] Add documentation of all X-Pack APIs

This commit is contained in:
Seth Michael Larson
2020-03-09 08:39:03 -05:00
committed by GitHub
parent f3b3da4a82
commit 2704580f7b
+119 -12
View File
@@ -9,11 +9,10 @@ While the X-Pack components are designed to work together seamlessly, you can
easily enable or disable the features you want to use. easily enable or disable the features you want to use.
Info Info
---- ----
`X-Pack info <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/info-api.html>`_ `X-Pack info <https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html>`_
provides general info about the installed X-Pack. provides general info about the installed X-Pack.
.. py:module:: elasticsearch.client.xpack .. py:module:: elasticsearch.client.xpack
@@ -22,9 +21,10 @@ provides general info about the installed X-Pack.
:members: :members:
Graph Explore Graph Explore APIs
------------- ------------------
`X-Pack Graph Explore <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/graph-explore-api.html>`_
`Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html>`_
enables you to extract and summarize information about the documents and terms in your Elasticsearch index. enables you to extract and summarize information about the documents and terms in your Elasticsearch index.
.. py:module:: elasticsearch.client.graph .. py:module:: elasticsearch.client.graph
@@ -33,10 +33,10 @@ enables you to extract and summarize information about the documents and terms i
.. autoclass:: GraphClient .. autoclass:: GraphClient
:members: :members:
Licensing API Licensing APIs
------------- --------------
`Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/licensing-apis.html>`_ `Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/current/licensing-apis.html>`_
can be used to manage your licences. can be used to manage your licences.
@@ -49,7 +49,7 @@ can be used to manage your licences.
Machine Learning APIs Machine Learning APIs
--------------------- ---------------------
`Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/ml-apis.html>`_ `Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html>`_
can be useful for discovering new patterns about your data. For a more detailed explanation 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. about X-Pack's machine learning please refer to the official documentation.
@@ -63,7 +63,7 @@ about X-Pack's machine learning please refer to the official documentation.
Security APIs Security APIs
------------- -------------
`Security API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/security-api.html>`_ `Security API <https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api.html>`_
can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory. can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.
.. py:module:: elasticsearch.client.security .. py:module:: elasticsearch.client.security
@@ -75,7 +75,7 @@ can be used to help secure your Elasticsearch cluster. Integrating with LDAP and
Watcher APIs Watcher APIs
------------- -------------
`Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/watcher-api.html>`_ `Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api.html>`_
can be used to notify you when certain pre-defined thresholds have happened. can be used to notify you when certain pre-defined thresholds have happened.
.. py:module:: elasticsearch.client.watcher .. py:module:: elasticsearch.client.watcher
@@ -87,7 +87,7 @@ can be used to notify you when certain pre-defined thresholds have happened.
Migration APIs Migration APIs
--------------- ---------------
`Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/6.2/migration-api.html>`_ `Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api.html>`_
helps simplify upgrading X-Pack indices from one version to another. helps simplify upgrading X-Pack indices from one version to another.
.. py:module:: elasticsearch.client.migration .. py:module:: elasticsearch.client.migration
@@ -95,3 +95,110 @@ helps simplify upgrading X-Pack indices from one version to another.
.. autoclass:: MigrationClient .. autoclass:: MigrationClient
:members: :members:
Enrich APIs
------------
`Enrich API <https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-apis.html>`_
can be used to add data from your existing indices to incoming documents during ingest.
.. py:module:: elasticsearch.client.enrich
.. autoclass:: EnrichClient
:members:
SQL APIs
--------
The `SQL REST API <https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-rest.html>`_
accepts SQL in a JSON document, executes it, and returns the results.
.. py:module:: elasticsearch.client.sql
.. autoclass:: SqlClient
:members:
Cross-Cluster Replication APIs
-------------------------------
`Cross-Cluster Replication API <https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-apis.html>`_
used to perform cross-cluster replication operations.
.. py:module:: elasticsearch.client.ccr
.. autoclass:: CcrClient
:members:
Monitoring APIs
----------------
`Monitoring API <https://www.elastic.co/guide/en/elasticsearch/reference/master/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
.. autoclass:: MonitoringClient
:members:
Rollup APIs
------------
`Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-apis.html>`_
enables searching through rolled-up data using the standard query DSL.
.. py:module:: elasticsearch.client.rollup
.. autoclass:: RollupClient
:members:
Snapshot Lifecycle Management APIs
-----------------------------------
`Snapshot Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/current/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
.. autoclass:: SlmClient
:members:
Index Lifecycle Management APIs
--------------------------------
`Index Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/current/index-lifecycle-management-api.html>`_
used to set up policies to automatically manage the index lifecycle.
.. py:module:: elasticsearch.client.ilm
.. autoclass:: IlmClient
:members:
Transform APIs
---------------
`Transform API <https://www.elastic.co/guide/en/elasticsearch/reference/current/transform-apis.html>`_
manages transformation operations from grabbing data from source indices, transforms it, and
saves it to a destination index.
.. py:module:: elasticsearch.client.transform
.. autoclass:: TransformClient
:members:
Deprecation APIs
-----------------
`Deprecation API <https://www.elastic.co/guide/en/elasticsearch/reference/master/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.
.. py:module:: elasticsearch.client.deprecation
.. autoclass:: DeprecationClient
:members: