Skip to content

Commit 2904d7a

Browse files
committed
[DOCS] Rebuild auto-generated docs
1 parent 8a0a932 commit 2904d7a

File tree

4 files changed

+59
-2
lines changed

4 files changed

+59
-2
lines changed

docs/build/Elasticsearch/Client.asciidoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The class defines the following methods:
3232
* <<Elasticsearch_Clientcreate_create,`create()`>>
3333
* <<Elasticsearch_Clientbulk_bulk,`bulk()`>>
3434
* <<Elasticsearch_Clientindex_index,`index()`>>
35+
* <<Elasticsearch_Clientreindex_reindex,`reindex()`>>
3536
* <<Elasticsearch_Clientsuggest_suggest,`suggest()`>>
3637
* <<Elasticsearch_Clientexplain_explain,`explain()`>>
3738
* <<Elasticsearch_Clientsearch_search,`search()`>>
@@ -624,6 +625,32 @@ $response = $client->index($params);
624625

625626

626627

628+
[[Elasticsearch_Clientreindex_reindex]]
629+
.`reindex()`
630+
****
631+
[source,php]
632+
----
633+
/*
634+
$params['refresh'] = (boolean) Should the effected indexes be refreshed?
635+
['timeout'] = (time) Time each individual bulk request should wait for shards that are unavailable
636+
['consistency'] = (enum) Explicit write consistency setting for the operation
637+
['wait_for_completion'] = (boolean) Should the request should block until the reindex is complete
638+
['requests_per_second'] = (float) The throttle for this request in sub-requests per second. 0 means set no throttle
639+
['body'] = (array) The search definition using the Query DSL and the prototype for the index request (Required)
640+
['body'] = (array) Request body
641+
*/
642+
643+
$params = [
644+
// ...
645+
];
646+
647+
$client = ClientBuilder::create()->build();
648+
$response = $client->reindex($params);
649+
----
650+
****
651+
652+
653+
627654
[[Elasticsearch_Clientsuggest_suggest]]
628655
.`suggest()`
629656
****

docs/build/Elasticsearch/Namespaces/CatNamespace.asciidoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ The class defines the following methods:
3030
* <<Elasticsearch_Namespaces_CatNamespacefielddata_fielddata,`fielddata()`>>
3131
* <<Elasticsearch_Namespaces_CatNamespaceplugins_plugins,`plugins()`>>
3232
* <<Elasticsearch_Namespaces_CatNamespacesegments_segments,`segments()`>>
33+
* <<Elasticsearch_Namespaces_CatNamespacetasks_tasks,`tasks()`>>
3334

3435

3536

@@ -399,6 +400,7 @@ $params['local'] = (bool) Return local information, do not retrieve the
399400
['help'] = (bool) Return help information
400401
['v'] = (bool) Verbose mode. Display column headers
401402
['full_id'] = (bool) Enables displaying the complete node ids
403+
['size'] = (enum) The multiplier in which to display values ([ "", "k", "m", "g", "t", "p" ])
402404
['body'] = (array) Request body
403405
*/
404406
@@ -487,3 +489,27 @@ $response = $client->cat()->segments($params);
487489
****
488490

489491

492+
493+
[[Elasticsearch_Namespaces_CatNamespacetasks_tasks]]
494+
.`tasks()`
495+
****
496+
[source,php]
497+
----
498+
/*
499+
$params['format'] = (string) a short version of the Accept header, e.g. json, yaml
500+
['node_id'] = (list) A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
501+
['format'] = (string) a short version of the Accept header, e.g. json, yaml
502+
['actions'] = (list) A comma-separated list of actions that should be returned. Leave empty to return all.
503+
['body'] = (array) Request body
504+
*/
505+
506+
$params = [
507+
// ...
508+
];
509+
510+
$client = ClientBuilder::create()->build();
511+
$response = $client->cat()->tasks($params);
512+
----
513+
****
514+
515+

