Auto-generated API code

Author: elasticmachine

src/Endpoints/AsyncSearch.php

@@ -75,8 +75,8 @@ public function delete(?array $params = null)
 	 *
 	 * @param array{
 	 *     id: string, // (REQUIRED) The async search ID
-	 *     wait_for_completion_timeout?: int|string, // Specify the time that the request should block waiting for the final response
-	 *     keep_alive?: int|string, // Specify the time interval in which the results (partial or final) for this search will be available
+	 *     wait_for_completion_timeout?: int|string, // Specifies to wait for the search to be completed up until the provided timeout. Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. By default no timeout is set meaning that the currently available results will be returned without any additional wait.
+	 *     keep_alive?: int|string, // The length of time that the async search should be available in the cluster. When not specified, the `keep_alive` set with the corresponding submit async request will be used. Otherwise, it is possible to override the value and extend the validity of the request. When this period expires, the search, if still running, is cancelled. If the search is completed, its saved results are deleted.
 	 *     typed_keys?: bool, // Specify whether aggregation and suggester names should be prefixed by their respective types in the response
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
@@ -117,7 +117,7 @@ public function get(?array $params = null)
 	 *
 	 * @param array{
 	 *     id: string, // (REQUIRED) The async search ID
-	 *     keep_alive?: int|string, // Specify the time interval in which the results (partial or final) for this search will be available
+	 *     keep_alive?: int|string, // The length of time that the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period. (DEFAULT: 5d)
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -157,15 +157,15 @@ public function status(?array $params = null)
 	 *
 	 * @param array{
 	 *     index?: string|array<string>, // A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
-	 *     wait_for_completion_timeout?: int|string, // Specify the time that the request should block waiting for the final response
-	 *     keep_on_completion?: bool, // Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)
-	 *     keep_alive?: int|string, // Update the time interval in which the results (partial or final) for this search will be available
-	 *     batched_reduce_size?: int, // 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.
-	 *     request_cache?: bool, // Specify if request cache should be used for this request or not, defaults to true
+	 *     wait_for_completion_timeout?: int|string, // Blocks and waits until the search is completed up to a certain timeout. When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. (DEFAULT: 1s)
+	 *     keep_on_completion?: bool, // If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
+	 *     keep_alive?: int|string, // Specifies how long the async search needs to be available. Ongoing async searches and any saved search results are deleted after this period. (DEFAULT: 5d)
+	 *     batched_reduce_size?: int, // Affects how often partial results become available, which happens whenever shard results are reduced. A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). (DEFAULT: 5)
+	 *     request_cache?: bool, // Specify if request cache should be used for this request or not, defaults to true (DEFAULT: 1)
 	 *     analyzer?: string, // The analyzer to use for the query string
-	 *     analyze_wildcard?: bool, // Specify whether wildcard and prefix queries should be analyzed (default: false)
-	 *     ccs_minimize_roundtrips?: bool, // When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters.
-	 *     default_operator?: string, // The default operator for query string query (AND or OR)
+	 *     analyze_wildcard?: bool, // Specify whether wildcard and prefix queries should be analyzed
+	 *     ccs_minimize_roundtrips?: bool, // The default value is the only supported value.
+	 *     default_operator?: string, // The default operator for query string query (AND or OR) (DEFAULT: or)
 	 *     df?: string, // The field to use as default where no field prefix is given in the query string
 	 *     explain?: bool, // Specify whether to return detailed information about score computation as part of a hit
 	 *     stored_fields?: string|array<string>, // A comma-separated list of stored fields to return as part of a hit
@@ -174,32 +174,32 @@ public function status(?array $params = null)
 	 *     ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed)
 	 *     ignore_throttled?: bool, // Whether specified concrete, expanded or aliased indices should be ignored when throttled
 	 *     allow_no_indices?: bool, // Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
-	 *     expand_wildcards?: string|array<string>, // Whether to expand wildcard expression to concrete indices that are open, closed or both.
+	 *     expand_wildcards?: string|array<string>, // Whether to expand wildcard expression to concrete indices that are open, closed or both (DEFAULT: open)
 	 *     lenient?: bool, // Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
-	 *     preference?: string, // Specify the node or shard the operation should be performed on (default: random)
+	 *     preference?: string, // Specify the node or shard the operation should be performed on (DEFAULT: random)
 	 *     rest_total_hits_as_int?: bool, // Indicates whether hits.total should be rendered as an integer or an object in the rest search response
 	 *     q?: string, // Query in the Lucene query string syntax
 	 *     routing?: string|array<string>, // A comma-separated list of specific routing values
 	 *     search_type?: string, // Search operation type
-	 *     size?: int, // Number of hits to return
+	 *     size?: int, // Number of hits to return (DEFAULT: 10)
 	 *     sort?: string|array<string>, // A comma-separated list of <field>:<direction> pairs
 	 *     _source?: string|array<string>, // True or false to return the _source field or not, or a list of fields to return
 	 *     _source_excludes?: string|array<string>, // A list of fields to exclude from the returned _source field
 	 *     _source_includes?: string|array<string>, // A list of fields to extract and return from the _source field
-	 *     terminate_after?: int, // The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
+	 *     terminate_after?: int, // The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early
 	 *     stats?: string|array<string>, // Specific 'tag' of the request for logging and statistical purposes
-	 *     suggest_field?: string, // Specify which field to use for suggestions
-	 *     suggest_mode?: string, // Specify suggest mode
+	 *     suggest_field?: string, // Specifies which field to use for suggestions.
+	 *     suggest_mode?: string, // Specify suggest mode (DEFAULT: missing)
 	 *     suggest_size?: int, // How many suggestions to return in response
-	 *     suggest_text?: string, // The source text for which the suggestions should be returned
+	 *     suggest_text?: string, // The source text for which the suggestions should be returned.
 	 *     timeout?: int|string, // Explicit operation timeout
 	 *     track_scores?: bool, // Whether to calculate and return scores even if they are not used for sorting
 	 *     track_total_hits?: bool|int, // Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number.
-	 *     allow_partial_search_results?: bool, // Indicate if an error should be returned if there is a partial search failure or timeout
+	 *     allow_partial_search_results?: bool, // Indicate if an error should be returned if there is a partial search failure or timeout (DEFAULT: 1)
 	 *     typed_keys?: bool, // Specify whether aggregation and suggester names should be prefixed by their respective types in the response
 	 *     version?: bool, // Specify whether to return document version as part of a hit
 	 *     seq_no_primary_term?: bool, // Specify whether to return sequence number and primary term of the last modification of each hit
-	 *     max_concurrent_shard_requests?: int, // The number of concurrent shard requests per node this search executes concurrently. 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
+	 *     max_concurrent_shard_requests?: int, // The number of concurrent shard requests per node this search executes concurrently. 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)
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)

src/Endpoints/Autoscaling.php

@@ -35,8 +35,8 @@ class Autoscaling extends AbstractEndpoint
 	 *
 	 * @param array{
 	 *     name: string, // (REQUIRED) the name of the autoscaling policy
-	 *     master_timeout?: int|string, // Timeout for processing on master node
-	 *     timeout?: int|string, // Timeout for acknowledgement of update from all nodes in cluster
+	 *     master_timeout?: int|string, // Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s)
+	 *     timeout?: int|string, // Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s)
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -74,7 +74,7 @@ public function deleteAutoscalingPolicy(?array $params = null)
 	 * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/autoscaling-get-autoscaling-capacity.html
 	 *
 	 * @param array{
-	 *     master_timeout?: int|string, // Timeout for processing on master node
+	 *     master_timeout?: int|string, // Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s)
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -111,7 +111,7 @@ public function getAutoscalingCapacity(?array $params = null)
 	 *
 	 * @param array{
 	 *     name: string, // (REQUIRED) the name of the autoscaling policy
-	 *     master_timeout?: int|string, // Timeout for processing on master node
+	 *     master_timeout?: int|string, // Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s)
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)
@@ -150,8 +150,8 @@ public function getAutoscalingPolicy(?array $params = null)
 	 *
 	 * @param array{
 	 *     name: string, // (REQUIRED) the name of the autoscaling policy
-	 *     master_timeout?: int|string, // Timeout for processing on master node
-	 *     timeout?: int|string, // Timeout for acknowledgement of update from all nodes in cluster
+	 *     master_timeout?: int|string, // Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s)
+	 *     timeout?: int|string, // Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s)
 	 *     pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false)
 	 *     human?: bool, // Return human readable values for statistics. (DEFAULT: true)
 	 *     error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false)