diff --git a/docs/sphinx/api.rst b/docs/sphinx/api.rst index b79067909..812511f87 100644 --- a/docs/sphinx/api.rst +++ b/docs/sphinx/api.rst @@ -5,237 +5,50 @@ Elasticsearch API Reference All the API calls map the raw REST API as closely as possible, including the distinction between required and optional arguments to the calls. Keyword -arguments are required for all +arguments are required for all calls. .. note:: Some API parameters in Elasticsearch are reserved keywords in Python. - For example the ``from`` query parameter for pagination would be - aliased as ``from_``. - - -Elasticsearch -------------- - -.. py:module:: elasticsearch - -.. autoclass:: Elasticsearch - :members: - -.. py:module:: elasticsearch.client - -Async Search ------------- - -.. autoclass:: AsyncSearchClient - :members: - -Autoscaling ------------ - -.. autoclass:: AutoscalingClient - :members: - -Cat ---- - -.. autoclass:: CatClient - :members: - -Cross-Cluster Replication (CCR) -------------------------------- - -.. autoclass:: CcrClient - :members: - -Cluster -------- - -.. autoclass:: ClusterClient - :members: - -Dangling Indices ----------------- - -.. autoclass:: DanglingIndicesClient - :members: - -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 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: - -Query rules ------------ - -.. autoclass:: QueryRulesetClient - :members: - -Rollup Indices --------------- - -.. autoclass:: RollupClient - :members: - -Search Applications -------------------- - -.. autoclass:: SearchApplicationClient - :members: - -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: - -Synonyms --------- - -.. autoclass:: SynonymsClient - :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: + For example the ``from`` query parameter for pagination would be aliased as + ``from_``. + +.. toctree:: + :maxdepth: 1 + + api/elasticsearch + api/autoscaling + api/cat + api/ccr + api/cluster + api/dangling-indices + api/enrich-policies + api/eql + api/fleet + api/graph-explore + api/index-lifecycle-management + api/indices + api/ingest-pipelines + api/license + api/logstash + api/migration + api/ml + api/monitoring + api/nodes + api/query-rules + api/rollup-indices + api/search-application + api/searchable-snapshots + api/security + api/shutdown + api/snapshot-lifecycle-management + api/snapshots + api/snapshottable-features + api/sql + api/synonyms + api/tls-ssl + api/tasks + api/text-structure + api/transforms + api/watcher + api/x-pack diff --git a/docs/sphinx/api/autoscaling.rst b/docs/sphinx/api/autoscaling.rst new file mode 100644 index 000000000..1123af250 --- /dev/null +++ b/docs/sphinx/api/autoscaling.rst @@ -0,0 +1,9 @@ +.. _autoscaling: + +Autoscaling +----------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: AutoscalingClient + :members: diff --git a/docs/sphinx/api/cat.rst b/docs/sphinx/api/cat.rst new file mode 100644 index 000000000..515dddf69 --- /dev/null +++ b/docs/sphinx/api/cat.rst @@ -0,0 +1,9 @@ +.. _cat: + +Cat +--- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: CatClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/ccr.rst b/docs/sphinx/api/ccr.rst new file mode 100644 index 000000000..c0806ef1d --- /dev/null +++ b/docs/sphinx/api/ccr.rst @@ -0,0 +1,9 @@ +.. _ccr: + +Cross-Cluster Replication (CCR) +------------------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: CcrClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/cluster.rst b/docs/sphinx/api/cluster.rst new file mode 100644 index 000000000..feb1b8137 --- /dev/null +++ b/docs/sphinx/api/cluster.rst @@ -0,0 +1,9 @@ +.. _cluster: + +Cluster +------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: ClusterClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/dangling-indices.rst b/docs/sphinx/api/dangling-indices.rst new file mode 100644 index 000000000..7fb88aa3f --- /dev/null +++ b/docs/sphinx/api/dangling-indices.rst @@ -0,0 +1,9 @@ +.. _dangling-indices: + +Dangling Indices +---------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: DanglingIndicesClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/elasticsearch.rst b/docs/sphinx/api/elasticsearch.rst new file mode 100644 index 000000000..1a1a25e85 --- /dev/null +++ b/docs/sphinx/api/elasticsearch.rst @@ -0,0 +1,11 @@ +.. _elasticsearch: + +Elasticsearch +------------- + +.. py:module:: elasticsearch + +.. autoclass:: Elasticsearch + :members: + +.. py:module:: elasticsearch.client \ No newline at end of file diff --git a/docs/sphinx/api/enrich-policies.rst b/docs/sphinx/api/enrich-policies.rst new file mode 100644 index 000000000..e3c30a86b --- /dev/null +++ b/docs/sphinx/api/enrich-policies.rst @@ -0,0 +1,9 @@ +.. _enrich-policies: + +Enrich Policies +--------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: EnrichClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/eql.rst b/docs/sphinx/api/eql.rst new file mode 100644 index 000000000..29c9ce9d4 --- /dev/null +++ b/docs/sphinx/api/eql.rst @@ -0,0 +1,9 @@ +.. _eql: + +Event Query Language (EQL) +-------------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: EqlClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/fleet.rst b/docs/sphinx/api/fleet.rst new file mode 100644 index 000000000..9851b2f56 --- /dev/null +++ b/docs/sphinx/api/fleet.rst @@ -0,0 +1,9 @@ +.. _fleet: + +Fleet +----- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: FleetClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/graph-explore.rst b/docs/sphinx/api/graph-explore.rst new file mode 100644 index 000000000..a83ef3a9d --- /dev/null +++ b/docs/sphinx/api/graph-explore.rst @@ -0,0 +1,9 @@ +.. _graph-explore: + +Graph Explore +------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: GraphClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/index-lifecycle-management.rst b/docs/sphinx/api/index-lifecycle-management.rst new file mode 100644 index 000000000..9eeef1fbf --- /dev/null +++ b/docs/sphinx/api/index-lifecycle-management.rst @@ -0,0 +1,9 @@ +.. _index-lifecycle-management: + +Index Lifecycle Management (ILM) +-------------------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: IlmClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/indices.rst b/docs/sphinx/api/indices.rst new file mode 100644 index 000000000..55fc67b05 --- /dev/null +++ b/docs/sphinx/api/indices.rst @@ -0,0 +1,9 @@ +.. _indices: + +Indices +------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: IndicesClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/ingest-pipelines.rst b/docs/sphinx/api/ingest-pipelines.rst new file mode 100644 index 000000000..c2ea2efcd --- /dev/null +++ b/docs/sphinx/api/ingest-pipelines.rst @@ -0,0 +1,9 @@ +.. _ingest-pipelines: + +Ingest Pipelines +---------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: IngestClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/license.rst b/docs/sphinx/api/license.rst new file mode 100644 index 000000000..e73c6bbbc --- /dev/null +++ b/docs/sphinx/api/license.rst @@ -0,0 +1,9 @@ +.. _license: + +License +------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: LicenseClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/logstash.rst b/docs/sphinx/api/logstash.rst new file mode 100644 index 000000000..b8a00a5be --- /dev/null +++ b/docs/sphinx/api/logstash.rst @@ -0,0 +1,9 @@ +.. _logstash: + +Logstash +-------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: LogstashClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/migration.rst b/docs/sphinx/api/migration.rst new file mode 100644 index 000000000..83d08e46b --- /dev/null +++ b/docs/sphinx/api/migration.rst @@ -0,0 +1,9 @@ +.. _migration: + +Migration +--------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: MigrationClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/ml.rst b/docs/sphinx/api/ml.rst new file mode 100644 index 000000000..124cbeb4a --- /dev/null +++ b/docs/sphinx/api/ml.rst @@ -0,0 +1,9 @@ +.. _ml: + +Machine Learning (ML) +--------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: MlClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/monitoring.rst b/docs/sphinx/api/monitoring.rst new file mode 100644 index 000000000..3bfb8b4a3 --- /dev/null +++ b/docs/sphinx/api/monitoring.rst @@ -0,0 +1,9 @@ +.. _monitoring: + +Monitoring +---------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: MonitoringClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/nodes.rst b/docs/sphinx/api/nodes.rst new file mode 100644 index 000000000..f1b1fabae --- /dev/null +++ b/docs/sphinx/api/nodes.rst @@ -0,0 +1,9 @@ +.. _nodes: + +Nodes +----- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: NodesClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/query-rules.rst b/docs/sphinx/api/query-rules.rst new file mode 100644 index 000000000..fd42e9b2d --- /dev/null +++ b/docs/sphinx/api/query-rules.rst @@ -0,0 +1,9 @@ +.. _query-rules: + +Query rules +----------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: QueryRulesetClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/rollup-indices.rst b/docs/sphinx/api/rollup-indices.rst new file mode 100644 index 000000000..ea4026811 --- /dev/null +++ b/docs/sphinx/api/rollup-indices.rst @@ -0,0 +1,9 @@ +.. _rollup-indices: + +Rollup Indices +-------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: RollupClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/search-application.rst b/docs/sphinx/api/search-application.rst new file mode 100644 index 000000000..e07fb2fef --- /dev/null +++ b/docs/sphinx/api/search-application.rst @@ -0,0 +1,9 @@ +.. _search-application: + +Search Applications +------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SearchApplicationClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/searchable-snapshots.rst b/docs/sphinx/api/searchable-snapshots.rst new file mode 100644 index 000000000..406320593 --- /dev/null +++ b/docs/sphinx/api/searchable-snapshots.rst @@ -0,0 +1,9 @@ +.. _searchable-snapshots: + +Searchable Snapshots +-------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SearchableSnapshotsClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/security.rst b/docs/sphinx/api/security.rst new file mode 100644 index 000000000..2f77c6aa7 --- /dev/null +++ b/docs/sphinx/api/security.rst @@ -0,0 +1,9 @@ +.. _security: + +Security +-------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SecurityClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/shutdown.rst b/docs/sphinx/api/shutdown.rst new file mode 100644 index 000000000..097fad489 --- /dev/null +++ b/docs/sphinx/api/shutdown.rst @@ -0,0 +1,9 @@ +.. _shutdown: + +Shutdown +-------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: ShutdownClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/snapshot-lifecycle-management.rst b/docs/sphinx/api/snapshot-lifecycle-management.rst new file mode 100644 index 000000000..102b06ffc --- /dev/null +++ b/docs/sphinx/api/snapshot-lifecycle-management.rst @@ -0,0 +1,9 @@ +.. _snapshot-lifecycle-management: + +Snapshot Lifecycle Management (SLM) +----------------------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SlmClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/snapshots.rst b/docs/sphinx/api/snapshots.rst new file mode 100644 index 000000000..050d2648c --- /dev/null +++ b/docs/sphinx/api/snapshots.rst @@ -0,0 +1,9 @@ +.. _snapshots: + +Snapshots +--------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SnapshotClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/snapshottable-features.rst b/docs/sphinx/api/snapshottable-features.rst new file mode 100644 index 000000000..19b6f8ac9 --- /dev/null +++ b/docs/sphinx/api/snapshottable-features.rst @@ -0,0 +1,9 @@ +.. _snapshottable-features: + +Snapshottable Features +---------------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: FeaturesClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/sql.rst b/docs/sphinx/api/sql.rst new file mode 100644 index 000000000..30b1d816c --- /dev/null +++ b/docs/sphinx/api/sql.rst @@ -0,0 +1,9 @@ +.. _sql: + +SQL +--- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SqlClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/synonyms.rst b/docs/sphinx/api/synonyms.rst new file mode 100644 index 000000000..787a5e4f1 --- /dev/null +++ b/docs/sphinx/api/synonyms.rst @@ -0,0 +1,9 @@ +.. _synonyms: + +Synonyms +-------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SynonymsClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/tasks.rst b/docs/sphinx/api/tasks.rst new file mode 100644 index 000000000..363b5de1b --- /dev/null +++ b/docs/sphinx/api/tasks.rst @@ -0,0 +1,9 @@ +.. _tasks: + +Tasks +----- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: TasksClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/text-structure.rst b/docs/sphinx/api/text-structure.rst new file mode 100644 index 000000000..b57ccd37d --- /dev/null +++ b/docs/sphinx/api/text-structure.rst @@ -0,0 +1,9 @@ +.. _text-structure: + +Text Structure +-------------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: TextStructureClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/tls-ssl.rst b/docs/sphinx/api/tls-ssl.rst new file mode 100644 index 000000000..65e571aba --- /dev/null +++ b/docs/sphinx/api/tls-ssl.rst @@ -0,0 +1,9 @@ +.. _tls-ssl: + +TLS/SSL +------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: SslClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/transforms.rst b/docs/sphinx/api/transforms.rst new file mode 100644 index 000000000..2b9e9e4e7 --- /dev/null +++ b/docs/sphinx/api/transforms.rst @@ -0,0 +1,9 @@ +.. _transforms: + +Transforms +---------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: TransformClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/watcher.rst b/docs/sphinx/api/watcher.rst new file mode 100644 index 000000000..a90b7ee13 --- /dev/null +++ b/docs/sphinx/api/watcher.rst @@ -0,0 +1,9 @@ +.. _watcher: + +Watcher +------- +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: WatcherClient + :members: \ No newline at end of file diff --git a/docs/sphinx/api/x-pack.rst b/docs/sphinx/api/x-pack.rst new file mode 100644 index 000000000..3583a0880 --- /dev/null +++ b/docs/sphinx/api/x-pack.rst @@ -0,0 +1,9 @@ +.. _x-pack: + +X-Pack +------ +.. py:module:: elasticsearch.client + :noindex: + +.. autoclass:: XPackClient + :members: \ No newline at end of file diff --git a/docs/sphinx/async.rst b/docs/sphinx/async.rst index 0f0b82123..5a32905eb 100644 --- a/docs/sphinx/async.rst +++ b/docs/sphinx/async.rst @@ -2,6 +2,7 @@ Using Asyncio with Elasticsearch ================================ .. py:module:: elasticsearch + :no-index: Starting in ``elasticsearch-py`` v7.8.0 for Python 3.6+ the ``elasticsearch`` package supports async/await with `Asyncio `_ and `Aiohttp `_. @@ -131,6 +132,7 @@ All async helpers that accept an iterator or generator also accept async iterato and async generators. .. py:module:: elasticsearch.helpers + :no-index: Bulk and Streaming Bulk ~~~~~~~~~~~~~~~~~~~~~~~ @@ -220,6 +222,7 @@ API Reference ------------- .. py:module:: elasticsearch + :no-index: The API of :class:`~elasticsearch.AsyncElasticsearch` is nearly identical to the API of :class:`~elasticsearch.Elasticsearch` with the exception that diff --git a/docs/sphinx/exceptions.rst b/docs/sphinx/exceptions.rst index 32c01d6cb..3c8a32dab 100644 --- a/docs/sphinx/exceptions.rst +++ b/docs/sphinx/exceptions.rst @@ -4,6 +4,7 @@ Exceptions & Warnings ===================== .. py:module:: elasticsearch + :noindex: API Errors ----------