Skip to content

Commit df6d17b

Browse files
williamdeswilliamdes
committed
Update built docs
1 parent 11264c6 commit df6d17b

36 files changed

+5975
-90
lines changed

‎docs/build/DOCTUM_VERSION‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
5.1.0

‎docs/build/Elasticsearch/Client.asciidoc‎

Lines changed: 519 additions & 35 deletions
Large diffs are not rendered by default.

‎docs/build/Elasticsearch/ClientBuilder.asciidoc‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55

66

77

8-
Class ClientBuilder
9-
108

119
*Methods*
1210

@@ -40,6 +38,7 @@ The class defines the following methods:
4038
* <<Elasticsearch_ClientBuildersetSSLCert_setSSLCert,`setSSLCert()`>>
4139
* <<Elasticsearch_ClientBuildersetSSLKey_setSSLKey,`setSSLKey()`>>
4240
* <<Elasticsearch_ClientBuildersetSSLVerification_setSSLVerification,`setSSLVerification()`>>
41+
* <<Elasticsearch_ClientBuilderincludePortInHostHeader_includePortInHostHeader,`includePortInHostHeader()`>>
4342
* <<Elasticsearch_ClientBuilderbuild_build,`build()`>>
4443
* <<Elasticsearch_ClientBuilderinstantiate_instantiate,`instantiate()`>>
4544

@@ -418,6 +417,20 @@ corresponds to setConnectionPool().
418417

419418

420419

420+
[[Elasticsearch_ClientBuilderincludePortInHostHeader_includePortInHostHeader]]
421+
.`includePortInHostHeader()`
422+
****
423+
[source,php]
424+
----
425+
/*
426+
Include the port in Host header
427+
*/
428+
429+
----
430+
****
431+
432+
433+
421434
[[Elasticsearch_ClientBuilderbuild_build]]
422435
.`build()`
423436
****

‎docs/build/Elasticsearch/Namespaces/AsyncSearchNamespace.asciidoc‎

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
2+
3+
[[Elasticsearch_Namespaces_AsyncSearchNamespace]]
4+
=== Elasticsearch\Namespaces\AsyncSearchNamespace
5+
6+
7+
8+
Class AsyncSearchNamespace
9+
Generated running $ php util/GenerateEndpoints.php 7.9
10+
11+
12+
*Methods*
13+
14+
The class defines the following methods:
15+
16+
* <<Elasticsearch_Namespaces_AsyncSearchNamespacedelete_delete,`delete()`>>
17+
* <<Elasticsearch_Namespaces_AsyncSearchNamespaceget_get,`get()`>>
18+
* <<Elasticsearch_Namespaces_AsyncSearchNamespacesubmit_submit,`submit()`>>
19+
20+
21+
22+
[[Elasticsearch_Namespaces_AsyncSearchNamespacedelete_delete]]
23+
.`delete()`
24+
****
25+
[source,php]
26+
----
27+
/*
28+
$params['id'] = (string) The async search ID
29+
*/
30+
31+
$params = [
32+
// ...
33+
];
34+
35+
$client = ClientBuilder::create()->build();
36+
$response = $client->asyncsearch()->delete($params);
37+
----
38+
****
39+
40+
41+
42+
[[Elasticsearch_Namespaces_AsyncSearchNamespaceget_get]]
43+
.`get()`
44+
****
45+
[source,php]
46+
----
47+
/*
48+
$params['id'] = (string) The async search ID
49+
$params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response
50+
$params['keep_alive'] = (time) Specify the time interval in which the results (partial or final) for this search will be available
51+
$params['typed_keys'] = (boolean) Specify whether aggregation and suggester names should be prefixed by their respective types in the response
52+
*/
53+
54+
$params = [
55+
// ...
56+
];
57+
58+
$client = ClientBuilder::create()->build();
59+
$response = $client->asyncsearch()->get($params);
60+
----
61+
****
62+
63+
64+
65+
[[Elasticsearch_Namespaces_AsyncSearchNamespacesubmit_submit]]
66+
.`submit()`
67+
****
68+
[source,php]
69+
----
70+
/*
71+
$params['index'] = (list) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
72+
$params['wait_for_completion_timeout'] = (time) Specify the time that the request should block waiting for the final response (Default = 1s)
73+
$params['keep_on_completion'] = (boolean) Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) (Default = false)
74+
$params['keep_alive'] = (time) Update the time interval in which the results (partial or final) for this search will be available (Default = 5d)
75+
$params['batched_reduce_size'] = (number) The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available. (Default = 5)
76+
$params['request_cache'] = (boolean) Specify if request cache should be used for this request or not, defaults to true
77+
$params['analyzer'] = (string) The analyzer to use for the query string
78+
$params['analyze_wildcard'] = (boolean) Specify whether wildcard and prefix queries should be analyzed (default: false)
79+
$params['default_operator'] = (enum) The default operator for query string query (AND or OR) (Options = AND,OR) (Default = OR)
80+
$params['df'] = (string) The field to use as default where no field prefix is given in the query string
81+
$params['explain'] = (boolean) Specify whether to return detailed information about score computation as part of a hit
82+
$params['stored_fields'] = (list) A comma-separated list of stored fields to return as part of a hit
83+
$params['docvalue_fields'] = (list) A comma-separated list of fields to return as the docvalue representation of a field for each hit
84+
$params['from'] = (number) Starting offset (default: 0)
85+
$params['ignore_unavailable'] = (boolean) Whether specified concrete indices should be ignored when unavailable (missing or closed)
86+
$params['ignore_throttled'] = (boolean) Whether specified concrete, expanded or aliased indices should be ignored when throttled
87+
$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)
88+
$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)
89+
$params['lenient'] = (boolean) Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
90+
$params['preference'] = (string) Specify the node or shard the operation should be performed on (default: random)
91+
$params['q'] = (string) Query in the Lucene query string syntax
92+
$params['routing'] = (list) A comma-separated list of specific routing values
93+
$params['search_type'] = (enum) Search operation type (Options = query_then_fetch,dfs_query_then_fetch)
94+
$params['size'] = (number) Number of hits to return (default: 10)
95+
$params['sort'] = (list) A comma-separated list of <field>:<direction> pairs
96+
$params['_source'] = (list) True or false to return the _source field or not, or a list of fields to return
97+
$params['_source_excludes'] = (list) A list of fields to exclude from the returned _source field
98+
$params['_source_includes'] = (list) A list of fields to extract and return from the _source field
99+
$params['terminate_after'] = (number) The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
100+
*/
101+
102+
$params = [
103+
// ...
104+
];
105+
106+
$client = ClientBuilder::create()->build();
107+
$response = $client->asyncsearch()->submit($params);
108+
----
109+
****
110+
111+

