@@ -8,209 +8,170 @@ reporting, and graph capabilities into one easy-to-install package.
88While the X-Pack components are designed to work together seamlessly, you can
99easily enable or disable the features you want to use.
1010
11+ .. py :module :: elasticsearch.client
1112
12- Info
13- ----
1413
15- ` X-Pack info < https://www.elastic.co/guide/en/elasticsearch/reference/master/info-api.html >`_
16- provides general info about the installed X-Pack.
14+ X-Pack Info
15+ -----------
1716
18- .. py :module :: elasticsearch.client.xpack
17+ `X-Pack Info API <https://www.elastic.co/guide/en/elasticsearch/reference/master/info-api.html >`_
18+ provides general info about the installed X-Pack.
1919
2020.. autoclass :: XPackClient
2121 :members:
2222
23+ Cross-Cluster Replication
24+ -------------------------
2325
24- Graph Explore APIs
25- ------------------
26-
27- `Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/master/graph-explore-api.html >`_
28- enables you to extract and summarize information about the documents and terms in your Elasticsearch index.
29-
30- .. py :module :: elasticsearch.client.graph
31-
26+ `Cross-Cluster Replication APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-apis.html >`_
27+ are used to perform cross-cluster replication operations.
3228
33- .. autoclass :: GraphClient
29+ .. autoclass :: CcrClient
3430 :members:
3531
36- Licensing APIs
37- --------------
32+ Enrich
33+ ------
3834
39- `Licensing API <https://www.elastic.co/guide/en/elasticsearch/reference/master/licensing -apis.html >`_
40- can be used to manage your licences .
35+ `Enrich APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/enrich -apis.html >`_
36+ can be used to add data from your existing indices to incoming documents during ingest .
4137
38+ .. autoclass :: EnrichClient
39+ :members:
4240
43- .. py :module :: elasticsearch.client.license
41+ EQL
42+ ---
4443
44+ `EQL APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/eql.html >`_
45+ accept EQL to query event-based time series data, such as logs, metrics, and traces.
4546
46- .. autoclass :: LicenseClient
47+ .. autoclass :: EqlClient
4748 :members:
4849
49- Machine Learning APIs
50- ---------------------
50+ Graph Explore
51+ -------------
5152
52- `Machine Learning <https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-apis.html >`_
53- can be useful for discovering new patterns about your data. For a more detailed explanation
54- about X-Pack's machine learning please refer to the official documentation.
53+ `Graph Explore API <https://www.elastic.co/guide/en/elasticsearch/reference/master/graph-explore-api.html >`_
54+ enables you to extract and summarize information about the documents and terms in your Elasticsearch index.
5555
56+ .. autoclass :: GraphClient
57+ :members:
5658
57- .. py :module :: elasticsearch.client.ml
59+ Index Lifecycle Management (ILM)
60+ --------------------------------
5861
62+ `Index Lifecycle Management APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-management-api.html >`_
63+ used to set up policies to automatically manage the index lifecycle.
5964
60- .. autoclass :: MlClient
65+ .. autoclass :: IlmClient
6166 :members:
6267
63- Security APIs
64- -------------
65-
66- `Security API <https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api.html >`_
67- can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.
68-
69- .. py :module :: elasticsearch.client.security
68+ Licensing
69+ ---------
7070
71+ `License APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/licensing-apis.html >`_
72+ can be used to manage your licences.
7173
72- .. autoclass :: SecurityClient
74+ .. autoclass :: LicenseClient
7375 :members:
7476
75- Watcher APIs
76- -------------
77-
78- `Watcher API <https://www.elastic.co/guide/en/elasticsearch/reference/master/watcher-api.html >`_
79- can be used to notify you when certain pre-defined thresholds have happened.
77+ Machine Learning
78+ ----------------
8079
81- .. py :module :: elasticsearch.client.watcher
80+ `Machine Learning APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/ml-apis.html >`_
81+ can be useful for discovering new patterns about your data. For a more detailed explanation
82+ about X-Pack's machine learning please refer to the official documentation.
8283
83- .. autoclass :: WatcherClient
84+ .. autoclass :: MlClient
8485 :members:
8586
86-
87- Migration APIs
88- ---------------
87+ Migration
88+ ---------
8989
9090`Migration API <https://www.elastic.co/guide/en/elasticsearch/reference/master/migration-api.html >`_
9191helps simplify upgrading X-Pack indices from one version to another.
9292
93- .. py :module :: elasticsearch.client.migration
94-
9593.. autoclass :: MigrationClient
9694 :members:
9795
96+ Monitoring
97+ ----------
9898
99- Enrich APIs
100- ------------
101-
102- `Enrich API <https://www.elastic.co/guide/en/elasticsearch/reference/master/enrich-apis.html >`_
103- can be used to add data from your existing indices to incoming documents during ingest.
104-
105- .. py :module :: elasticsearch.client.enrich
106-
107- .. autoclass :: EnrichClient
108- :members:
109-
110- SQL APIs
111- --------
112-
113- The `SQL REST API <https://www.elastic.co/guide/en/elasticsearch/reference/master/sql-rest.html >`_
114- accepts SQL in a JSON document, executes it, and returns the results.
115-
116- .. py :module :: elasticsearch.client.sql
99+ `Monitoring API <https://www.elastic.co/guide/en/elasticsearch/reference/master/es-monitoring.html >`_
100+ used to collect data from the Elasticsearch nodes, Logstash nodes, Kibana instances, and Beats in your cluster.
117101
118- .. autoclass :: SqlClient
102+ .. autoclass :: MonitoringClient
119103 :members:
120104
121- Cross-Cluster Replication APIs
122- -------------------------------
105+ Rollup
106+ ------
123107
124- `Cross-Cluster Replication API <https://www.elastic.co/guide/en/elasticsearch/reference/master/ccr-apis.html >`_
125- used to perform cross-cluster replication operations.
126-
127- .. py :module :: elasticsearch.client.ccr
108+ `Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-apis.html >`_
109+ enables searching through rolled-up data using the standard query DSL.
128110
129- .. autoclass :: CcrClient
111+ .. autoclass :: RollupClient
130112 :members:
131113
114+ Searchable Snapshots
115+ --------------------
132116
133- Monitoring APIs
134- ----------------
135-
136- `Monitoring API <https://www.elastic.co/guide/en/elasticsearch/reference/master/es-monitoring.html >`_
137- used to collect data from the Elasticsearch nodes, Logstash nodes, Kibana instances, and Beats in your cluster.
138-
139- .. py :module :: elasticsearch.client.monitoring
117+ `Searchable Snapshots API <https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html >`_
118+ used to perform searchable snapshots operations.
140119
141- .. autoclass :: MonitoringClient
120+ .. autoclass :: SearchableSnapshotsClient
142121 :members:
143122
123+ Security
124+ --------
144125
145- Rollup APIs
146- ------------
147-
148- `Rollup API <https://www.elastic.co/guide/en/elasticsearch/reference/master/rollup-apis.html >`_
149- enables searching through rolled-up data using the standard query DSL.
150-
151- .. py :module :: elasticsearch.client.rollup
126+ `Security API <https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api.html >`_
127+ can be used to help secure your Elasticsearch cluster. Integrating with LDAP and Active Directory.
152128
153- .. autoclass :: RollupClient
129+ .. autoclass :: SecurityClient
154130 :members:
155131
156-
157- Snapshot Lifecycle Management APIs
132+ Snapshot Lifecycle Management (SLM)
158133-----------------------------------
159134
160135`Snapshot Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/master/snapshot-lifecycle-management-api.html >`_
161136can be used to set up policies to automatically take snapshots and control how long they are retained.
162137
163- .. py :module :: elasticsearch.client.slm
164-
165138.. autoclass :: SlmClient
166139 :members:
167140
141+ SQL
142+ ---
168143
169- Searchable Snapshots APIs
170- -------------------------
171-
172- `Searchable Snapshots API <https://www.elastic.co/guide/en/elasticsearch/reference/master/searchable-snapshots-apis.html >`_
173- used to perform searchable snapshots operations.
174-
175- .. py :module :: elasticsearch.client.searchable_snapshots
144+ The `SQL REST API <https://www.elastic.co/guide/en/elasticsearch/reference/master/sql-rest.html >`_
145+ accepts SQL in a JSON document, executes it, and returns the results.
176146
177- .. autoclass :: SearchableSnapshotsClient
147+ .. autoclass :: SqlClient
178148 :members:
179149
150+ SSL Certificate
151+ ---------------
180152
181- Index Lifecycle Management APIs
182- --------------------------------
183-
184- `Index Lifecycle Management API <https://www.elastic.co/guide/en/elasticsearch/reference/master/index-lifecycle-management-api.html >`_
185- used to set up policies to automatically manage the index lifecycle.
186-
187- .. py :module :: elasticsearch.client.ilm
153+ `SSL Certificate API <https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-ssl.html >`_
154+ enables you to retrieve information about the X.509 certificates that are used
155+ to encrypt communications in your Elasticsearch cluster.
188156
189- .. autoclass :: IlmClient
157+ .. autoclass :: SslClient
190158 :members:
191159
192-
193- Transform APIs
194- ---------------
160+ Transform
161+ ---------
195162
196163`Transform API <https://www.elastic.co/guide/en/elasticsearch/reference/master/transform-apis.html >`_
197164manages transformation operations from grabbing data from source indices, transforms it, and
198165saves it to a destination index.
199166
200- .. py :module :: elasticsearch.client.transform
201-
202167.. autoclass :: TransformClient
203168 :members:
204169
170+ Watcher
171+ -------
205172
206- Deprecation APIs
207- -----------------
208-
209- `Deprecation API <https://www.elastic.co/guide/en/elasticsearch/reference/master/migration-api-deprecation.html >`_
210- used to retrieve information about different cluster, node, and index level settings that use deprecated features
211- that will be removed or changed in the next major version.
212-
213- .. py :module :: elasticsearch.client.deprecation
173+ `Watcher APIs <https://www.elastic.co/guide/en/elasticsearch/reference/master/watcher-api.html >`_
174+ can be used to notify you when certain pre-defined thresholds have happened.
214175
215- .. autoclass :: DeprecationClient
176+ .. autoclass :: WatcherClient
216177 :members:
0 commit comments