Skip to content

Add stability warning to APIs, document all supported APIs #1410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 28, 2020
Merged

Add stability warning to APIs, document all supported APIs #1410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91f0e7a
Document all APIs, add stability warning
sethmlarson Oct 28, 2020
7eb729d
Remove RemoteClient in favor of 'cluster.remote_info()' API
sethmlarson Oct 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 25 additions & 19 deletions docs/sphinx/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ consistency and safety**.
``from`` and ``doc_type`` instead of ``type`` as parameter names.


Global options
Global Options
--------------

Some parameters are added by the client itself and can be used in all API
Expand Down Expand Up @@ -110,16 +110,16 @@ Elasticsearch

.. py:module:: elasticsearch.client

Indices
-------
Async Search
------------

.. autoclass:: IndicesClient
.. autoclass:: AsyncSearchClient
:members:

Ingest
------
Cat
---

.. autoclass:: IngestClient
.. autoclass:: CatClient
:members:

Cluster
Expand All @@ -128,16 +128,28 @@ Cluster
.. autoclass:: ClusterClient
:members:

Nodes
-----
Dangling Indices
----------------

.. autoclass:: NodesClient
.. autoclass:: DanglingIndicesClient
:members:

Cat
---
Indices
-------

.. autoclass:: CatClient
.. autoclass:: IndicesClient
:members:

Ingest
------

.. autoclass:: IngestClient
:members:

Nodes
-----

.. autoclass:: NodesClient
:members:

Snapshot
Expand All @@ -151,9 +163,3 @@ Tasks

.. autoclass:: TasksClient
:members:

Dangling Indices
----------------

.. autoclass:: DanglingIndicesClient
:members:
207 changes: 84 additions & 123 deletions docs/sphinx/xpack.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,209 +8,170 @@ reporting, and graph capabilities into one easy-to-install package.
While the X-Pack components are designed to work together seamlessly, you can
easily enable or disable the features you want to use.

.. py:module:: elasticsearch.client

Info
----

`X-Pack info <https://www.elastic.co/guide/en/elasticsearch/reference/master/info-api.html>`_
provides general info about the installed X-Pack.
X-Pack Info
-----------

.. py:module:: elasticsearch.client.xpack
`X-Pack Info API <https://www.elastic.co/guide/en/elasticsearch/reference/master/info-api.html>`_
provides general info about the installed X-Pack.

.. autoclass:: XPackClient
:members:

Cross-Cluster Replication
-------------------------

Graph Explore APIs
------------------

`Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/master/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

`Cross-Cluster Replication APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-apis.html>`_
are used to perform cross-cluster replication operations.

.. autoclass:: GraphClient
.. autoclass:: CcrClient
:members:

Licensing APIs
--------------
Enrich
------

`Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/master/licensing-apis.html>`_
can be used to manage your licences.
`Enrich APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/enrich-apis.html>`_
can be used to add data from your existing indices to incoming documents during ingest.

.. autoclass:: EnrichClient
:members:

.. py:module:: elasticsearch.client.license
EQL
---

`EQL APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/eql.html>`_
accept EQL to query event-based time series data, such as logs, metrics, and traces.

.. autoclass:: LicenseClient
.. autoclass:: EqlClient
:members:

Machine Learning APIs
---------------------
Graph Explore
-------------

`Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/master/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.
`Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/master/graph-explore-api.html>`_
enables you to extract and summarize information about the documents and terms in your Elasticsearch index.

.. autoclass:: GraphClient
:members:

.. py:module:: elasticsearch.client.ml
Index Lifecycle Management (ILM)
--------------------------------

`Index Lifecycle Management APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-management-api.html>`_
used to set up policies to automatically manage the index lifecycle.

.. autoclass:: MlClient
.. autoclass:: IlmClient
:members:

Security APIs
-------------

`Security API <https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api.html>`_
can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.

.. py:module:: elasticsearch.client.security
Licensing
---------

`License APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/licensing-apis.html>`_
can be used to manage your licences.

.. autoclass:: SecurityClient
.. autoclass:: LicenseClient
:members:

Watcher APIs
-------------

`Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/master/watcher-api.html>`_
can be used to notify you when certain pre-defined thresholds have happened.
Machine Learning
----------------

.. py:module:: elasticsearch.client.watcher
`Machine Learning APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/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.

.. autoclass:: WatcherClient
.. autoclass:: MlClient
:members:


Migration APIs
---------------
Migration
---------

`Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/master/migration-api.html>`_
helps simplify upgrading X-Pack indices from one version to another.

.. py:module:: elasticsearch.client.migration

.. autoclass:: MigrationClient
:members:

Monitoring
----------

Enrich APIs
------------

`Enrich API <https://www.elastic.co/guide/en/elasticsearch/reference/master/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/master/sql-rest.html>`_
accepts SQL in a JSON document, executes it, and returns the results.

.. py:module:: elasticsearch.client.sql
`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.

.. autoclass:: SqlClient
.. autoclass:: MonitoringClient
:members:

Cross-Cluster Replication APIs
-------------------------------
Rollup
------

`Cross-Cluster Replication API <https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-apis.html>`_
used to perform cross-cluster replication operations.

.. py:module:: elasticsearch.client.ccr
`Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-apis.html>`_
enables searching through rolled-up data using the standard query DSL.

.. autoclass:: CcrClient
.. autoclass:: RollupClient
:members:

Searchable Snapshots
--------------------

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
`Searchable Snapshots API <https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html>`_
used to perform searchable snapshots operations.

.. autoclass:: MonitoringClient
.. autoclass:: SearchableSnapshotsClient
:members:

Security
--------

Rollup APIs
------------

`Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-apis.html>`_
enables searching through rolled-up data using the standard query DSL.

.. py:module:: elasticsearch.client.rollup
`Security API <https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api.html>`_
can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.

.. autoclass:: RollupClient
.. autoclass:: SecurityClient
:members:


Snapshot Lifecycle Management APIs
Snapshot Lifecycle Management (SLM)
-----------------------------------

`Snapshot Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/master/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:

SQL
---

Searchable Snapshots APIs
-------------------------

`Searchable Snapshots API <https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html>`_
used to perform searchable snapshots operations.

.. py:module:: elasticsearch.client.searchable_snapshots
The `SQL REST API <https://www.elastic.co/guide/en/elasticsearch/reference/master/sql-rest.html>`_
accepts SQL in a JSON document, executes it, and returns the results.

.. autoclass:: SearchableSnapshotsClient
.. autoclass:: SqlClient
:members:

SSL Certificate
---------------

Index Lifecycle Management APIs
--------------------------------

`Index Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-management-api.html>`_
used to set up policies to automatically manage the index lifecycle.

.. py:module:: elasticsearch.client.ilm
`SSL Certificate API <https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-ssl.html>`_
enables you to retrieve information about the X.509 certificates that are used
to encrypt communications in your Elasticsearch cluster.

.. autoclass:: IlmClient
.. autoclass:: SslClient
:members:


Transform APIs
---------------
Transform
---------

`Transform API <https://www.elastic.co/guide/en/elasticsearch/reference/master/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:

Watcher
-------

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
`Watcher APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/watcher-api.html>`_
can be used to notify you when certain pre-defined thresholds have happened.

.. autoclass:: DeprecationClient
.. autoclass:: WatcherClient
:members:
Loading