‎docs/build/Elasticsearch/Namespaces/AutoscalingNamespace.asciidoc‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
2+
3+
[[Elasticsearch_Namespaces_AutoscalingNamespace]]
4+
=== Elasticsearch\Namespaces\AutoscalingNamespace
5+
6+
7+
8+
Class AutoscalingNamespace
9+
Generated running $ php util/GenerateEndpoints.php 7.9
10+
11+
12+
*Methods*
13+
14+
The class defines the following methods:
15+
16+
* <<Elasticsearch_Namespaces_AutoscalingNamespacedeleteAutoscalingPolicy_deleteAutoscalingPolicy,`deleteAutoscalingPolicy()`>>
17+
* <<Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingDecision_getAutoscalingDecision,`getAutoscalingDecision()`>>
18+
* <<Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingPolicy_getAutoscalingPolicy,`getAutoscalingPolicy()`>>
19+
* <<Elasticsearch_Namespaces_AutoscalingNamespaceputAutoscalingPolicy_putAutoscalingPolicy,`putAutoscalingPolicy()`>>
20+
21+
22+
23+
[[Elasticsearch_Namespaces_AutoscalingNamespacedeleteAutoscalingPolicy_deleteAutoscalingPolicy]]
24+
.`deleteAutoscalingPolicy()`
25+
*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
26+
****
27+
[source,php]
28+
----
29+
/*
30+
$params['name'] = (string) the name of the autoscaling policy
31+
*/
32+
33+
$params = [
34+
// ...
35+
];
36+
37+
$client = ClientBuilder::create()->build();
38+
$response = $client->autoscaling()->deleteAutoscalingPolicy($params);
39+
----
40+
****
41+
42+
43+
44+
[[Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingDecision_getAutoscalingDecision]]
45+
.`getAutoscalingDecision()`
46+
****
47+
[source,php]
48+
----
49+
/*
50+
*/
51+
52+
$params = [
53+
// ...
54+
];
55+
56+
$client = ClientBuilder::create()->build();
57+
$response = $client->autoscaling()->getAutoscalingDecision($params);
58+
----
59+
****
60+
61+
62+
63+
[[Elasticsearch_Namespaces_AutoscalingNamespacegetAutoscalingPolicy_getAutoscalingPolicy]]
64+
.`getAutoscalingPolicy()`
65+
*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
66+
****
67+
[source,php]
68+
----
69+
/*
70+
$params['name'] = (string) the name of the autoscaling policy
71+
*/
72+
73+
$params = [
74+
// ...
75+
];
76+
77+
$client = ClientBuilder::create()->build();
78+
$response = $client->autoscaling()->getAutoscalingPolicy($params);
79+
----
80+
****
81+
82+
83+
84+
[[Elasticsearch_Namespaces_AutoscalingNamespaceputAutoscalingPolicy_putAutoscalingPolicy]]
85+
.`putAutoscalingPolicy()`
86+
*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
87+
****
88+
[source,php]
89+
----
90+
/*
91+
$params['name'] = (string) the name of the autoscaling policy
92+
$params['body'] = (array) the specification of the autoscaling policy (Required)
93+
*/
94+
95+
$params = [
96+
// ...
97+
];
98+
99+
$client = ClientBuilder::create()->build();
100+
$response = $client->autoscaling()->putAutoscalingPolicy($params);
101+
----
102+
****
103+
104+

0 commit comments

Comments
 (0)