actions/opensearch-pyd
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

[7.x] Reorganize API documentation

Browse Source
This commit is contained in:
Seth Michael Larson
2021-04-26 10:14:29 -05:00
parent 794a97578f
commit 54a1d56870
7 changed files with 306 additions and 431 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/sphinx/api.rst
+140 -8
View File
@@ -115,12 +115,24 @@ Async Search
.. autoclass:: AsyncSearchClient
:members:
Autoscaling
-----------
.. autoclass:: AutoscalingClient
:members:
Cat
---
.. autoclass:: CatClient
:members:
Cross-Cluster Replication (CCR)
-------------------------------
.. autoclass:: CcrClient
:members:
Cluster
-------
@@ -133,44 +145,164 @@ Dangling Indices
.. autoclass:: DanglingIndicesClient
:members:
Features
--------
Enrich Policies
---------------
.. autoclass:: EnrichClient
:members:
Event Query Language (EQL)
--------------------------
.. autoclass:: EqlClient
:members:
Snapshottable Features
----------------------
.. autoclass:: FeaturesClient
:members:
Fleet
-----
.. autoclass:: FleetClient
:members:
Graph Explore
-------------
.. autoclass:: GraphClient
:members:
Index Lifecycle Management (ILM)
--------------------------------
.. autoclass:: IlmClient
:members:
Indices
-------
.. autoclass:: IndicesClient
:members:
Ingest
------
Ingest Pipelines
----------------
.. autoclass:: IngestClient
:members:
License
-------
.. autoclass:: LicenseClient
:members:
Logstash
--------
.. autoclass:: LogstashClient
:members:
Migration
---------
.. autoclass:: MigrationClient
:members:
Machine Learning (ML)
---------------------
.. autoclass:: MlClient
:members:
Monitoring
----------
.. autoclass:: MonitoringClient
:members:
Nodes
-----
.. autoclass:: NodesClient
:members:
Remote
------
Rollup Indices
--------------
.. autoclass:: RemoteClient
.. autoclass:: RollupClient
:members:
Snapshot
Searchable Snapshots
--------------------
.. autoclass:: SearchableSnapshotsClient
:members:
Security
--------
.. autoclass:: SecurityClient
:members:
Shutdown
--------
.. autoclass:: ShutdownClient
:members:
Snapshot Lifecycle Management (SLM)
-----------------------------------
.. autoclass:: SlmClient
:members:
Snapshots
---------
.. autoclass:: SnapshotClient
:members:
SQL
---
.. autoclass:: SqlClient
:members:
TLS/SSL
-------
.. autoclass:: SslClient
:members:
Tasks
-----
.. autoclass:: TasksClient
:members:
Text Structure
--------------
.. autoclass:: TextStructureClient
:members:
Transforms
----------
.. autoclass:: TransformClient
:members:
Watcher
-------
.. autoclass:: WatcherClient
:members:
X-Pack
------
.. autoclass:: XPackClient
:members:
docs/sphinx/index.rst
+1 -39
View File
@@ -376,31 +376,6 @@ documents. This will configure compression.
Compression is enabled by default when connecting to Elastic Cloud via ``cloud_id``.
Running on AWS with IAM
~~~~~~~~~~~~~~~~~~~~~~~
If you want to use this client with IAM based authentication on AWS you can use
the `requests-aws4auth`_ package:
.. code-block:: python
from elasticsearch import Elasticsearch, RequestsHttpConnection
from requests_aws4auth import AWS4Auth
host = 'YOURHOST.us-east-1.es.amazonaws.com'
awsauth = AWS4Auth(YOUR_ACCESS_KEY, YOUR_SECRET_KEY, REGION, 'es')
es = Elasticsearch(
hosts=[{'host': host, 'port': 443}],
http_auth=awsauth,
use_ssl=True,
verify_certs=True,
connection_class=RequestsHttpConnection
)
print(es.info())
.. _requests-aws4auth: https://pypi.python.org/pypi/requests-aws4auth
Customization
-------------
@@ -455,7 +430,6 @@ Contents
:maxdepth: 2
api
xpack
exceptions
async
connection
@@ -467,19 +441,7 @@ Contents
License
-------
Copyright 2020 Elasticsearch B.V
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Copyright 2021 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.
Indices and tables
docs/sphinx/xpack.rst
-205
View File
@@ -1,205 +0,0 @@
.. _xpack:
X-Pack APIs
===========
X-Pack is an Elastic Stack extension that bundles security, alerting, monitoring,
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
X-Pack Info
-----------
`X-Pack Info API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/info-api.html>`_
provides general info about the installed X-Pack.
.. autoclass:: XPackClient
:members:
Autoscaling
-----------
`Autoscaling API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/autoscaling-apis.html>`_
is used to perform autoscaling operations.
.. autoclass:: AutoscalingClient
:members:
Cross-Cluster Replication
-------------------------
`Cross-Cluster Replication APIs <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ccr-apis.html>`_
are used to perform cross-cluster replication operations.
.. autoclass:: CcrClient
:members:
Enrich
------
`Enrich APIs <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.
.. autoclass:: EnrichClient
:members:
EQL
---
`EQL APIs <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/eql.html>`_
accept EQL to query event-based time series data, such as logs, metrics, and traces.
.. autoclass:: EqlClient
:members:
Graph Explore
-------------
`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.
.. autoclass:: GraphClient
:members:
Index Lifecycle Management (ILM)
--------------------------------
`Index Lifecycle Management APIs <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.
.. autoclass:: IlmClient
:members:
Licensing
---------
`License APIs <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/licensing-apis.html>`_
can be used to manage your licences.
.. autoclass:: LicenseClient
:members:
Logstash
--------
`Logstash APIs <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/logstash-apis.html>`_
manage Pipelines used by Logstash Central Management.
.. autoclass:: LogstashClient
:members:
Machine Learning
----------------
`Machine Learning APIs <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.
.. autoclass:: MlClient
:members:
Migration
---------
`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.
.. autoclass:: MigrationClient
:members:
Monitoring
----------
`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.
.. autoclass:: MonitoringClient
:members:
Rollup
------
`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.
.. autoclass:: RollupClient
:members:
Searchable Snapshots
--------------------
`Searchable Snapshots API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-apis.html>`_
used to perform searchable snapshots operations.
.. autoclass:: SearchableSnapshotsClient
:members:
Security
--------
`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.
.. autoclass:: SecurityClient
:members:
Snapshot Lifecycle Management (SLM)
-----------------------------------
`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.
.. autoclass:: SlmClient
:members:
SQL
---
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.
.. autoclass:: SqlClient
:members:
SSL Certificate
---------------
`SSL Certificate API <https://www.elastic.co/guide/en/elasticsearch/reference/7.x/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:: SslClient
:members:
Text Structure
--------------
`Text Structure API <https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-find-file-structure.html>`_
finds the structure of a text file. The text file must contain data that is
suitable to be ingested into Elasticsearch.
.. autoclass:: TextStructureClient
:members:
Transform
---------
`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.
.. autoclass:: TransformClient
:members:
Watcher
-------
`Watcher APIs <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.
.. autoclass:: WatcherClient
:members: