-
Notifications
You must be signed in to change notification settings - Fork 964
/
Client.php
1564 lines (1443 loc) · 87.6 KB
/
Client.php
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
<?php
declare(strict_types = 1);
namespace Elasticsearch;
use Elasticsearch\Common\Exceptions\BadMethodCallException;
use Elasticsearch\Common\Exceptions\InvalidArgumentException;
use Elasticsearch\Common\Exceptions\NoNodesAvailableException;
use Elasticsearch\Common\Exceptions\BadRequest400Exception;
use Elasticsearch\Common\Exceptions\Missing404Exception;
use Elasticsearch\Common\Exceptions\TransportException;
use Elasticsearch\Endpoints\AbstractEndpoint;
use Elasticsearch\Namespaces\AbstractNamespace;
use Elasticsearch\Namespaces\NamespaceBuilderInterface;
use Elasticsearch\Namespaces\BooleanRequestWrapper;
use Elasticsearch\Namespaces\CatNamespace;
use Elasticsearch\Namespaces\ClusterNamespace;
use Elasticsearch\Namespaces\IndicesNamespace;
use Elasticsearch\Namespaces\IngestNamespace;
use Elasticsearch\Namespaces\NodesNamespace;
use Elasticsearch\Namespaces\SnapshotNamespace;
use Elasticsearch\Namespaces\TasksNamespace;
use Elasticsearch\Namespaces\AsyncSearchNamespace;
use Elasticsearch\Namespaces\AutoscalingNamespace;
use Elasticsearch\Namespaces\CcrNamespace;
use Elasticsearch\Namespaces\DataFrameTransformDeprecatedNamespace;
use Elasticsearch\Namespaces\EnrichNamespace;
use Elasticsearch\Namespaces\EqlNamespace;
use Elasticsearch\Namespaces\GraphNamespace;
use Elasticsearch\Namespaces\IlmNamespace;
use Elasticsearch\Namespaces\LicenseNamespace;
use Elasticsearch\Namespaces\MigrationNamespace;
use Elasticsearch\Namespaces\MlNamespace;
use Elasticsearch\Namespaces\MonitoringNamespace;
use Elasticsearch\Namespaces\RollupNamespace;
use Elasticsearch\Namespaces\SecurityNamespace;
use Elasticsearch\Namespaces\SlmNamespace;
use Elasticsearch\Namespaces\SqlNamespace;
use Elasticsearch\Namespaces\SslNamespace;
use Elasticsearch\Namespaces\TransformNamespace;
use Elasticsearch\Namespaces\WatcherNamespace;
use Elasticsearch\Namespaces\XpackNamespace;
/**
* Class Client
* Generated running $ php util/GenerateEndpoints.php 7.7
*
* @category Elasticsearch
* @package Elasticsearch
* @author Enrico Zimuel <enrico.zimuel@elastic.co>
* @license http://www.apache.org/licenses/LICENSE-2.0 Apache2
* @link http://elastic.co
*/
class Client
{
const VERSION = '7.7';
/**
* @var Transport
*/
public $transport;
/**
* @var array
*/
protected $params;
/**
* @var callable
*/
protected $endpoints;
/**
* @var NamespaceBuilderInterface[]
*/
protected $registeredNamespaces = [];
/**
* @var CatNamespace
*/
protected $cat;
/**
* @var ClusterNamespace
*/
protected $cluster;
/**
* @var IndicesNamespace
*/
protected $indices;
/**
* @var IngestNamespace
*/
protected $ingest;
/**
* @var NodesNamespace
*/
protected $nodes;
/**
* @var SnapshotNamespace
*/
protected $snapshot;
/**
* @var TasksNamespace
*/
protected $tasks;
/**
* @var AsyncSearchNamespace
*/
protected $asyncSearch;
/**
* @var AutoscalingNamespace
*/
protected $autoscaling;
/**
* @var CcrNamespace
*/
protected $ccr;
/**
* @var DataFrameTransformDeprecatedNamespace
*/
protected $dataFrameTransformDeprecated;
/**
* @var EnrichNamespace
*/
protected $enrich;
/**
* @var EqlNamespace
*/
protected $eql;
/**
* @var GraphNamespace
*/
protected $graph;
/**
* @var IlmNamespace
*/
protected $ilm;
/**
* @var LicenseNamespace
*/
protected $license;
/**
* @var MigrationNamespace
*/
protected $migration;
/**
* @var MlNamespace
*/
protected $ml;
/**
* @var MonitoringNamespace
*/
protected $monitoring;
/**
* @var RollupNamespace
*/
protected $rollup;
/**
* @var SecurityNamespace
*/
protected $security;
/**
* @var SlmNamespace
*/
protected $slm;
/**
* @var SqlNamespace
*/
protected $sql;
/**
* @var SslNamespace
*/
protected $ssl;
/**
* @var TransformNamespace
*/
protected $transform;
/**
* @var WatcherNamespace
*/
protected $watcher;
/**
* @var XpackNamespace
*/
protected $xpack;
/**
* Client constructor
*
* @param Transport $transport
* @param callable $endpoint
* @param AbstractNamespace[] $registeredNamespaces
*/
public function __construct(Transport $transport, callable $endpoint, array $registeredNamespaces)
{
$this->transport = $transport;
$this->endpoints = $endpoint;
$this->cat = new CatNamespace($transport, $endpoint);
$this->cluster = new ClusterNamespace($transport, $endpoint);
$this->indices = new IndicesNamespace($transport, $endpoint);
$this->ingest = new IngestNamespace($transport, $endpoint);
$this->nodes = new NodesNamespace($transport, $endpoint);
$this->snapshot = new SnapshotNamespace($transport, $endpoint);
$this->tasks = new TasksNamespace($transport, $endpoint);
$this->asyncSearch = new AsyncSearchNamespace($transport, $endpoint);
$this->autoscaling = new AutoscalingNamespace($transport, $endpoint);
$this->ccr = new CcrNamespace($transport, $endpoint);
$this->dataFrameTransformDeprecated = new DataFrameTransformDeprecatedNamespace($transport, $endpoint);
$this->enrich = new EnrichNamespace($transport, $endpoint);
$this->eql = new EqlNamespace($transport, $endpoint);
$this->graph = new GraphNamespace($transport, $endpoint);
$this->ilm = new IlmNamespace($transport, $endpoint);
$this->license = new LicenseNamespace($transport, $endpoint);
$this->migration = new MigrationNamespace($transport, $endpoint);
$this->ml = new MlNamespace($transport, $endpoint);
$this->monitoring = new MonitoringNamespace($transport, $endpoint);
$this->rollup = new RollupNamespace($transport, $endpoint);
$this->security = new SecurityNamespace($transport, $endpoint);
$this->slm = new SlmNamespace($transport, $endpoint);
$this->sql = new SqlNamespace($transport, $endpoint);
$this->ssl = new SslNamespace($transport, $endpoint);
$this->transform = new TransformNamespace($transport, $endpoint);
$this->watcher = new WatcherNamespace($transport, $endpoint);
$this->xpack = new XpackNamespace($transport, $endpoint);
$this->registeredNamespaces = $registeredNamespaces;
}
/**
* $params['index'] = (string) Default index for items which don't provide one
* $params['type'] = DEPRECATED (string) Default document type for items which don't provide one
* $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
* $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
* $params['routing'] = (string) Specific routing value
* $params['timeout'] = (time) Explicit operation timeout
* $params['_source'] = (list) True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
* $params['_source_excludes'] = (list) Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
* $params['_source_includes'] = (list) Default list of fields to extract and return from the _source field, can be overridden on each sub-request
* $params['pipeline'] = (string) The pipeline id to preprocess incoming documents with
* $params['body'] = (array) The operation definition and data (action-data pairs), separated by newlines (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html
*/
public function bulk(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Bulk');
$endpoint->setParams($params);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['scroll_id'] = DEPRECATED (list) A comma-separated list of scroll IDs to clear
* $params['body'] = (array) A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-body.html#_clear_scroll_api
*/
public function clearScroll(array $params = [])
{
$scroll_id = $this->extractArgument($params, 'scroll_id');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('ClearScroll');
$endpoint->setParams($params);
$endpoint->setScrollId($scroll_id);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (list) A comma-separated list of indices to restrict the results
* $params['type'] = DEPRECATED (list) A comma-separated list of types to restrict the results
* $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* $params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
* $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open)
* $params['min_score'] = (number) Include only documents with a specific `_score` value in the result
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['routing'] = (list) A comma-separated list of specific routing values
* $params['q'] = (string) Query in the Lucene query string syntax
* $params['analyzer'] = (string) The analyzer to use for the query string
* $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
* $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
* $params['df'] = (string) The field to use as default where no field prefix is given in the query string
* $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
* $params['terminate_after'] = (number) The maximum count for each shard, upon reaching which the query execution will terminate early
* $params['body'] = (array) A query to restrict the results specified with the Query DSL (optional)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html
*/
public function count(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Count');
$endpoint->setParams($params);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) Document ID (Required)
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document
* $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
* $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
* $params['routing'] = (string) Specific routing value
* $params['timeout'] = (time) Explicit operation timeout
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte)
* $params['pipeline'] = (string) The pipeline id to preprocess incoming documents with
* $params['body'] = (array) The document (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html
*/
public function create(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Create');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) The document ID (Required)
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document
* $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
* $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
* $params['routing'] = (string) Specific routing value
* $params['timeout'] = (time) Explicit operation timeout
* $params['if_seq_no'] = (number) only perform the delete operation if the last operation that has changed the document has the specified sequence number
* $params['if_primary_term'] = (number) only perform the delete operation if the last operation that has changed the document has the specified primary term
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html
*/
public function delete(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Delete');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices (Required)
* $params['type'] = DEPRECATED (list) A comma-separated list of document types to search; leave empty to perform the operation on all types
* $params['analyzer'] = (string) The analyzer to use for the query string
* $params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
* $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
* $params['df'] = (string) The field to use as default where no field prefix is given in the query string
* $params['from'] = (number) Starting offset (default: 0)
* $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* $params['conflicts'] = (enum) What to do when the delete by query hits version conflicts? (Options = abort,proceed) (Default = abort)
* $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open)
* $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['q'] = (string) Query in the Lucene query string syntax
* $params['routing'] = (list) A comma-separated list of specific routing values
* $params['scroll'] = (time) Specify how long a consistent view of the index should be maintained for scrolled search
* $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
* $params['search_timeout'] = (time) Explicit timeout for each search request. Defaults to no timeout.
* $params['size'] = (number) Deprecated, please use `max_docs` instead
* $params['max_docs'] = (number) Maximum number of documents to process (default: all documents)
* $params['sort'] = (list) A comma-separated list of <field>:<direction> pairs
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
* $params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
* $params['stats'] = (list) Specific 'tag' of the request for logging and statistical purposes
* $params['version'] = (boolean) Specify whether to return document version as part of a hit
* $params['request_cache'] = (boolean) Specify if request cache should be used for this request or not, defaults to index level setting
* $params['refresh'] = (boolean) Should the effected indexes be refreshed?
* $params['timeout'] = (time) Time each individual bulk request should wait for shards that are unavailable. (Default = 1m)
* $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
* $params['scroll_size'] = (number) Size on the scroll request powering the delete by query (Default = 100)
* $params['wait_for_completion'] = (boolean) Should the request should block until the delete by query is complete. (Default = true)
* $params['requests_per_second'] = (number) The throttle for this request in sub-requests per second. -1 means no throttle. (Default = 0)
* $params['slices'] = (number|string) The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. (Default = 1)
* $params['body'] = (array) The search definition using the Query DSL (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html
*/
public function deleteByQuery(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('DeleteByQuery');
$endpoint->setParams($params);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['task_id'] = (string) The task id to rethrottle
* $params['requests_per_second'] = (number) The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html
*/
public function deleteByQueryRethrottle(array $params = [])
{
$task_id = $this->extractArgument($params, 'task_id');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('DeleteByQueryRethrottle');
$endpoint->setParams($params);
$endpoint->setTaskId($task_id);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) Script ID
* $params['timeout'] = (time) Explicit operation timeout
* $params['master_timeout'] = (time) Specify timeout for connection to master
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
*/
public function deleteScript(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('DeleteScript');
$endpoint->setParams($params);
$endpoint->setId($id);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) The document ID (Required)
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types)
* $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
* $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
* $params['routing'] = (string) Specific routing value
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
*
* @param array $params Associative array of parameters
* @return bool
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
*/
public function exists(array $params = []): bool
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
// manually make this verbose so we can check status code
$params['client']['verbose'] = true;
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Exists');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
}
/**
* $params['id'] = (string) The document ID (Required)
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
* $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
* $params['routing'] = (string) Specific routing value
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
*
* @param array $params Associative array of parameters
* @return bool
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
*/
public function existsSource(array $params = []): bool
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
// manually make this verbose so we can check status code
$params['client']['verbose'] = true;
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('ExistsSource');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
}
/**
* $params['id'] = (string) The document ID (Required)
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document
* $params['analyze_wildcard'] = (boolean) Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)
* $params['analyzer'] = (string) The analyzer for the query string query
* $params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
* $params['df'] = (string) The default field for query string query (default: _all)
* $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
* $params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['q'] = (string) Query in the Lucene query string syntax
* $params['routing'] = (string) Specific routing value
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
* $params['body'] = (array) The query definition using the Query DSL
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html
*/
public function explain(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Explain');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (list) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
* $params['fields'] = (list) A comma-separated list of field names
* $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open)
* $params['include_unmapped'] = (boolean) Indicates whether unmapped fields should be included in the response. (Default = false)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html
*/
public function fieldCaps(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('FieldCaps');
$endpoint->setParams($params);
$endpoint->setIndex($index);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) The document ID (Required)
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document (use `_all` to fetch the first document matching the ID across all types)
* $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
* $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
* $params['routing'] = (string) Specific routing value
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
*/
public function get(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Get');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) Script ID
* $params['master_timeout'] = (time) Specify timeout for connection to master
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
*/
public function getScript(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('GetScript');
$endpoint->setParams($params);
$endpoint->setId($id);
return $this->performRequest($endpoint);
}
/**
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/painless/master/painless-contexts.html
*
* @note This API is EXPERIMENTAL and may be changed or removed completely in a future release
*
*/
public function getScriptContext(array $params = [])
{
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('GetScriptContext');
$endpoint->setParams($params);
return $this->performRequest($endpoint);
}
/**
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
*
* @note This API is EXPERIMENTAL and may be changed or removed completely in a future release
*
*/
public function getScriptLanguages(array $params = [])
{
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('GetScriptLanguages');
$endpoint->setParams($params);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) The document ID (Required)
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document; deprecated and optional starting with 7.0
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
* $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
* $params['routing'] = (string) Specific routing value
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html
*/
public function getSource(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('GetSource');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
return $this->performRequest($endpoint);
}
/**
* $params['id'] = (string) Document ID
* $params['index'] = (string) The name of the index (Required)
* $params['type'] = DEPRECATED (string) The type of the document
* $params['wait_for_active_shards'] = (string) Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
* $params['op_type'] = (enum) Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (Options = index,create)
* $params['refresh'] = (enum) If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (Options = true,false,wait_for)
* $params['routing'] = (string) Specific routing value
* $params['timeout'] = (time) Explicit operation timeout
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte)
* $params['if_seq_no'] = (number) only perform the index operation if the last operation that has changed the document has the specified sequence number
* $params['if_primary_term'] = (number) only perform the index operation if the last operation that has changed the document has the specified primary term
* $params['pipeline'] = (string) The pipeline id to preprocess incoming documents with
* $params['body'] = (array) The document (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html
*/
public function index(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Index');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
*/
public function info(array $params = [])
{
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Info');
$endpoint->setParams($params);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (string) The name of the index
* $params['type'] = DEPRECATED (string) The type of the document
* $params['stored_fields'] = (list) A comma-separated list of stored fields to return in the response
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
* $params['realtime'] = (boolean) Specify whether to perform the operation in realtime or search mode
* $params['refresh'] = (boolean) Refresh the shard containing the document before performing the operation
* $params['routing'] = (string) Specific routing value
* $params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
* $params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
* $params['_source_includes'] = (list) A list of fields to extract and return from the _source field
* $params['body'] = (array) Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL. (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html
*/
public function mget(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Mget');
$endpoint->setParams($params);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (list) A comma-separated list of index names to use as default
* $params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default
* $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
* $params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
* $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* $params['pre_filter_shard_size'] = (number) A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
* $params['max_concurrent_shard_requests'] = (number) The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests (Default = 5)
* $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false)
* $params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)
* $params['body'] = (array) The request definitions (metadata-search request definition pairs), separated by newlines (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html
*/
public function msearch(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Msearch');
$endpoint->setParams($params);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (list) A comma-separated list of index names to use as default
* $params['type'] = DEPRECATED (list) A comma-separated list of document types to use as default
* $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,query_and_fetch,dfs_query_then_fetch,dfs_query_and_fetch)
* $params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* $params['max_concurrent_searches'] = (number) Controls the maximum number of concurrent searches the multi search api will execute
* $params['rest_total_hits_as_int'] = (boolean) Indicates whether hits.total should be rendered as an integer or an object in the rest search response (Default = false)
* $params['ccs_minimize_roundtrips'] = (boolean) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (Default = true)
* $params['body'] = (array) The request definitions (metadata-search request definition pairs), separated by newlines (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html
*/
public function msearchTemplate(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('MsearchTemplate');
$endpoint->setParams($params);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (string) The index in which the document resides.
* $params['type'] = DEPRECATED (string) The type of the document.
* $params['ids'] = (list) A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
* $params['term_statistics'] = (boolean) Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = false)
* $params['field_statistics'] = (boolean) Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
* $params['fields'] = (list) A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs".
* $params['offsets'] = (boolean) Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
* $params['positions'] = (boolean) Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
* $params['payloads'] = (boolean) Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". (Default = true)
* $params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs".
* $params['routing'] = (string) Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs".
* $params['realtime'] = (boolean) Specifies if requests are real-time as opposed to near-real-time (default: true).
* $params['version'] = (number) Explicit version number for concurrency control
* $params['version_type'] = (enum) Specific version type (Options = internal,external,external_gte,force)
* $params['body'] = (array) Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html
*/
public function mtermvectors(array $params = [])
{
$index = $this->extractArgument($params, 'index');
$type = $this->extractArgument($params, 'type');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('MTermVectors');
$endpoint->setParams($params);
$endpoint->setIndex($index);
$endpoint->setType($type);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
*
* @param array $params Associative array of parameters
* @return bool
* @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html
*/
public function ping(array $params = []): bool
{
// manually make this verbose so we can check status code
$params['client']['verbose'] = true;
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('Ping');
$endpoint->setParams($params);
return BooleanRequestWrapper::performRequest($endpoint, $this->transport);
}
/**
* $params['id'] = (string) Script ID (Required)
* $params['context'] = (string) Script context
* $params['timeout'] = (time) Explicit operation timeout
* $params['master_timeout'] = (time) Specify timeout for connection to master
* $params['body'] = (array) The document (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html
*/
public function putScript(array $params = [])
{
$id = $this->extractArgument($params, 'id');
$context = $this->extractArgument($params, 'context');
$body = $this->extractArgument($params, 'body');
$endpointBuilder = $this->endpoints;
$endpoint = $endpointBuilder('PutScript');
$endpoint->setParams($params);
$endpoint->setId($id);
$endpoint->setContext($context);
$endpoint->setBody($body);
return $this->performRequest($endpoint);
}
/**
* $params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* $params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
* $params['allow_no_indices'] = (boolean) Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* $params['expand_wildcards'] = (enum) Whether to expand wildcard expression to concrete indices that are open, closed or both. (Options = open,closed,hidden,none,all) (Default = open)
* $params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
* $params['body'] = (array) The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (Required)
*
* @param array $params Associative array of parameters
* @return array
* @see https://www.elastic.co/guide/en/elasticsearch/reference/master/search-rank-eval.html