-
Notifications
You must be signed in to change notification settings - Fork 298
Expand file tree
/
Copy pathElasticsearchCatClient.java
More file actions
1827 lines (1617 loc) · 74.5 KB
/
Copy pathElasticsearchCatClient.java
File metadata and controls
1827 lines (1617 loc) · 74.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you 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.
*/
package co.elastic.clients.elasticsearch.cat;
import co.elastic.clients.ApiClient;
import co.elastic.clients.elasticsearch._types.ElasticsearchException;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.transport.ElasticsearchTransport;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.JsonEndpoint;
import co.elastic.clients.transport.Transport;
import co.elastic.clients.transport.TransportOptions;
import co.elastic.clients.util.ObjectBuilder;
import java.io.IOException;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
/**
* Client for the cat namespace.
*/
public class ElasticsearchCatClient extends ApiClient<ElasticsearchTransport, ElasticsearchCatClient> {
public ElasticsearchCatClient(ElasticsearchTransport transport) {
super(transport, null);
}
public ElasticsearchCatClient(ElasticsearchTransport transport, @Nullable TransportOptions transportOptions) {
super(transport, transportOptions);
}
@Override
public ElasticsearchCatClient withTransportOptions(@Nullable TransportOptions transportOptions) {
return new ElasticsearchCatClient(this.transport, transportOptions);
}
// ----- Endpoint: cat.aliases
/**
* Get aliases.
* <p>
* Get the cluster's index aliases, including filter and routing information.
* This API does not return data stream aliases.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or the Kibana console. They are not intended for use by applications.
* For application consumption, use the aliases API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases">Documentation
* on elastic.co</a>
*/
public AliasesResponse aliases(AliasesRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<AliasesRequest, AliasesResponse, ErrorResponse> endpoint = (JsonEndpoint<AliasesRequest, AliasesResponse, ErrorResponse>) AliasesRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get aliases.
* <p>
* Get the cluster's index aliases, including filter and routing information.
* This API does not return data stream aliases.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or the Kibana console. They are not intended for use by applications.
* For application consumption, use the aliases API.
*
* @param fn
* a function that initializes a builder to create the
* {@link AliasesRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases">Documentation
* on elastic.co</a>
*/
public final AliasesResponse aliases(Function<AliasesRequest.Builder, ObjectBuilder<AliasesRequest>> fn)
throws IOException, ElasticsearchException {
return aliases(fn.apply(new AliasesRequest.Builder()).build());
}
/**
* Get aliases.
* <p>
* Get the cluster's index aliases, including filter and routing information.
* This API does not return data stream aliases.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or the Kibana console. They are not intended for use by applications.
* For application consumption, use the aliases API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-aliases">Documentation
* on elastic.co</a>
*/
public AliasesResponse aliases() throws IOException, ElasticsearchException {
return this.transport.performRequest(new AliasesRequest.Builder().build(), AliasesRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.allocation
/**
* Get shard allocation information.
* <p>
* Get a snapshot of the number of shards allocated to each data node and their
* disk space.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation">Documentation
* on elastic.co</a>
*/
public AllocationResponse allocation(AllocationRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<AllocationRequest, AllocationResponse, ErrorResponse> endpoint = (JsonEndpoint<AllocationRequest, AllocationResponse, ErrorResponse>) AllocationRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get shard allocation information.
* <p>
* Get a snapshot of the number of shards allocated to each data node and their
* disk space.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications.
*
* @param fn
* a function that initializes a builder to create the
* {@link AllocationRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation">Documentation
* on elastic.co</a>
*/
public final AllocationResponse allocation(Function<AllocationRequest.Builder, ObjectBuilder<AllocationRequest>> fn)
throws IOException, ElasticsearchException {
return allocation(fn.apply(new AllocationRequest.Builder()).build());
}
/**
* Get shard allocation information.
* <p>
* Get a snapshot of the number of shards allocated to each data node and their
* disk space.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-allocation">Documentation
* on elastic.co</a>
*/
public AllocationResponse allocation() throws IOException, ElasticsearchException {
return this.transport.performRequest(new AllocationRequest.Builder().build(), AllocationRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.component_templates
/**
* Get component templates.
* <p>
* Get information about component templates in a cluster. Component templates
* are building blocks for constructing index templates that specify index
* mappings, settings, and aliases.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the get component template API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates">Documentation
* on elastic.co</a>
*/
public ComponentTemplatesResponse componentTemplates(ComponentTemplatesRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<ComponentTemplatesRequest, ComponentTemplatesResponse, ErrorResponse> endpoint = (JsonEndpoint<ComponentTemplatesRequest, ComponentTemplatesResponse, ErrorResponse>) ComponentTemplatesRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get component templates.
* <p>
* Get information about component templates in a cluster. Component templates
* are building blocks for constructing index templates that specify index
* mappings, settings, and aliases.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the get component template API.
*
* @param fn
* a function that initializes a builder to create the
* {@link ComponentTemplatesRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates">Documentation
* on elastic.co</a>
*/
public final ComponentTemplatesResponse componentTemplates(
Function<ComponentTemplatesRequest.Builder, ObjectBuilder<ComponentTemplatesRequest>> fn)
throws IOException, ElasticsearchException {
return componentTemplates(fn.apply(new ComponentTemplatesRequest.Builder()).build());
}
/**
* Get component templates.
* <p>
* Get information about component templates in a cluster. Component templates
* are building blocks for constructing index templates that specify index
* mappings, settings, and aliases.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the get component template API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-component-templates">Documentation
* on elastic.co</a>
*/
public ComponentTemplatesResponse componentTemplates() throws IOException, ElasticsearchException {
return this.transport.performRequest(new ComponentTemplatesRequest.Builder().build(),
ComponentTemplatesRequest._ENDPOINT, this.transportOptions);
}
// ----- Endpoint: cat.count
/**
* Get a document count.
* <p>
* Get quick access to a document count for a data stream, an index, or an
* entire cluster. The document count only includes live documents, not deleted
* documents which have not yet been removed by the merge process.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the count API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count">Documentation
* on elastic.co</a>
*/
public CountResponse count(CountRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<CountRequest, CountResponse, ErrorResponse> endpoint = (JsonEndpoint<CountRequest, CountResponse, ErrorResponse>) CountRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get a document count.
* <p>
* Get quick access to a document count for a data stream, an index, or an
* entire cluster. The document count only includes live documents, not deleted
* documents which have not yet been removed by the merge process.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the count API.
*
* @param fn
* a function that initializes a builder to create the
* {@link CountRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count">Documentation
* on elastic.co</a>
*/
public final CountResponse count(Function<CountRequest.Builder, ObjectBuilder<CountRequest>> fn)
throws IOException, ElasticsearchException {
return count(fn.apply(new CountRequest.Builder()).build());
}
/**
* Get a document count.
* <p>
* Get quick access to a document count for a data stream, an index, or an
* entire cluster. The document count only includes live documents, not deleted
* documents which have not yet been removed by the merge process.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the count API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-count">Documentation
* on elastic.co</a>
*/
public CountResponse count() throws IOException, ElasticsearchException {
return this.transport.performRequest(new CountRequest.Builder().build(), CountRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.fielddata
/**
* Get field data cache information.
* <p>
* Get the amount of heap memory currently used by the field data cache on every
* data node in the cluster.
* <p>
* IMPORTANT: cat APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the nodes stats API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata">Documentation
* on elastic.co</a>
*/
public FielddataResponse fielddata(FielddataRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<FielddataRequest, FielddataResponse, ErrorResponse> endpoint = (JsonEndpoint<FielddataRequest, FielddataResponse, ErrorResponse>) FielddataRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get field data cache information.
* <p>
* Get the amount of heap memory currently used by the field data cache on every
* data node in the cluster.
* <p>
* IMPORTANT: cat APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the nodes stats API.
*
* @param fn
* a function that initializes a builder to create the
* {@link FielddataRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata">Documentation
* on elastic.co</a>
*/
public final FielddataResponse fielddata(Function<FielddataRequest.Builder, ObjectBuilder<FielddataRequest>> fn)
throws IOException, ElasticsearchException {
return fielddata(fn.apply(new FielddataRequest.Builder()).build());
}
/**
* Get field data cache information.
* <p>
* Get the amount of heap memory currently used by the field data cache on every
* data node in the cluster.
* <p>
* IMPORTANT: cat APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the nodes stats API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-fielddata">Documentation
* on elastic.co</a>
*/
public FielddataResponse fielddata() throws IOException, ElasticsearchException {
return this.transport.performRequest(new FielddataRequest.Builder().build(), FielddataRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.health
/**
* Get the cluster health status.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the cluster health API. This API is often used
* to check malfunctioning clusters. To help you track cluster health alongside
* log files and alerting systems, the API returns timestamps in two formats:
* <code>HH:MM:SS</code>, which is human-readable but includes no date
* information; <code>Unix epoch time</code>, which is machine-sortable and
* includes date information. The latter format is useful for cluster recoveries
* that take multiple days. You can use the cat health API to verify cluster
* health across multiple nodes. You also can use the API to track the recovery
* of a large cluster over a longer period of time.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health">Documentation
* on elastic.co</a>
*/
public HealthResponse health(HealthRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<HealthRequest, HealthResponse, ErrorResponse> endpoint = (JsonEndpoint<HealthRequest, HealthResponse, ErrorResponse>) HealthRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get the cluster health status.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the cluster health API. This API is often used
* to check malfunctioning clusters. To help you track cluster health alongside
* log files and alerting systems, the API returns timestamps in two formats:
* <code>HH:MM:SS</code>, which is human-readable but includes no date
* information; <code>Unix epoch time</code>, which is machine-sortable and
* includes date information. The latter format is useful for cluster recoveries
* that take multiple days. You can use the cat health API to verify cluster
* health across multiple nodes. You also can use the API to track the recovery
* of a large cluster over a longer period of time.
*
* @param fn
* a function that initializes a builder to create the
* {@link HealthRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health">Documentation
* on elastic.co</a>
*/
public final HealthResponse health(Function<HealthRequest.Builder, ObjectBuilder<HealthRequest>> fn)
throws IOException, ElasticsearchException {
return health(fn.apply(new HealthRequest.Builder()).build());
}
/**
* Get the cluster health status.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the cluster health API. This API is often used
* to check malfunctioning clusters. To help you track cluster health alongside
* log files and alerting systems, the API returns timestamps in two formats:
* <code>HH:MM:SS</code>, which is human-readable but includes no date
* information; <code>Unix epoch time</code>, which is machine-sortable and
* includes date information. The latter format is useful for cluster recoveries
* that take multiple days. You can use the cat health API to verify cluster
* health across multiple nodes. You also can use the API to track the recovery
* of a large cluster over a longer period of time.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-health">Documentation
* on elastic.co</a>
*/
public HealthResponse health() throws IOException, ElasticsearchException {
return this.transport.performRequest(new HealthRequest.Builder().build(), HealthRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.help
/**
* Get CAT help.
* <p>
* Get help for the CAT APIs.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-cat">Documentation
* on elastic.co</a>
*/
public HelpResponse help() throws IOException, ElasticsearchException {
return this.transport.performRequest(HelpRequest._INSTANCE, HelpRequest._ENDPOINT, this.transportOptions);
}
// ----- Endpoint: cat.indices
/**
* Get index information.
* <p>
* Get high-level information about indices in a cluster, including backing
* indices for data streams.
* <p>
* Use this request to get the following information for each index in a
* cluster:
* <ul>
* <li>shard count</li>
* <li>document count</li>
* <li>deleted document count</li>
* <li>primary store size</li>
* <li>total store size of all shards, including shard replicas</li>
* </ul>
* <p>
* These metrics are retrieved directly from Lucene, which Elasticsearch uses
* internally to power indexing and search. As a result, all document counts
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* CAT APIs are only intended for human consumption using the command line or
* Kibana console. They are not intended for use by applications. For
* application consumption, use an index endpoint.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices">Documentation
* on elastic.co</a>
*/
public IndicesResponse indices(IndicesRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<IndicesRequest, IndicesResponse, ErrorResponse> endpoint = (JsonEndpoint<IndicesRequest, IndicesResponse, ErrorResponse>) IndicesRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get index information.
* <p>
* Get high-level information about indices in a cluster, including backing
* indices for data streams.
* <p>
* Use this request to get the following information for each index in a
* cluster:
* <ul>
* <li>shard count</li>
* <li>document count</li>
* <li>deleted document count</li>
* <li>primary store size</li>
* <li>total store size of all shards, including shard replicas</li>
* </ul>
* <p>
* These metrics are retrieved directly from Lucene, which Elasticsearch uses
* internally to power indexing and search. As a result, all document counts
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* CAT APIs are only intended for human consumption using the command line or
* Kibana console. They are not intended for use by applications. For
* application consumption, use an index endpoint.
*
* @param fn
* a function that initializes a builder to create the
* {@link IndicesRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices">Documentation
* on elastic.co</a>
*/
public final IndicesResponse indices(Function<IndicesRequest.Builder, ObjectBuilder<IndicesRequest>> fn)
throws IOException, ElasticsearchException {
return indices(fn.apply(new IndicesRequest.Builder()).build());
}
/**
* Get index information.
* <p>
* Get high-level information about indices in a cluster, including backing
* indices for data streams.
* <p>
* Use this request to get the following information for each index in a
* cluster:
* <ul>
* <li>shard count</li>
* <li>document count</li>
* <li>deleted document count</li>
* <li>primary store size</li>
* <li>total store size of all shards, including shard replicas</li>
* </ul>
* <p>
* These metrics are retrieved directly from Lucene, which Elasticsearch uses
* internally to power indexing and search. As a result, all document counts
* include hidden nested documents. To get an accurate count of Elasticsearch
* documents, use the cat count or count APIs.
* <p>
* NOTE: Storage metrics reported by this API reflect the post-compression size
* of the indices on disk. Because these values are calculated after
* Elasticsearch compresses the data and processes deletions, they are typically
* significantly smaller than the raw, uncompressed data volume ingested.
* <p>
* IMPORTANT: For Elastic Cloud Serverless, ingest billing is based on the raw,
* uncompressed data volume, not the post-compression metrics reported here. To
* learn more, refer to <a href=
* "https://www.elastic.co/docs/deploy-manage/cloud-organization/billing/elasticsearch-billing-dimensions">Elasticsearch
* billing dimensions</a>.
* <p>
* CAT APIs are only intended for human consumption using the command line or
* Kibana console. They are not intended for use by applications. For
* application consumption, use an index endpoint.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-indices">Documentation
* on elastic.co</a>
*/
public IndicesResponse indices() throws IOException, ElasticsearchException {
return this.transport.performRequest(new IndicesRequest.Builder().build(), IndicesRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.master
/**
* Get master node information.
* <p>
* Get information about the master node, including the ID, bound IP address,
* and name.
* <p>
* IMPORTANT: cat APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the nodes info API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master">Documentation
* on elastic.co</a>
*/
public MasterResponse master(MasterRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<MasterRequest, MasterResponse, ErrorResponse> endpoint = (JsonEndpoint<MasterRequest, MasterResponse, ErrorResponse>) MasterRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get master node information.
* <p>
* Get information about the master node, including the ID, bound IP address,
* and name.
* <p>
* IMPORTANT: cat APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the nodes info API.
*
* @param fn
* a function that initializes a builder to create the
* {@link MasterRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master">Documentation
* on elastic.co</a>
*/
public final MasterResponse master(Function<MasterRequest.Builder, ObjectBuilder<MasterRequest>> fn)
throws IOException, ElasticsearchException {
return master(fn.apply(new MasterRequest.Builder()).build());
}
/**
* Get master node information.
* <p>
* Get information about the master node, including the ID, bound IP address,
* and name.
* <p>
* IMPORTANT: cat APIs are only intended for human consumption using the command
* line or Kibana console. They are not intended for use by applications. For
* application consumption, use the nodes info API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-master">Documentation
* on elastic.co</a>
*/
public MasterResponse master() throws IOException, ElasticsearchException {
return this.transport.performRequest(new MasterRequest.Builder().build(), MasterRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.ml_data_frame_analytics
/**
* Get data frame analytics jobs.
* <p>
* Get configuration and usage information about data frame analytics jobs.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get data frame analytics jobs statistics
* API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics">Documentation
* on elastic.co</a>
*/
public MlDataFrameAnalyticsResponse mlDataFrameAnalytics(MlDataFrameAnalyticsRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<MlDataFrameAnalyticsRequest, MlDataFrameAnalyticsResponse, ErrorResponse> endpoint = (JsonEndpoint<MlDataFrameAnalyticsRequest, MlDataFrameAnalyticsResponse, ErrorResponse>) MlDataFrameAnalyticsRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get data frame analytics jobs.
* <p>
* Get configuration and usage information about data frame analytics jobs.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get data frame analytics jobs statistics
* API.
*
* @param fn
* a function that initializes a builder to create the
* {@link MlDataFrameAnalyticsRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics">Documentation
* on elastic.co</a>
*/
public final MlDataFrameAnalyticsResponse mlDataFrameAnalytics(
Function<MlDataFrameAnalyticsRequest.Builder, ObjectBuilder<MlDataFrameAnalyticsRequest>> fn)
throws IOException, ElasticsearchException {
return mlDataFrameAnalytics(fn.apply(new MlDataFrameAnalyticsRequest.Builder()).build());
}
/**
* Get data frame analytics jobs.
* <p>
* Get configuration and usage information about data frame analytics jobs.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get data frame analytics jobs statistics
* API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-data-frame-analytics">Documentation
* on elastic.co</a>
*/
public MlDataFrameAnalyticsResponse mlDataFrameAnalytics() throws IOException, ElasticsearchException {
return this.transport.performRequest(new MlDataFrameAnalyticsRequest.Builder().build(),
MlDataFrameAnalyticsRequest._ENDPOINT, this.transportOptions);
}
// ----- Endpoint: cat.ml_datafeeds
/**
* Get datafeeds.
* <p>
* Get configuration and usage information about datafeeds. This API returns a
* maximum of 10,000 datafeeds. If the Elasticsearch security features are
* enabled, you must have <code>monitor_ml</code>, <code>monitor</code>,
* <code>manage_ml</code>, or <code>manage</code> cluster privileges to use this
* API.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get datafeed statistics API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds">Documentation
* on elastic.co</a>
*/
public MlDatafeedsResponse mlDatafeeds(MlDatafeedsRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<MlDatafeedsRequest, MlDatafeedsResponse, ErrorResponse> endpoint = (JsonEndpoint<MlDatafeedsRequest, MlDatafeedsResponse, ErrorResponse>) MlDatafeedsRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get datafeeds.
* <p>
* Get configuration and usage information about datafeeds. This API returns a
* maximum of 10,000 datafeeds. If the Elasticsearch security features are
* enabled, you must have <code>monitor_ml</code>, <code>monitor</code>,
* <code>manage_ml</code>, or <code>manage</code> cluster privileges to use this
* API.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get datafeed statistics API.
*
* @param fn
* a function that initializes a builder to create the
* {@link MlDatafeedsRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds">Documentation
* on elastic.co</a>
*/
public final MlDatafeedsResponse mlDatafeeds(
Function<MlDatafeedsRequest.Builder, ObjectBuilder<MlDatafeedsRequest>> fn)
throws IOException, ElasticsearchException {
return mlDatafeeds(fn.apply(new MlDatafeedsRequest.Builder()).build());
}
/**
* Get datafeeds.
* <p>
* Get configuration and usage information about datafeeds. This API returns a
* maximum of 10,000 datafeeds. If the Elasticsearch security features are
* enabled, you must have <code>monitor_ml</code>, <code>monitor</code>,
* <code>manage_ml</code>, or <code>manage</code> cluster privileges to use this
* API.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get datafeed statistics API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-datafeeds">Documentation
* on elastic.co</a>
*/
public MlDatafeedsResponse mlDatafeeds() throws IOException, ElasticsearchException {
return this.transport.performRequest(new MlDatafeedsRequest.Builder().build(), MlDatafeedsRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.ml_jobs
/**
* Get anomaly detection jobs.
* <p>
* Get configuration and usage information for anomaly detection jobs. This API
* returns a maximum of 10,000 jobs. If the Elasticsearch security features are
* enabled, you must have <code>monitor_ml</code>, <code>monitor</code>,
* <code>manage_ml</code>, or <code>manage</code> cluster privileges to use this
* API.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get anomaly detection job statistics API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs">Documentation
* on elastic.co</a>
*/
public MlJobsResponse mlJobs(MlJobsRequest request) throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<MlJobsRequest, MlJobsResponse, ErrorResponse> endpoint = (JsonEndpoint<MlJobsRequest, MlJobsResponse, ErrorResponse>) MlJobsRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get anomaly detection jobs.
* <p>
* Get configuration and usage information for anomaly detection jobs. This API
* returns a maximum of 10,000 jobs. If the Elasticsearch security features are
* enabled, you must have <code>monitor_ml</code>, <code>monitor</code>,
* <code>manage_ml</code>, or <code>manage</code> cluster privileges to use this
* API.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get anomaly detection job statistics API.
*
* @param fn
* a function that initializes a builder to create the
* {@link MlJobsRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs">Documentation
* on elastic.co</a>
*/
public final MlJobsResponse mlJobs(Function<MlJobsRequest.Builder, ObjectBuilder<MlJobsRequest>> fn)
throws IOException, ElasticsearchException {
return mlJobs(fn.apply(new MlJobsRequest.Builder()).build());
}
/**
* Get anomaly detection jobs.
* <p>
* Get configuration and usage information for anomaly detection jobs. This API
* returns a maximum of 10,000 jobs. If the Elasticsearch security features are
* enabled, you must have <code>monitor_ml</code>, <code>monitor</code>,
* <code>manage_ml</code>, or <code>manage</code> cluster privileges to use this
* API.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get anomaly detection job statistics API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-jobs">Documentation
* on elastic.co</a>
*/
public MlJobsResponse mlJobs() throws IOException, ElasticsearchException {
return this.transport.performRequest(new MlJobsRequest.Builder().build(), MlJobsRequest._ENDPOINT,
this.transportOptions);
}
// ----- Endpoint: cat.ml_trained_models
/**
* Get trained models.
* <p>
* Get configuration and usage information about inference trained models.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get trained models statistics API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models">Documentation
* on elastic.co</a>
*/
public MlTrainedModelsResponse mlTrainedModels(MlTrainedModelsRequest request)
throws IOException, ElasticsearchException {
@SuppressWarnings("unchecked")
JsonEndpoint<MlTrainedModelsRequest, MlTrainedModelsResponse, ErrorResponse> endpoint = (JsonEndpoint<MlTrainedModelsRequest, MlTrainedModelsResponse, ErrorResponse>) MlTrainedModelsRequest._ENDPOINT;
return this.transport.performRequest(request, endpoint, this.transportOptions);
}
/**
* Get trained models.
* <p>
* Get configuration and usage information about inference trained models.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get trained models statistics API.
*
* @param fn
* a function that initializes a builder to create the
* {@link MlTrainedModelsRequest}
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models">Documentation
* on elastic.co</a>
*/
public final MlTrainedModelsResponse mlTrainedModels(
Function<MlTrainedModelsRequest.Builder, ObjectBuilder<MlTrainedModelsRequest>> fn)
throws IOException, ElasticsearchException {
return mlTrainedModels(fn.apply(new MlTrainedModelsRequest.Builder()).build());
}
/**
* Get trained models.
* <p>
* Get configuration and usage information about inference trained models.
* <p>
* IMPORTANT: CAT APIs are only intended for human consumption using the Kibana
* console or command line. They are not intended for use by applications. For
* application consumption, use the get trained models statistics API.
*
* @see <a href=
* "https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cat-ml-trained-models">Documentation
* on elastic.co</a>
*/
public MlTrainedModelsResponse mlTrainedModels() throws IOException, ElasticsearchException {