docs/build/Elasticsearch/Namespaces/IndicesNamespace.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -830,12 +830,16 @@ $response = $client->indices()->open($params);
830830
$params['index'] = (string) The name of the index to scope the operation
831831
['analyzer'] = (string) The name of the analyzer to use
832832
['field'] = (string) Use the analyzer configured for this field (instead of passing the analyzer name)
833-
['filters'] = (list) A comma-separated list of filters to use for the analysis
833+
['filter'] = (list) A comma-separated list of filters to use for the analysis
834834
['prefer_local'] = (boolean) With `true`, specify that a local shard should be used if available, with `false`, use a random shard (default: true)
835835
['text'] = (string) The text on which the analysis should be performed (when request body is not used)
836836
['tokenizer'] = (string) The name of the tokenizer to use for the analysis
837837
['format'] = (enum) Format of the output
838838
['body'] = (enum) Format of the output
839+
['char_filter'] = (list) A comma-separated list of character filters to use for the analysis
840+
['explain'] = (bool) With `true`, outputs more advanced details. (default: false)
841+
['attributes'] = (list) A comma-separated list of token attributes to output, this parameter works only with `explain=true`
842+
['format'] = (enum) Format of the output (["detailed", "text"])
839843
['body'] = (array) Request body
840844
*/
841845

docs/build/renderer.index

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
C:19:"Sami\Renderer\Index":944:{a:3:{i:0;a:9:{s:20:"Elasticsearch\Client";s:40:"1eaf0f437ee80b6c3e4f5accef52a797bb1eefba";s:27:"Elasticsearch\ClientBuilder";s:40:"d78dc3bb58ca7bd920ae7af1745004176a8e5063";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"75993a58bbc5c96c6be89af386b40792729b7d94";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"0b6b06bb1d8486e9a4c00e7e8b3da30f10be0a2a";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"9aa2dbdf7a9a1e857f65a4b9ee612f9bcf70892d";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"0d541617b01a75f1e615f35f8202e1747384f5b5";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"fafd30cdb7e0c546217d8bd7aae493ad701f385c";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"f2ec6976856d2d06ab29684c982f8e41ac68de5d";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"766f7580c3df06c4369b4bcb82a630ec7d8a2a35";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}}
1+
C:19:"Sami\Renderer\Index":944:{a:3:{i:0;a:9:{s:20:"Elasticsearch\Client";s:40:"04f5d259604eefa88dc21968baccf069816c5924";s:27:"Elasticsearch\ClientBuilder";s:40:"43909299261f400333c723060331bedf4d90e098";s:37:"Elasticsearch\Namespaces\CatNamespace";s:40:"12e07e6eeeef76765996f6133f85dcb7b4046960";s:41:"Elasticsearch\Namespaces\ClusterNamespace";s:40:"0b6b06bb1d8486e9a4c00e7e8b3da30f10be0a2a";s:41:"Elasticsearch\Namespaces\IndicesNamespace";s:40:"de0be4dddb67b4a52c5cda57a35aca2ee112ad11";s:40:"Elasticsearch\Namespaces\IngestNamespace";s:40:"0d541617b01a75f1e615f35f8202e1747384f5b5";s:39:"Elasticsearch\Namespaces\NodesNamespace";s:40:"fafd30cdb7e0c546217d8bd7aae493ad701f385c";s:42:"Elasticsearch\Namespaces\SnapshotNamespace";s:40:"f2ec6976856d2d06ab29684c982f8e41ac68de5d";s:39:"Elasticsearch\Namespaces\TasksNamespace";s:40:"766f7580c3df06c4369b4bcb82a630ec7d8a2a35";}i:1;a:1:{i:0;s:6:"master";}i:2;a:2:{i:0;s:13:"Elasticsearch";i:1;s:24:"Elasticsearch\Namespaces";}}}

0 commit comments

Comments
 (0)