From cdcf20918b2edb18aec23bbb5814ae51d9682a55 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Mon, 23 Mar 2026 06:19:41 +0000 Subject: [PATCH] Auto-generated API code --- src/Endpoints/AsyncSearch.php | 40 +- src/Endpoints/Autoscaling.php | 12 +- src/Endpoints/Cat.php | 258 +++++----- src/Endpoints/Ccr.php | 30 +- src/Endpoints/Cluster.php | 104 ++-- src/Endpoints/Connector.php | 16 +- src/Endpoints/DanglingIndices.php | 12 +- src/Endpoints/Enrich.php | 12 +- src/Endpoints/Eql.php | 22 +- src/Endpoints/Esql.php | 24 +- src/Endpoints/Features.php | 4 +- src/Endpoints/Fleet.php | 12 +- src/Endpoints/Graph.php | 4 +- src/Endpoints/Ilm.php | 28 +- src/Endpoints/Indices.php | 480 +++++++++--------- src/Endpoints/Inference.php | 56 +-- src/Endpoints/Ingest.php | 30 +- src/Endpoints/License.php | 26 +- src/Endpoints/Ml.php | 294 +++++------ src/Endpoints/Monitoring.php | 2 +- src/Endpoints/Nodes.php | 40 +- src/Endpoints/Profiling.php | 4 +- src/Endpoints/QueryRules.php | 4 +- src/Endpoints/Rollup.php | 4 +- src/Endpoints/SearchApplication.php | 12 +- src/Endpoints/SearchableSnapshots.php | 10 +- src/Endpoints/Security.php | 56 +-- src/Endpoints/Shutdown.php | 10 +- src/Endpoints/Simulate.php | 2 +- src/Endpoints/Slm.php | 36 +- src/Endpoints/Snapshot.php | 90 ++-- src/Endpoints/Sql.php | 10 +- src/Endpoints/Synonyms.php | 8 +- src/Endpoints/Tasks.php | 26 +- src/Endpoints/TextStructure.php | 82 ++-- src/Endpoints/Transform.php | 60 +-- src/Endpoints/Watcher.php | 20 +- src/Endpoints/Xpack.php | 8 +- src/Traits/ClientEndpointsTrait.php | 682 +++++++++++++------------- 39 files changed, 1315 insertions(+), 1315 deletions(-) diff --git a/src/Endpoints/AsyncSearch.php b/src/Endpoints/AsyncSearch.php index 3ab475ea8..510dff96d 100644 --- a/src/Endpoints/AsyncSearch.php +++ b/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, // 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, // 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * expand_wildcards?: string|array, // 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, // 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, // A comma-separated list of : pairs * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field * _source_includes?: string|array, // 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, // 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) diff --git a/src/Endpoints/Autoscaling.php b/src/Endpoints/Autoscaling.php index 3719db0be..ae1b572ef 100644 --- a/src/Endpoints/Autoscaling.php +++ b/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) diff --git a/src/Endpoints/Cat.php b/src/Endpoints/Cat.php index 2ebe881af..8406b523c 100644 --- a/src/Endpoints/Cat.php +++ b/src/Endpoints/Cat.php @@ -36,13 +36,13 @@ class Cat extends AbstractEndpoint * * @param array{ * name?: string|array, // A comma-separated list of alias names to return - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. (DEFAULT: all) * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -85,14 +85,14 @@ public function aliases(?array $params = null) * * @param array{ * node_id?: string|array, // A comma-separated list of node IDs or names to limit the returned information - * format?: string, // a short version of the Accept header, e.g. json, yaml + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) @@ -135,12 +135,12 @@ public function allocation(?array $params = null) * * @param array{ * name?: string, // A pattern that returned component template names must match - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // The period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values @@ -185,10 +185,10 @@ public function componentTemplates(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to limit the returned information - * format?: string, // a short version of the Accept header, e.g. json, yaml - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values @@ -232,11 +232,11 @@ public function count(?array $params = null) * * @param array{ * fields?: string|array, // A comma-separated list of fields to return the fielddata size - * format?: string, // a short version of the Accept header, e.g. json, yaml + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) * bytes?: string, // The unit in which to display byte values - * h?: string|array, // Comma-separated list of column names to display + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * time?: string, // The unit in which to display time values * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -278,12 +278,12 @@ public function fielddata(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-health.html * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values - * ts?: bool, // Set to false to disable timestamping + * ts?: bool, // If true, returns `HH:MM:SS` and Unix epoch timestamps. (DEFAULT: 1) * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -359,18 +359,18 @@ public function help(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to limit the returned information - * format?: string, // a short version of the Accept header, e.g. json, yaml + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) * bytes?: string, // The unit in which to display byte values - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display - * health?: string, // A health status ("green", "yellow", or "red" to filter only indices matching the specified health status + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. + * health?: string, // The health status used to limit returned indices. By default, the response includes indices of any health status. * help?: bool, // Return help information - * pri?: bool, // Set to true to return stats only for primary shards - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * pri?: bool, // If true, the response only includes information from primary shards. + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers - * include_unloaded_segments?: bool, // If set to true segment stats will include stats for segments that are not currently loaded into memory - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * include_unloaded_segments?: bool, // If true, the response includes information from segments that are not loaded into memory. + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. (DEFAULT: all) * 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) @@ -410,12 +410,12 @@ public function indices(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-master.html * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values @@ -456,12 +456,12 @@ public function master(?array $params = null) * * @param array{ * id?: string, // The ID of the data frame analytics to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) + * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified.) * bytes?: string, // The unit in which to display byte values - * format?: string, // a short version of the Accept header, e.g. json, yaml - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * h?: string|array, // Comma-separated list of column names to display. (DEFAULT: create_time,id,state,type) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // Comma-separated list of column names or column aliases used to sort the response. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -505,11 +505,11 @@ public function mlDataFrameAnalytics(?array $params = null) * * @param array{ * datafeed_id?: string, // The ID of the datafeeds stats to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) - * format?: string, // a short version of the Accept header, e.g. json, yaml - * h?: string|array, // Comma-separated list of column names to display + * allow_no_match?: bool, // Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * h?: string|array, // Comma-separated list of column names to display. (DEFAULT: ['bc', 'id', 'sc', 's']) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // Comma-separated list of column names or column aliases used to sort the response. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values @@ -554,12 +554,12 @@ public function mlDatafeeds(?array $params = null) * * @param array{ * job_id?: string, // The ID of the jobs stats to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + * allow_no_match?: bool, // Specifies what to do when the request: * Contains wildcard expressions and there are no jobs that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) * bytes?: string, // The unit in which to display byte values - * format?: string, // a short version of the Accept header, e.g. json, yaml - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * h?: string|array, // Comma-separated list of column names to display. (DEFAULT: buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // Comma-separated list of column names or column aliases used to sort the response. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -603,14 +603,14 @@ public function mlJobs(?array $params = null) * * @param array{ * model_id?: string, // The ID of the trained models stats to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) - * from?: int, // skips a number of trained models - * size?: int, // specifies a max number of trained models to get + * allow_no_match?: bool, // Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * from?: int, // Skips the specified number of transforms. + * size?: int, // The maximum number of transforms to display. (DEFAULT: 100) * bytes?: string, // The unit in which to display byte values - * format?: string, // a short version of the Accept header, e.g. json, yaml - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * h?: string|array, // A comma-separated list of column names to display. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // A comma-separated list of column names or aliases used to sort the response. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -652,12 +652,12 @@ public function mlTrainedModels(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-nodeattrs.html * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values @@ -697,15 +697,15 @@ public function nodeattrs(?array $params = null) * * @param array{ * bytes?: string, // The unit in which to display byte values - * format?: string, // a short version of the Accept header, e.g. json, yaml - * full_id?: bool, // Return the full node ID instead of the shortened version (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * full_id?: bool, // If `true`, return the full node ID. If `false`, return the shortened node ID. (DEFAULT: false) + * master_timeout?: int|string, // The period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. (DEFAULT: ip,hp,rp,r,m,n,cpu,l) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers - * include_unloaded_segments?: bool, // If set to true segment stats will include stats for segments that are not currently loaded into memory + * include_unloaded_segments?: bool, // If true, the response includes information from segments that are not loaded into memory. * 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) @@ -741,12 +741,12 @@ public function nodes(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-pending-tasks.html * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values @@ -785,13 +785,13 @@ public function pendingTasks(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-plugins.html * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information * include_bootstrap?: bool, // Include bootstrap plugins in the response - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values @@ -831,13 +831,13 @@ public function plugins(?array $params = null) * * @param array{ * index?: string|array, // Comma-separated list or wildcard expression of index names to limit the returned information - * format?: string, // a short version of the Accept header, e.g. json, yaml - * active_only?: bool, // If `true`, the response only includes ongoing shard recoveries + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * active_only?: bool, // If `true`, the response only includes ongoing shard recoveries. * bytes?: string, // The unit in which to display byte values - * detailed?: bool, // If `true`, the response includes detailed information about shard recoveries - * h?: string|array, // Comma-separated list of column names to display + * detailed?: bool, // If `true`, the response includes detailed information about shard recoveries. + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. (DEFAULT: ip,hp,rp,r,m,n,cpu,l) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -879,12 +879,12 @@ public function recovery(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cat-repositories.html * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values @@ -924,19 +924,19 @@ public function repositories(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to limit the returned information - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) * bytes?: string, // The unit in which to display byte values - * h?: string|array, // Comma-separated list of column names to display + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. (DEFAULT: ip,hp,rp,r,m,n,cpu,l) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * time?: string, // The unit in which to display time values - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression. - * ignore_throttled?: bool, // Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression. - * 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). Only allowed when providing an index expression. - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * ignore_unavailable?: bool, // If true, missing or closed indices are not included in the response. + * ignore_throttled?: bool, // If true, concrete, expanded or aliased indices are ignored when frozen. + * allow_no_indices?: bool, // If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. (DEFAULT: open) * allow_closed?: bool, // If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour of throwing an exception if index pattern matches closed indices * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) @@ -978,12 +978,12 @@ public function segments(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to limit the returned information - * format?: string, // a short version of the Accept header, e.g. json, yaml + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) * bytes?: string, // The unit in which to display byte values - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * master_timeout?: int|string, // The period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -1026,12 +1026,12 @@ public function shards(?array $params = null) * * @param array{ * repository?: string|array, // Name of repository from which to fetch the snapshot information - * format?: string, // a short version of the Accept header, e.g. json, yaml - * ignore_unavailable?: bool, // Set to true to ignore unavailable snapshots - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * ignore_unavailable?: bool, // If `true`, the response does not include information from unavailable snapshots. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // A comma-separated list of columns names to display. It supports simple wildcards. (DEFAULT: ip,hp,rp,r,m,n,cpu,l) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values @@ -1075,17 +1075,17 @@ public function snapshots(?array $params = null) * @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml - * nodes?: string|array, // 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 - * actions?: string|array, // A comma-separated list of actions that should be returned. Leave empty to return all. - * detailed?: bool, // Return detailed task information (default: false) - * parent_task_id?: string, // Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * nodes?: string|array, // Unique node identifiers, which are used to limit the response. + * actions?: string|array, // The task action names, which are used to limit the response. + * detailed?: bool, // If `true`, the response includes detailed information about shard recoveries. + * parent_task_id?: string, // The parent task identifier, which is used to limit the response. + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers - * 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. + * 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) * wait_for_completion?: bool, // If `true`, the request blocks until the task has completed. * bytes?: string, // The unit in which to display byte values * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -1124,12 +1124,12 @@ public function tasks(?array $params = null) * * @param array{ * name?: string, // A pattern that returned template names must match - * format?: string, // a short version of the Accept header, e.g. json, yaml - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // List of columns that determine how the table should be sorted. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * time?: string, // The unit in which to display time values @@ -1173,13 +1173,13 @@ public function templates(?array $params = null) * * @param array{ * thread_pool_patterns?: string|array, // A comma-separated list of regular-expressions to filter the thread pools in the output - * format?: string, // a short version of the Accept header, e.g. json, yaml + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) * time?: string, // The unit in which to display time values - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * h?: string|array, // Comma-separated list of column names to display + * local?: bool, // If `true`, the request computes the list of selected nodes from the local cluster state. If `false` the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node. + * master_timeout?: int|string, // The period to wait for a connection to the master node. (DEFAULT: 30s) + * h?: string|array, // List of columns to appear in the response. Supports simple wildcards. * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // A comma-separated list of column names or aliases that determines the sort order. Sorting defaults to ascending and can be changed by setting `:asc` or `:desc` as a suffix to the column name. * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) @@ -1223,13 +1223,13 @@ public function threadPool(?array $params = null) * * @param array{ * transform_id?: string, // The id of the transform for which to get stats. '_all' or '*' implies all transforms - * from?: int, // skips a number of transform configs, defaults to 0 - * size?: int, // specifies a max number of transforms to get, defaults to 100 - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) - * format?: string, // a short version of the Accept header, e.g. json, yaml - * h?: string|array, // Comma-separated list of column names to display + * from?: int, // Skips the specified number of transforms. + * size?: int, // The maximum number of transforms to obtain. (DEFAULT: 100) + * allow_no_match?: bool, // Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * format?: string, // a short version of the Accept header, e.g. json, yaml (DEFAULT: text) + * h?: string|array, // Comma-separated list of column names to display. (DEFAULT: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state) * help?: bool, // Return help information - * s?: string|array, // Comma-separated list of column names or column aliases to sort by + * s?: string|array, // Comma-separated list of column names or column aliases used to sort the response. * time?: string, // The unit in which to display time values * v?: bool, // Verbose mode. Display column headers * bytes?: string, // The unit in which to display byte values diff --git a/src/Endpoints/Ccr.php b/src/Endpoints/Ccr.php index c82e27e72..e6d0a74a1 100644 --- a/src/Endpoints/Ccr.php +++ b/src/Endpoints/Ccr.php @@ -35,7 +35,7 @@ class Ccr extends AbstractEndpoint * * @param array{ * name: string, // (REQUIRED) The name of the auto follow pattern. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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,8 +74,8 @@ public function deleteAutoFollowPattern(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the follower index - * wait_for_active_shards?: string, // Sets the number of shard copies that must be active before returning. Defaults to 0. 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) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * wait_for_active_shards?: string, // Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be active. A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the remote Lucene segment files to the follower index. + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -116,7 +116,7 @@ public function follow(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index patterns; use `_all` to perform the operation on all indices - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -155,7 +155,7 @@ public function followInfo(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index patterns; use `_all` to perform the operation on all indices - * timeout?: int|string, // Explicit operation timeout + * timeout?: int|string, // The 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) @@ -194,7 +194,7 @@ public function followStats(?array $params = null) * * @param array{ * index: string, // (REQUIRED) the name of the leader index for which specified follower retention leases should be removed - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -235,7 +235,7 @@ public function forgetFollower(?array $params = null) * * @param array{ * name?: string, // The name of the auto follow pattern. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -276,7 +276,7 @@ public function getAutoFollowPattern(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the auto follow pattern that should pause discovering new indices to follow. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -315,7 +315,7 @@ public function pauseAutoFollowPattern(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the follower index that should pause following its leader index. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -354,7 +354,7 @@ public function pauseFollow(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the auto follow pattern. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -395,7 +395,7 @@ public function putAutoFollowPattern(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the auto follow pattern to resume discovering new indices to follow. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -434,7 +434,7 @@ public function resumeAutoFollowPattern(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the follow index to resume following. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -474,8 +474,8 @@ public function resumeFollow(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ccr-get-stats.html * * @param array{ - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s) + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -512,7 +512,7 @@ public function stats(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the follower index that should be turned into a regular index. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) diff --git a/src/Endpoints/Cluster.php b/src/Endpoints/Cluster.php index c1e772a12..b2d855864 100644 --- a/src/Endpoints/Cluster.php +++ b/src/Endpoints/Cluster.php @@ -34,9 +34,9 @@ class Cluster extends AbstractEndpoint * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-allocation-explain.html * * @param array{ - * master_timeout?: int|string, // Timeout for connection to master node - * include_yes_decisions?: bool, // Return 'YES' decisions in explanation (default: false) - * include_disk_info?: bool, // Return information about disk usage and shard sizes (default: false) + * master_timeout?: int|string, // Period to wait for a connection to the master node. (DEFAULT: 30s) + * include_yes_decisions?: bool, // If true, returns YES decisions in explanation. + * include_disk_info?: bool, // If true, returns information about disk usage and shard sizes. * 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) @@ -76,8 +76,8 @@ public function allocationExplain(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -115,8 +115,8 @@ public function deleteComponentTemplate(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions * * @param array{ - * wait_for_removal?: bool, // Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. - * master_timeout?: int|string, // Timeout for submitting request to master + * wait_for_removal?: bool, // Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. Defaults to true, meaning that all excluded nodes must be removed from the cluster before this API takes any action. If set to false then the voting configuration exclusions list is cleared even if some excluded nodes are still in the cluster. (DEFAULT: 1) + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -154,8 +154,8 @@ public function deleteVotingConfigExclusions(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * 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) + * local?: bool, // If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. * 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) @@ -195,10 +195,10 @@ public function existsComponentTemplate(?array $params = null) * * @param array{ * name?: string, // The name of the component template. Wildcard (`*`) expressions are supported. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * include_defaults?: bool, // Return all default configurations for the component template (default: false) - * flat_settings?: bool, // Return settings in flat format (default: false) + * 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) + * local?: bool, // If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. + * include_defaults?: bool, // Return all default configurations for the component template + * flat_settings?: bool, // If `true`, returns settings in flat format. * settings_filter?: string|array, // Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) @@ -239,10 +239,10 @@ public function getComponentTemplate(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-get-settings.html * * @param array{ - * flat_settings?: bool, // Return settings in flat format (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout - * include_defaults?: bool, // Whether to return all default clusters setting. + * flat_settings?: bool, // If `true`, returns settings in flat format. + * 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) + * include_defaults?: bool, // If `true`, also returns default values for all other cluster settings, reflecting the values in the `elasticsearch.yml` file of one of the nodes in the cluster. If the nodes in your cluster do not all have the same values in their `elasticsearch.yml` config files then the values returned by this API may vary from invocation to invocation and may not reflect the values that Elasticsearch uses in all situations. Use the `GET _nodes/settings` API to fetch the settings for each individual node in your cluster. * 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) @@ -279,17 +279,17 @@ public function getSettings(?array $params = null) * * @param array{ * index?: string|array, // Limit the information returned to a specific index - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * level?: string, // Specify the level of detail for returned information - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout - * wait_for_active_shards?: string, // Wait until the specified number of shards is active - * wait_for_nodes?: string, // Wait until the specified number of nodes is available - * wait_for_events?: string, // Wait until all currently queued events with the given priority are processed - * wait_for_no_relocating_shards?: bool, // Whether to wait until there are no relocating shards in the cluster - * wait_for_no_initializing_shards?: bool, // Whether to wait until there are no initializing shards in the cluster - * wait_for_status?: string, // Wait until cluster is in a specific state + * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. (DEFAULT: all) + * level?: string, // Can be one of cluster, indices or shards. Controls the details level of the health information returned. (DEFAULT: cluster) + * local?: bool, // If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the 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) + * 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) + * wait_for_active_shards?: string, // A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. + * wait_for_nodes?: string, // The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. * 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) @@ -368,8 +368,8 @@ public function info(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-pending.html * * @param array{ - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Specify timeout for connection to master + * local?: bool, // If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the 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) @@ -405,10 +405,10 @@ public function pendingTasks(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-cluster-post-voting-config-exclusions * * @param array{ - * node_ids?: string|array, // A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names. - * node_names?: string|array, // A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids. - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Timeout for submitting request to master + * node_ids?: string|array, // A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify node_names. + * node_names?: string|array, // A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify node_ids. + * timeout?: int|string, // When adding a voting configuration exclusion, the API waits for the specified nodes to be excluded from the voting configuration before returning. If the timeout expires before the appropriate condition is satisfied, the request fails and returns an error. (DEFAULT: 30s) + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -446,9 +446,9 @@ public function postVotingConfigExclusions(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * create?: bool, // Whether the index template should only be added if new or can also replace an existing one - * cause?: string, // User defined reason for create the component template - * master_timeout?: int|string, // Specify timeout for connection to master + * create?: bool, // If `true`, this request cannot replace or update existing component templates. + * cause?: string, // User defined reason for create the component template. (DEFAULT: api) + * 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) @@ -489,8 +489,8 @@ public function putComponentTemplate(?array $params = null) * * @param array{ * flat_settings?: bool, // Return settings in flat format - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The period to wait for a connection to the master node. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response. (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) @@ -564,12 +564,12 @@ public function remoteInfo(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/cluster-reroute.html * * @param array{ - * dry_run?: bool, // Simulate the operation only and return the resulting state - * explain?: bool, // Return an explanation of why the commands can or cannot be executed - * retry_failed?: bool, // Retries allocation of shards that are blocked due to too many subsequent allocation failures - * metric?: string|array, // Limit the information returned to the specified metrics. Defaults to all but metadata - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * dry_run?: bool, // If true, then the request simulates the operation. It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes. + * explain?: bool, // If true, then the response contains an explanation of why the commands can or cannot run. + * retry_failed?: bool, // If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + * metric?: string|array, // Limits the information returned to the specified metrics. (DEFAULT: all) + * 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) @@ -609,14 +609,14 @@ public function reroute(?array $params = null) * @param array{ * metric?: string|array, // Limit the information returned to the specified metrics * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * master_timeout?: int|string, // Specify timeout for connection to master - * flat_settings?: bool, // Return settings in flat format (default: false) + * local?: bool, // Return local information, do not retrieve the state from master node + * master_timeout?: int|string, // Timeout for waiting for new cluster state in case it is blocked (DEFAULT: 30s) + * flat_settings?: bool, // Return settings in flat format * wait_for_metadata_version?: int, // Wait for the metadata version to be equal or greater than the specified metadata version * wait_for_timeout?: int|string, // The maximum time to wait for wait_for_metadata_version before timing out * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * 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) (DEFAULT: 1) + * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both (DEFAULT: open) * 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) @@ -660,8 +660,8 @@ public function state(?array $params = null) * * @param array{ * node_id?: string|array, // 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 - * include_remotes?: bool, // Include remote cluster data into the response (default: false) - * timeout?: int|string, // Explicit operation timeout + * include_remotes?: bool, // Include remote cluster data into the response + * timeout?: int|string, // Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. * 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) diff --git a/src/Endpoints/Connector.php b/src/Endpoints/Connector.php index 0a199d06d..c7fc35269 100644 --- a/src/Endpoints/Connector.php +++ b/src/Endpoints/Connector.php @@ -76,7 +76,7 @@ public function checkIn(?array $params = null) * * @param array{ * connector_id: string, // (REQUIRED) The unique identifier of the connector to be deleted. - * delete_sync_jobs?: bool, // Determines whether associated sync jobs are also deleted. + * delete_sync_jobs?: bool, // A flag indicating if associated sync jobs should be also removed. * 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) @@ -154,12 +154,12 @@ public function get(?array $params = null) * @group serverless * * @param array{ - * from?: int, // Starting offset (default: 0) - * size?: int, // Specifies a max number of results to get (default: 100) + * from?: int, // Starting offset + * size?: int, // Specifies a max number of results to get (DEFAULT: 100) * index_name?: string|array, // A comma-separated list of connector index names to fetch connector documents for * connector_name?: string|array, // A comma-separated list of connector names to fetch connector documents for * service_type?: string|array, // A comma-separated list of connector service types to fetch connector documents for - * query?: string, // A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names + * query?: string, // A wildcard query string that filters connectors with matching name, description or index name * 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) @@ -515,11 +515,11 @@ public function syncJobGet(?array $params = null) * @group serverless * * @param array{ - * from?: int, // Starting offset (default: 0) - * size?: int, // specifies a max number of results to get (default: 100) + * from?: int, // Starting offset + * size?: int, // Specifies a max number of results to get (DEFAULT: 100) * status?: string, // A sync job status to fetch connector sync jobs for - * connector_id?: string, // Id of the connector to fetch the sync jobs for - * job_type?: string|array, // A comma-separated list of job types + * connector_id?: string, // A connector id to fetch connector sync jobs for + * job_type?: string|array, // A comma-separated list of job types to fetch the sync jobs for * 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) diff --git a/src/Endpoints/DanglingIndices.php b/src/Endpoints/DanglingIndices.php index 46e88e0b4..9d3ad4d8f 100644 --- a/src/Endpoints/DanglingIndices.php +++ b/src/Endpoints/DanglingIndices.php @@ -35,9 +35,9 @@ class DanglingIndices extends AbstractEndpoint * * @param array{ * index_uuid: string, // (REQUIRED) The UUID of the dangling index - * accept_data_loss?: bool, // Must be set to true in order to delete the dangling index - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * accept_data_loss?: bool, // This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. + * timeout?: int|string, // The period to wait for a response. (DEFAULT: 30s) + * master_timeout?: int|string, // The period to wait for a connection to the master node. (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) @@ -76,9 +76,9 @@ public function deleteDanglingIndex(?array $params = null) * * @param array{ * index_uuid: string, // (REQUIRED) The UUID of the dangling index - * accept_data_loss?: bool, // Must be set to true in order to import the dangling index - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * accept_data_loss?: bool, // This parameter must be set to true to import a dangling index. Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. + * timeout?: int|string, // The period to wait for a response. (DEFAULT: 30s) + * master_timeout?: int|string, // The period to wait for a connection to the master node. (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) diff --git a/src/Endpoints/Enrich.php b/src/Endpoints/Enrich.php index 9384cbf0e..4aeb16d0a 100644 --- a/src/Endpoints/Enrich.php +++ b/src/Endpoints/Enrich.php @@ -36,7 +36,7 @@ class Enrich extends AbstractEndpoint * * @param array{ * name: string, // (REQUIRED) The name of the enrich 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. (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) @@ -76,8 +76,8 @@ public function deletePolicy(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the enrich policy - * wait_for_completion?: bool, // Should the request should block until the execution is complete. - * master_timeout?: int|string, // Timeout for processing on master node + * wait_for_completion?: bool, // If `true`, the request blocks other enrich policy execution requests until complete. (DEFAULT: 1) + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -117,7 +117,7 @@ public function executePolicy(?array $params = null) * * @param array{ * name?: string|array, // A comma-separated list of enrich policy names - * master_timeout?: int|string, // Timeout for processing on master node + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -159,7 +159,7 @@ public function getPolicy(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the enrich 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. (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) @@ -200,7 +200,7 @@ public function putPolicy(?array $params = null) * @group serverless * * @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. (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) diff --git a/src/Endpoints/Eql.php b/src/Endpoints/Eql.php index 98aeea624..33ce9084f 100644 --- a/src/Endpoints/Eql.php +++ b/src/Endpoints/Eql.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, // Update the time interval in which the results (partial or final) for this search will be available + * wait_for_completion_timeout?: int|string, // Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. + * keep_alive?: int|string, // Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request. (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) @@ -155,15 +155,15 @@ public function getStatus(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the index to scope the operation - * 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 - * allow_partial_search_results?: bool, // Control whether the query should keep running in case of shard failures, and return partial results - * allow_partial_sequence_results?: bool, // Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true. - * ccs_minimize_roundtrips?: bool, // Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * wait_for_completion_timeout?: int|string, // Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. + * keep_on_completion?: bool, // If true, the search and its results are stored on the cluster. + * keep_alive?: int|string, // Period for which the search and its results are stored on the cluster. (DEFAULT: 5d) + * allow_partial_search_results?: bool, // If true, returns partial results if there are shard failures. If false, returns an error with no partial results. + * allow_partial_sequence_results?: bool, // If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all. This flag has effect only if allow_partial_search_results is true. + * ccs_minimize_roundtrips?: bool, // Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution (DEFAULT: 1) + * ignore_unavailable?: bool, // If true, missing or closed indices are not included in the response. (DEFAULT: 1) + * 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) (DEFAULT: 1) + * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. (DEFAULT: open) * 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) diff --git a/src/Endpoints/Esql.php b/src/Endpoints/Esql.php index 3cc0d14e8..9dc444967 100644 --- a/src/Endpoints/Esql.php +++ b/src/Endpoints/Esql.php @@ -34,10 +34,10 @@ class Esql extends AbstractEndpoint * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/esql-async-query-api.html * * @param array{ - * format?: string, // A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout.The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively. - * delimiter?: string, // The character to use between values within a CSV row. Only valid for the csv format. - * drop_null_columns?: bool, // Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. - * allow_partial_results?: bool, // If `true`, partial results will be returned if there are shard failures, butthe query can continue to execute on other clusters and shards.If `false`, the entire query will fail if there areany failures. + * format?: string, // A short version of the Accept header, e.g. json, yaml. `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. For async requests, nothing will be returned if the async query doesn't finish within the timeout. The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively. + * delimiter?: string, // The character to use between values within a CSV row. It is valid only for the CSV format. (DEFAULT: ,) + * drop_null_columns?: bool, // Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. + * allow_partial_results?: bool, // If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the query will fail if there are any failures. To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. (DEFAULT: 1) * 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) @@ -116,9 +116,9 @@ public function asyncQueryDelete(?array $params = null) * @param array{ * id: string, // (REQUIRED) The async query ID * format?: string, // A short version of the Accept header, for example `json` or `yaml`. - * 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 - * drop_null_columns?: bool, // Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. + * wait_for_completion_timeout?: int|string, // The period to wait for the request to finish. By default, the request waits for complete query results. If the request completes during the period specified in this parameter, complete query results are returned. Otherwise, the response returns an `is_running` value of `true` and no results. + * keep_alive?: int|string, // The period for which the query and its results are stored in the cluster. When this period expires, the query and its results are deleted, even if the query is still ongoing. + * drop_null_columns?: bool, // Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. * 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,7 +157,7 @@ public function asyncQueryGet(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The async query ID - * drop_null_columns?: bool, // Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. + * drop_null_columns?: bool, // Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. * 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) @@ -196,10 +196,10 @@ public function asyncQueryStop(?array $params = null) * @group serverless * * @param array{ - * format?: string, // A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. - * delimiter?: string, // The character to use between values within a CSV row. Only valid for the csv format. - * drop_null_columns?: bool, // Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. - * allow_partial_results?: bool, // If `true`, partial results will be returned if there are shard failures, butthe query can continue to execute on other clusters and shards.If `false`, the entire query will fail if there areany failures. + * format?: string, // A short version of the Accept header, e.g. json, yaml. `csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. + * delimiter?: string, // The character to use between values within a CSV row. Only valid for the CSV format. (DEFAULT: ,) + * drop_null_columns?: bool, // Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results? Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. + * allow_partial_results?: bool, // If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other clusters and shards. If `false`, the query will fail if there are any failures. To override the default behavior, you can set the `esql.query.allow_partial_results` cluster setting to `false`. (DEFAULT: 1) * 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) diff --git a/src/Endpoints/Features.php b/src/Endpoints/Features.php index 7fcaf8dc5..5be61966b 100644 --- a/src/Endpoints/Features.php +++ b/src/Endpoints/Features.php @@ -34,7 +34,7 @@ class Features extends AbstractEndpoint * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/get-features-api.html * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -71,7 +71,7 @@ public function getFeatures(?array $params = null) * @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) diff --git a/src/Endpoints/Fleet.php b/src/Endpoints/Fleet.php index 72cf9180a..bd8076556 100644 --- a/src/Endpoints/Fleet.php +++ b/src/Endpoints/Fleet.php @@ -35,10 +35,10 @@ class Fleet extends AbstractEndpoint * * @param array{ * index: string, // (REQUIRED) The name of the index. - * wait_for_advance?: bool, // Whether to wait for the global checkpoint to advance past the specified current checkpoints - * wait_for_index?: bool, // Whether to wait for the target index to exist and all primary shards be active - * checkpoints?: string|array, // Comma separated list of checkpoints - * timeout?: int|string, // Timeout to wait for global checkpoint to advance + * wait_for_advance?: bool, // A boolean value which controls whether to wait (until the timeout) for the global checkpoints to advance past the provided `checkpoints`. + * wait_for_index?: bool, // A boolean value which controls whether to wait (until the timeout) for the target index to exist and all primary shards be active. Can only be true when `wait_for_advance` is true. + * checkpoints?: string|array, // A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`, the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list will cause Elasticsearch to immediately return the current global checkpoints. (DEFAULT: Array) + * timeout?: int|string, // Period to wait for a global checkpoints to advance past `checkpoints`. (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) @@ -121,9 +121,9 @@ public function msearch(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The index name to search. - * wait_for_checkpoints?: string|array, // Comma separated list of checkpoints, one per shard + * wait_for_checkpoints?: string|array, // A comma separated list of checkpoints. When configured, the search API will only be executed on a shard after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause Elasticsearch to immediately execute the search. (DEFAULT: Array) * wait_for_checkpoints_timeout?: int|string, // Explicit wait_for_checkpoints timeout - * 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, // If true, returns partial results if there are shard request timeouts or shard failures. If false, returns an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results` which is true by default. (DEFAULT: 1) * 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) diff --git a/src/Endpoints/Graph.php b/src/Endpoints/Graph.php index 703665b8d..051e98c79 100644 --- a/src/Endpoints/Graph.php +++ b/src/Endpoints/Graph.php @@ -36,8 +36,8 @@ class Graph extends AbstractEndpoint * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * routing?: string|array, // Specific routing value - * timeout?: int|string, // Explicit operation timeout + * routing?: string|array, // Custom value used to route operations to a specific shard. + * timeout?: int|string, // Specifies the period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. Defaults to no timeout. * 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) diff --git a/src/Endpoints/Ilm.php b/src/Endpoints/Ilm.php index dea2b569e..bf6ea5356 100644 --- a/src/Endpoints/Ilm.php +++ b/src/Endpoints/Ilm.php @@ -35,8 +35,8 @@ class Ilm extends AbstractEndpoint * * @param array{ * policy: string, // (REQUIRED) The name of the index lifecycle policy - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -75,9 +75,9 @@ public function deleteLifecycle(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the index to explain - * only_managed?: bool, // filters the indices included in the response to ones managed by ILM - * only_errors?: bool, // filters the indices included in the response to ones in an ILM error state, implies only_managed - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * only_managed?: bool, // Filters the returned indices to only indices that are managed by ILM. + * only_errors?: bool, // Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. + * 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) @@ -116,8 +116,8 @@ public function explainLifecycle(?array $params = null) * * @param array{ * policy?: string, // The name of the index lifecycle policy - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -192,7 +192,7 @@ public function getStatus(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-migrate-to-data-tiers.html * * @param array{ - * dry_run?: bool, // If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false + * dry_run?: bool, // If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides a way to retrieve the indices and ILM policies that need to be migrated. * 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) @@ -271,8 +271,8 @@ public function moveToStep(?array $params = null) * * @param array{ * policy: string, // (REQUIRED) The name of the index lifecycle policy - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -388,8 +388,8 @@ public function retry(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-start.html * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -425,8 +425,8 @@ public function start(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ilm-stop.html * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) diff --git a/src/Endpoints/Indices.php b/src/Endpoints/Indices.php index b1bc55e01..23921ea73 100644 --- a/src/Endpoints/Indices.php +++ b/src/Endpoints/Indices.php @@ -37,11 +37,11 @@ class Indices extends AbstractEndpoint * @param array{ * index: string|array, // (REQUIRED) A comma separated list of indices to add a block to * block: string, // (REQUIRED) The block to add (one of read, write, read_only or metadata) - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * timeout?: int|string, // The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to `-1` to indicate that the request should never timeout. (DEFAULT: 30s) + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (DEFAULT: 30s) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. (DEFAULT: open) * 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) @@ -163,13 +163,13 @@ public function cancelMigrateReindex(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index name to limit the operation - * fielddata?: bool, // Clear field data - * fields?: string|array, // A comma-separated list of fields to clear when using the `fielddata` parameter (default: all) - * query?: bool, // Clear query caches - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * request?: bool, // Clear request cache + * fielddata?: bool, // If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only. + * fields?: string|array, // Comma-separated list of field names used to limit the `fielddata` parameter. + * query?: bool, // If `true`, clears the query cache. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * request?: bool, // If `true`, clears the request cache. * 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) @@ -211,9 +211,9 @@ public function clearCache(?array $params = null) * @param array{ * index: string, // (REQUIRED) The name of the source index to clone * target: string, // (REQUIRED) The name of the target index to clone into - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * wait_for_active_shards?: string, // Set the number of active shards to wait for on the cloned index before the operation returns. + * 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) + * 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) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) * 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) @@ -254,12 +254,12 @@ public function clone(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma separated list of indices to close - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * wait_for_active_shards?: string, // Sets the number of active shards to wait for before the operation returns. + * 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) + * 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) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) * 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) @@ -299,9 +299,9 @@ public function close(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the index - * wait_for_active_shards?: string, // Set the number of active shards to wait for before the operation returns. - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) + * 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) + * 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) @@ -343,8 +343,8 @@ public function create(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the data stream - * timeout?: int|string, // Specify timeout for acknowledging the cluster state update - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -425,7 +425,7 @@ public function createFrom(?array $params = null) * * @param array{ * name?: string|array, // A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams - * expand_wildcards?: string|array, // Whether to expand wildcard expressions to concrete data stream names that are open, closed or both. + * expand_wildcards?: string|array, // Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open,closed) * 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) @@ -467,11 +467,11 @@ public function dataStreamsStats(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * ignore_unavailable?: bool, // Ignore unavailable indexes (default: false) - * allow_no_indices?: bool, // Ignore if a wildcard expression resolves to no concrete indices (default: false) - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open, closed, or hidden indices + * 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) + * 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) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open,closed) * 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) @@ -512,8 +512,8 @@ public function delete(?array $params = null) * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names (supports wildcards); use `_all` for all indices * name: string|array, // (REQUIRED) A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. - * timeout?: int|string, // Explicit timestamp for the document - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -553,9 +553,9 @@ public function deleteAlias(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * timeout?: int|string, // Explicit timestamp for the document - * master_timeout?: int|string, // Specify timeout for connection to master + * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) (DEFAULT: open) + * timeout?: int|string, // The period to wait for a response. (DEFAULT: 30s) + * master_timeout?: int|string, // The period to wait for a connection to the master node. (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) @@ -595,8 +595,8 @@ public function deleteDataLifecycle(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of data streams to delete; use `*` to delete all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * master_timeout?: int|string, // Specify timeout for connection to master + * expand_wildcards?: string|array, // Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. (DEFAULT: open) + * 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) @@ -635,9 +635,9 @@ public function deleteDataStream(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of data streams of which the data stream options will be deleted; use `*` to get all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * timeout?: int|string, // Explicit timestamp for the document - * master_timeout?: int|string, // Specify timeout for connection to master + * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (DEFAULT: open) + * timeout?: int|string, // The period to wait for a response. (DEFAULT: 30s) + * master_timeout?: int|string, // The period to wait for a connection to the master node. (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) @@ -677,8 +677,8 @@ public function deleteDataStreamOptions(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -717,8 +717,8 @@ public function deleteIndexTemplate(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -758,11 +758,11 @@ public function deleteTemplate(?array $params = null) * * @param array{ * index: string, // (REQUIRED) Comma-separated list of indices or data streams to analyze the disk usage - * run_expensive_tasks?: bool, // Must be set to [true] in order for the task to be performed. Defaults to false. - * flush?: bool, // Whether flush or not before analyzing the index disk usage. Defaults to true - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * run_expensive_tasks?: bool, // Analyzing field disk usage is resource-intensive. To use the API, this parameter must be set to `true`. + * flush?: bool, // If `true`, the API performs a flush before analysis. If `false`, the response may not include uncommitted data. (DEFAULT: 1) + * ignore_unavailable?: bool, // If `true`, missing or closed indices are not included in the response. + * allow_no_indices?: bool, // If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) * 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) @@ -844,12 +844,12 @@ public function downsample(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * ignore_unavailable?: bool, // Ignore unavailable indexes (default: false) - * allow_no_indices?: bool, // Ignore if a wildcard expression resolves to no concrete indices (default: false) - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * flat_settings?: bool, // Return settings in flat format (default: false) - * include_defaults?: bool, // Whether to return all default setting for each of the indices. + * local?: bool, // If `true`, the request retrieves information from the local node only. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * flat_settings?: bool, // If `true`, returns settings in flat format. + * include_defaults?: bool, // If `true`, return all default settings in the response. * 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) @@ -890,10 +890,10 @@ public function exists(?array $params = null) * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of alias names to return * index?: string|array, // A comma-separated list of index names to filter aliases - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * ignore_unavailable?: bool, // If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: all) + * local?: bool, // If `true`, the request retrieves information from the local node only. * 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) @@ -937,9 +937,9 @@ public function existsAlias(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * flat_settings?: bool, // Return settings in flat format (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * flat_settings?: bool, // If true, returns settings in flat format. + * 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) + * local?: bool, // If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. * 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) @@ -978,9 +978,9 @@ public function existsIndexTemplate(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) The comma separated names of the index templates - * flat_settings?: bool, // Return settings in flat format (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * flat_settings?: bool, // Indicates whether to use a flat format for the response. + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * local?: bool, // Indicates whether to get information from the local node only. * 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) @@ -1020,8 +1020,8 @@ public function existsTemplate(?array $params = null) * * @param array{ * index: string, // (REQUIRED) The name of the index to explain - * include_defaults?: bool, // indicates if the API should return the default values the system uses for the index's lifecycle - * master_timeout?: int|string, // Specify timeout for connection to master + * include_defaults?: bool, // Indicates if the API should return the default values the system uses for the index's lifecycle + * master_timeout?: int|string, // The period to wait for a connection to the master node. (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) @@ -1061,10 +1061,10 @@ public function explainDataLifecycle(?array $params = null) * * @param array{ * index: string, // (REQUIRED) A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * fields?: string|array, // A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards) - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * fields?: string|array, // Comma-separated list or wildcard expressions of fields to include in the statistics. + * ignore_unavailable?: bool, // If `true`, missing or closed indices are not included in the response. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) * 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) @@ -1103,11 +1103,11 @@ public function fieldUsageStats(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string for all indices - * force?: bool, // Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) - * wait_if_ongoing?: bool, // If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * force?: bool, // If `true`, the request forces a flush even if there are no changes to commit to the index. (DEFAULT: 1) + * wait_if_ongoing?: bool, // If `true`, the flush operation blocks until execution when another flush operation is running. If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. (DEFAULT: 1) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) * 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) @@ -1148,13 +1148,13 @@ public function flush(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * flush?: bool, // Specify whether the index should be flushed after performing the operation (default: true) + * flush?: bool, // Specify whether the index should be flushed after performing the operation (DEFAULT: 1) * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. (DEFAULT: open) * max_num_segments?: int, // The number of segments the index should be merged into (default: dynamic) * only_expunge_deletes?: bool, // Specify whether the operation should only expunge deleted documents - * wait_for_completion?: bool, // Should the request wait until the force merge is completed. + * wait_for_completion?: bool, // Should the request wait until the force merge is completed (DEFAULT: 1) * 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) @@ -1196,14 +1196,14 @@ public function forcemerge(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * ignore_unavailable?: bool, // Ignore unavailable indexes (default: false) - * allow_no_indices?: bool, // Ignore if a wildcard expression resolves to no concrete indices (default: false) - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * features?: string|array, // Return only information on specified index features - * flat_settings?: bool, // Return settings in flat format (default: false) - * include_defaults?: bool, // Whether to return all default setting for each of the indices. - * master_timeout?: int|string, // Specify timeout for connection to master + * local?: bool, // If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + * ignore_unavailable?: bool, // If false, requests that target a missing index return an error. + * allow_no_indices?: bool, // If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden. (DEFAULT: open) + * features?: string|array, // Return only information on specified index features (DEFAULT: ['aliases', 'mappings', 'settings']) + * flat_settings?: bool, // If true, returns settings in flat format. + * include_defaults?: bool, // If true, return all default settings in the response. + * 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) @@ -1244,10 +1244,10 @@ public function get(?array $params = null) * @param array{ * name?: string|array, // A comma-separated list of alias names to return * index?: string|array, // A comma-separated list of index names to filter aliases - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: all) + * local?: bool, // If `true`, the request retrieves information from the local node only. * 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) @@ -1295,9 +1295,9 @@ public function getAlias(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of data streams to get; use `*` to get all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * include_defaults?: bool, // Return all relevant default configurations for the data stream (default: false) - * master_timeout?: int|string, // Specify timeout for connection to master + * expand_wildcards?: string|array, // Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * include_defaults?: bool, // If `true`, return all default settings in the response. + * 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) @@ -1372,10 +1372,10 @@ public function getDataLifecycleStats(?array $params = null) * * @param array{ * name?: string|array, // A comma-separated list of data streams to get; use `*` to get all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * include_defaults?: bool, // Return all relevant default configurations for the data stream (default: false) - * master_timeout?: int|string, // Specify timeout for connection to master - * verbose?: bool, // Whether the maximum timestamp for each data stream should be calculated and returned (default: false) + * expand_wildcards?: string|array, // Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * include_defaults?: bool, // If true, returns all relevant default configurations for the index template. + * 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) + * verbose?: bool, // Whether the maximum timestamp for each data stream should be calculated and returned. * 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) @@ -1417,8 +1417,8 @@ public function getDataStream(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of data streams to get; use `*` to get all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * master_timeout?: int|string, // Specify timeout for connection to master + * expand_wildcards?: string|array, // Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. (DEFAULT: open) + * 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) @@ -1458,7 +1458,7 @@ public function getDataStreamOptions(?array $params = null) * * @param array{ * name: string, // (REQUIRED) Comma-separated list of data streams or data stream patterns - * master_timeout?: int|string, // Period to wait for a connection to the master node + * master_timeout?: int|string, // The 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) @@ -1498,11 +1498,11 @@ public function getDataStreamSettings(?array $params = null) * @param array{ * fields: string|array, // (REQUIRED) A comma-separated list of fields * index?: string|array, // A comma-separated list of index names - * include_defaults?: bool, // Whether the default mapping values should be returned as well - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * include_defaults?: bool, // If `true`, return all default settings in the response. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * local?: bool, // If `true`, the request retrieves information from the local node only. * 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) @@ -1546,10 +1546,10 @@ public function getFieldMapping(?array $params = null) * * @param array{ * name?: string, // A pattern that returned template names must match - * flat_settings?: bool, // Return settings in flat format (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * include_defaults?: bool, // Return all relevant default configurations for the index template (default: false) + * flat_settings?: bool, // If true, returns settings in flat format. + * 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) + * local?: bool, // If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node. + * include_defaults?: bool, // If true, returns all relevant default configurations for the index template. * 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) @@ -1591,11 +1591,11 @@ public function getIndexTemplate(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * master_timeout?: int|string, // Specify timeout for connection to master - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * 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) + * local?: bool, // If `true`, the request retrieves information from the local node only. * 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) @@ -1677,13 +1677,13 @@ public function getMigrateReindexStatus(?array $params = null) * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices * name?: string|array, // The name of the settings that should be included - * master_timeout?: int|string, // Specify timeout for connection to master - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * flat_settings?: bool, // Return settings in flat format (default: false) - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * include_defaults?: bool, // Whether to return all default setting for each of the indices. + * 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) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * flat_settings?: bool, // If `true`, returns settings in flat format. + * local?: bool, // If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. + * include_defaults?: bool, // If `true`, return all default settings in the response. * 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) @@ -1730,9 +1730,9 @@ public function getSettings(?array $params = null) * * @param array{ * name?: string|array, // The comma separated names of the index templates - * flat_settings?: bool, // Return settings in flat format (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * flat_settings?: bool, // If `true`, returns settings in flat format. + * 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) + * local?: bool, // If `true`, the request retrieves information from the local node only. * 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) @@ -1812,8 +1812,8 @@ public function migrateReindex(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the alias to migrate - * timeout?: int|string, // Specify timeout for acknowledging the cluster state update - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -1891,12 +1891,12 @@ public function modifyDataStream(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma separated list of indices to open - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * wait_for_active_shards?: string, // Sets the number of active shards to wait for before the operation returns. + * 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) + * 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) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: closed) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) * 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) @@ -1935,7 +1935,7 @@ public function open(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the data stream - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) @@ -1976,8 +1976,8 @@ public function promoteDataStream(?array $params = null) * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. * name: string, // (REQUIRED) The name of the alias to be created or updated - * timeout?: int|string, // Explicit timestamp for the document - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -2019,9 +2019,9 @@ public function putAlias(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of data streams whose lifecycle will be updated; use `*` to set the lifecycle to all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * timeout?: int|string, // Explicit timestamp for the document - * master_timeout?: int|string, // Specify timeout for connection to master + * expand_wildcards?: string|array, // Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * 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) + * 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) @@ -2063,9 +2063,9 @@ public function putDataLifecycle(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of data streams whose options will be updated; use `*` to set the options to all data streams - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * timeout?: int|string, // Explicit timestamp for the document - * master_timeout?: int|string, // Specify timeout for connection to master + * expand_wildcards?: string|array, // Type of data stream that wildcard patterns can match. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `hidden`, `open`, `closed`, `none`. (DEFAULT: open) + * 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) + * 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) @@ -2107,9 +2107,9 @@ public function putDataStreamOptions(?array $params = null) * * @param array{ * name: string, // (REQUIRED) Comma-separated list of data streams or data stream patterns - * dry_run?: bool, // Whether this request should only be a dry run rather than actually applying settings - * timeout?: int|string, // Period to wait for a response - * master_timeout?: int|string, // Period to wait for a connection to the master node + * dry_run?: bool, // If `true`, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied. + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. (DEFAULT: 30s) + * master_timeout?: int|string, // The 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) @@ -2151,9 +2151,9 @@ public function putDataStreamSettings(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * create?: bool, // Whether the index template should only be added if new or can also replace an existing one - * cause?: string, // User defined reason for creating/updating the index template - * master_timeout?: int|string, // Specify timeout for connection to master + * create?: bool, // If `true`, this request cannot replace or update existing index templates. + * cause?: string, // User defined reason for creating or updating the index template (DEFAULT: api) + * 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) @@ -2195,12 +2195,12 @@ public function putIndexTemplate(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * write_index_only?: bool, // When true, applies mappings only to the write index of an alias or data stream + * 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) + * 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) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * write_index_only?: bool, // If `true`, the mappings are applied only to the current write index for the target. * 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) @@ -2242,14 +2242,14 @@ public function putMapping(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * master_timeout?: int|string, // Specify timeout for connection to master - * timeout?: int|string, // Explicit operation timeout - * preserve_existing?: bool, // Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` - * reopen?: bool, // Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false` - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * flat_settings?: bool, // Return settings in flat format (default: false) + * 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) + * preserve_existing?: bool, // If `true`, existing index settings remain unchanged. + * reopen?: bool, // Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. + * ignore_unavailable?: bool, // If `true`, returns settings in flat format. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * flat_settings?: bool, // If `true`, returns settings in flat format. * 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) @@ -2294,10 +2294,10 @@ public function putSettings(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the template - * order?: int, // The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) - * create?: bool, // Whether the index template should only be added if new or can also replace an existing one - * cause?: string, // User defined reason for creating/updating the index template - * master_timeout?: int|string, // Specify timeout for connection to master + * order?: int, // Order in which Elasticsearch applies this template if index matches multiple templates. Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values. + * create?: bool, // If true, this request cannot replace or update existing index templates. + * cause?: string, // User defined reason for creating or updating the index template + * 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) @@ -2338,11 +2338,11 @@ public function putTemplate(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * detailed?: bool, // Whether to display detailed information about shard recovery - * active_only?: bool, // Display only those recoveries that are currently on-going - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * detailed?: bool, // If `true`, the response includes detailed information about shard recoveries. + * active_only?: bool, // If `true`, the response only includes ongoing shard recoveries. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) * 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) @@ -2384,9 +2384,9 @@ public function recovery(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) * 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) @@ -2429,8 +2429,8 @@ public function refresh(?array $params = null) * index: string|array, // (REQUIRED) A comma-separated list of index names to reload analyzers for * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * resource?: string, // changed resource to reload analyzers from if applicable + * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. (DEFAULT: open) + * resource?: string, // Changed resource to reload analyzers from if applicable * 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) @@ -2469,11 +2469,11 @@ public function reloadSearchAnalyzers(?array $params = null) * * @param array{ * name?: string|array, // A comma-separated list of cluster:index names or wildcard expressions - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed). Only allowed when providing an index expression. - * ignore_throttled?: bool, // Whether specified concrete, expanded or aliased indices should be ignored when throttled. Only allowed when providing an index expression. - * 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). Only allowed when providing an index expression. - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open). Only allowed when providing an index expression. - * timeout?: int|string, // The maximum time to wait for remote clusters to respond + * ignore_unavailable?: bool, // If false, the request returns an error if it targets a missing or closed index. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. + * ignore_throttled?: bool, // If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. + * allow_no_indices?: bool, // If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the `_resolve/cluster` API endpoint that takes no index expression. (DEFAULT: open) + * timeout?: int|string, // The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out. The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds). * 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) @@ -2515,9 +2515,9 @@ public function resolveCluster(?array $params = null) * * @param array{ * name: string|array, // (REQUIRED) A comma-separated list of names or wildcard expressions - * expand_wildcards?: string|array, // Whether wildcard expressions should get expanded to open or closed indices (default: open) - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) * 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) @@ -2558,10 +2558,10 @@ public function resolveIndex(?array $params = null) * @param array{ * alias: string, // (REQUIRED) The name of the alias to rollover * new_index?: string, // The name of the rollover index - * timeout?: int|string, // Explicit operation timeout - * dry_run?: bool, // If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false - * master_timeout?: int|string, // Specify timeout for connection to master - * wait_for_active_shards?: string, // Set the number of active shards to wait for on the newly created rollover index before the operation returns. + * 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) + * dry_run?: bool, // If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + * 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) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) * lazy?: bool, // If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams. * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) @@ -2607,10 +2607,10 @@ public function rollover(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * verbose?: bool, // Includes detailed memory usage by Lucene. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * verbose?: bool, // If `true`, the request returns a verbose response. * 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) @@ -2651,10 +2651,10 @@ public function segments(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * status?: string|array, // A comma-separated list of statuses used to filter on shards to get store information for - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * status?: string|array, // List of shard health statuses used to limit the request. + * ignore_unavailable?: bool, // If true, missing or closed indices are not included in the response. + * allow_no_indices?: bool, // If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. (DEFAULT: open) * 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) @@ -2696,9 +2696,9 @@ public function shardStores(?array $params = null) * @param array{ * index: string, // (REQUIRED) The name of the source index to shrink * target: string, // (REQUIRED) The name of the target index to shrink into - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * wait_for_active_shards?: string, // Set the number of active shards to wait for on the shrunken index before the operation returns. + * 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) + * 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) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) * 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) @@ -2741,9 +2741,9 @@ public function shrink(?array $params = null) * @param array{ * name: string, // (REQUIRED) The name of the index (it must be a concrete index name) * create?: bool, // Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one - * cause?: string, // User defined reason for dry-run creating the new template for simulation purposes - * master_timeout?: int|string, // Specify timeout for connection to master - * include_defaults?: bool, // Return all relevant default configurations for this index template simulation (default: false) + * cause?: string, // User defined reason for dry-run creating the new template for simulation purposes (DEFAULT: false) + * 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) + * include_defaults?: bool, // If true, returns all relevant default configurations for the index template. * 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) @@ -2785,10 +2785,10 @@ public function simulateIndexTemplate(?array $params = null) * * @param array{ * name?: string, // The name of the index template - * create?: bool, // Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one - * cause?: string, // User defined reason for dry-run creating the new template for simulation purposes - * master_timeout?: int|string, // Specify timeout for connection to master - * include_defaults?: bool, // Return all relevant default configurations for this template simulation (default: false) + * create?: bool, // If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. + * cause?: string, // User defined reason for dry-run creating the new template for simulation purposes (DEFAULT: false) + * 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) + * include_defaults?: bool, // If true, returns all relevant default configurations for the index template. * 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) @@ -2832,9 +2832,9 @@ public function simulateTemplate(?array $params = null) * @param array{ * index: string, // (REQUIRED) The name of the source index to split * target: string, // (REQUIRED) The name of the target index to split into - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * wait_for_active_shards?: string, // Set the number of active shards to wait for on the shrunken index before the operation returns. + * 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) + * 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) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) * 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) @@ -2876,15 +2876,15 @@ public function split(?array $params = null) * @param array{ * metric?: string|array, // Limit the information returned the specific metrics. * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * completion_fields?: string|array, // A comma-separated list of fields for the `completion` index metric (supports wildcards) - * fielddata_fields?: string|array, // A comma-separated list of fields for the `fielddata` index metric (supports wildcards) - * fields?: string|array, // A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) - * groups?: string|array, // A comma-separated list of search groups for `search` index metric - * level?: string, // Return stats aggregated at cluster, index or shard level - * include_segment_file_sizes?: bool, // Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) - * include_unloaded_segments?: bool, // If set to true segment stats will include stats for segments that are not currently loaded into memory - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * forbid_closed_indices?: bool, // If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices + * completion_fields?: string|array, // Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + * fielddata_fields?: string|array, // Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + * fields?: string|array, // Comma-separated list or wildcard expressions of fields to include in the statistics. + * groups?: string|array, // Comma-separated list of search groups to include in the search statistics. + * level?: string, // Indicates whether statistics are aggregated at the cluster, indices, or shards level. (DEFAULT: indices) + * include_segment_file_sizes?: bool, // If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + * include_unloaded_segments?: bool, // If true, the response includes information from segments that are not loaded into memory. + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * forbid_closed_indices?: bool, // If true, statistics are not collected from closed indices. (DEFAULT: 1) * 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) @@ -2931,12 +2931,12 @@ public function stats(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma separated list of indices to remove a block from - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * wait_for_active_shards?: string, // Sets the number of active shards to wait for before the operation returns. + * 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) + * 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) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. (DEFAULT: open) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). (DEFAULT: 1) * 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) @@ -2975,8 +2975,8 @@ public function unfreeze(?array $params = null) * @group serverless * * @param array{ - * timeout?: int|string, // Request timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * 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) + * 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) @@ -3017,18 +3017,18 @@ public function updateAliases(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices - * explain?: bool, // Return detailed information about the error - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * q?: string, // Query in the Lucene query string syntax - * analyzer?: string, // The analyzer to use for the query string - * analyze_wildcard?: bool, // Specify whether wildcard and prefix queries should be analyzed (default: false) - * default_operator?: string, // The default operator for query string query (AND or OR) - * df?: string, // The field to use as default where no field prefix is given in the query string - * lenient?: bool, // Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - * rewrite?: bool, // Provide a more detailed explanation showing the actual Lucene query that will be executed. - * all_shards?: bool, // Execute validation on all shards instead of one random shard per index + * explain?: bool, // If `true`, the response returns detailed information if an error has occurred. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * q?: string, // Query in the Lucene query string syntax. + * analyzer?: string, // Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified. + * analyze_wildcard?: bool, // If `true`, wildcard and prefix queries are analyzed. + * default_operator?: string, // The default operator for query string query: `and` or `or`. (DEFAULT: or) + * df?: string, // Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified. + * lenient?: bool, // If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + * rewrite?: bool, // If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + * all_shards?: bool, // If `true`, the validation is executed on all shards instead of one random shard per index. * 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) diff --git a/src/Endpoints/Inference.php b/src/Endpoints/Inference.php index ad64f16b8..c8d5f4334 100644 --- a/src/Endpoints/Inference.php +++ b/src/Endpoints/Inference.php @@ -36,7 +36,7 @@ class Inference extends AbstractEndpoint * * @param array{ * inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. + * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. (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) @@ -78,7 +78,7 @@ public function chatCompletionUnified(?array $params = null) * * @param array{ * inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. + * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. (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) @@ -121,8 +121,8 @@ public function completion(?array $params = null) * @param array{ * inference_id: string, // (REQUIRED) The inference Id * task_type?: string, // The task type - * dry_run?: bool, // If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned. - * force?: bool, // If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields). + * dry_run?: bool, // When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned. + * force?: bool, // When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields. * 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) @@ -212,7 +212,7 @@ public function get(?array $params = null) * @param array{ * inference_id: string, // (REQUIRED) The inference Id * task_type?: string, // The task type - * timeout?: int|string, // The amount of time to wait for the inference request to complete. + * timeout?: int|string, // The amount of time to wait for the inference request to complete. (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) @@ -259,7 +259,7 @@ public function inference(?array $params = null) * @param array{ * inference_id: string, // (REQUIRED) The inference Id * task_type?: string, // The task type - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -306,7 +306,7 @@ public function put(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * alibabacloud_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -349,7 +349,7 @@ public function putAlibabacloud(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * amazonbedrock_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -392,7 +392,7 @@ public function putAmazonbedrock(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * amazonsagemaker_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -435,7 +435,7 @@ public function putAmazonsagemaker(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * anthropic_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -478,7 +478,7 @@ public function putAnthropic(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * azureaistudio_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -521,7 +521,7 @@ public function putAzureaistudio(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * azureopenai_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -564,7 +564,7 @@ public function putAzureopenai(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * cohere_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -649,7 +649,7 @@ public function putCustom(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * deepseek_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -692,7 +692,7 @@ public function putDeepseek(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * elasticsearch_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -735,7 +735,7 @@ public function putElasticsearch(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * elser_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -778,7 +778,7 @@ public function putElser(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * googleaistudio_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -821,7 +821,7 @@ public function putGoogleaistudio(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * googlevertexai_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -864,7 +864,7 @@ public function putGooglevertexai(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * huggingface_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -907,7 +907,7 @@ public function putHuggingFace(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * jinaai_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -950,7 +950,7 @@ public function putJinaai(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * mistral_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -993,7 +993,7 @@ public function putMistral(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * openai_inference_id: string, // (REQUIRED) The inference ID - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -1036,7 +1036,7 @@ public function putOpenai(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * voyageai_inference_id: string, // (REQUIRED) The inference ID - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -1079,7 +1079,7 @@ public function putVoyageai(?array $params = null) * @param array{ * task_type: string, // (REQUIRED) The task type * watsonx_inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. + * timeout?: int|string, // Specifies the amount of time to wait for the inference endpoint to be created. (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) @@ -1121,7 +1121,7 @@ public function putWatsonx(?array $params = null) * * @param array{ * inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // The amount of time to wait for the inference request to complete. + * timeout?: int|string, // The amount of time to wait for the inference request to complete. (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) @@ -1163,7 +1163,7 @@ public function rerank(?array $params = null) * * @param array{ * inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. + * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. (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) @@ -1204,7 +1204,7 @@ public function sparseEmbedding(?array $params = null) * * @param array{ * inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // The amount of time to wait for the inference request to complete. + * timeout?: int|string, // The amount of time to wait for the inference request to complete. (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) @@ -1246,7 +1246,7 @@ public function streamCompletion(?array $params = null) * * @param array{ * inference_id: string, // (REQUIRED) The inference Id - * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. + * timeout?: int|string, // Specifies the amount of time to wait for the inference request to complete. (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) diff --git a/src/Endpoints/Ingest.php b/src/Endpoints/Ingest.php index 797dcb7ea..30dac519c 100644 --- a/src/Endpoints/Ingest.php +++ b/src/Endpoints/Ingest.php @@ -35,8 +35,8 @@ class Ingest extends AbstractEndpoint * * @param array{ * id: string|array, // (REQUIRED) A comma-separated list of geoip database configurations to delete - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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, // The 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) @@ -75,8 +75,8 @@ public function deleteGeoipDatabase(?array $params = null) * * @param array{ * id: string|array, // (REQUIRED) A comma-separated list of ip location database configurations to delete - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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. A value of `-1` indicates that the request should never time out. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. A value of `-1` indicates that the request should never time out. (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) @@ -116,8 +116,8 @@ public function deleteIpLocationDatabase(?array $params = null) * * @param array{ * id: string, // (REQUIRED) Pipeline ID - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -272,8 +272,8 @@ public function getIpLocationDatabase(?array $params = null) * * @param array{ * id?: string, // Comma separated list of pipeline ids. Wildcards supported - * summary?: bool, // Return pipelines without their definitions (default: false) - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * summary?: bool, // Return pipelines without their definitions + * 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) @@ -350,8 +350,8 @@ public function processorGrok(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The id of the database configuration - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -392,8 +392,8 @@ public function putGeoipDatabase(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The id of the database configuration - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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. A value of `-1` indicates that the request should never time out. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. A value of `-1` indicates that the request should never time out. (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) @@ -436,8 +436,8 @@ public function putIpLocationDatabase(?array $params = null) * @param array{ * id: string, // (REQUIRED) Pipeline ID * if_version?: int, // Required version for optimistic concurrency control for pipeline updates - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -479,7 +479,7 @@ public function putPipeline(?array $params = null) * * @param array{ * id?: string, // Pipeline ID - * verbose?: bool, // Verbose mode. Display data output for each processor in executed pipeline + * verbose?: bool, // If `true`, the response includes output data for each processor in the executed pipeline. * 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) diff --git a/src/Endpoints/License.php b/src/Endpoints/License.php index 6ae57fe20..e3e37a098 100644 --- a/src/Endpoints/License.php +++ b/src/Endpoints/License.php @@ -34,8 +34,8 @@ class License extends AbstractEndpoint * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/delete-license.html * * @param array{ - * 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, // The period to wait for a connection to the master node. (DEFAULT: 30s) + * timeout?: int|string, // The 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) @@ -72,8 +72,8 @@ public function delete(?array $params = null) * @group serverless * * @param array{ - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * accept_enterprise?: bool, // Supported for backwards compatibility with 7.x. If this param is used it must be set to true + * local?: bool, // Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. + * accept_enterprise?: bool, // If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. This parameter is deprecated and will always be set to true in 8.x. (DEFAULT: 1) * 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) @@ -179,9 +179,9 @@ public function getTrialStatus(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-license-post * * @param array{ - * acknowledge?: bool, // whether the user has acknowledged acknowledge messages (default: false) - * master_timeout?: int|string, // Timeout for processing on master node - * timeout?: int|string, // Timeout for acknowledgement of update from all nodes in cluster + * acknowledge?: bool, // Specifies whether you acknowledge the license changes. + * master_timeout?: int|string, // The period to wait for a connection to the master node. (DEFAULT: 30s) + * timeout?: int|string, // The 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) @@ -219,9 +219,9 @@ public function post(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-basic.html * * @param array{ - * acknowledge?: bool, // whether the user has acknowledged acknowledge messages (default: false) - * master_timeout?: int|string, // Timeout for processing on master node - * timeout?: int|string, // Timeout for acknowledgement of update from all nodes in cluster + * acknowledge?: bool, // Whether the user has acknowledged acknowledge messages + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -257,9 +257,9 @@ public function postStartBasic(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/start-trial.html * * @param array{ - * type?: string, // The type of trial license to generate (default: "trial") - * acknowledge?: bool, // whether the user has acknowledged acknowledge messages (default: false) - * master_timeout?: int|string, // Timeout for processing on master node + * type?: string, // The type of trial license to generate (DEFAULT: trial) + * acknowledge?: bool, // Whether the user has acknowledged acknowledge messages + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) diff --git a/src/Endpoints/Ml.php b/src/Endpoints/Ml.php index 7c1bd5fdc..1c09f17ea 100644 --- a/src/Endpoints/Ml.php +++ b/src/Endpoints/Ml.php @@ -75,9 +75,9 @@ public function clearTrainedModelDeploymentCache(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The name of the job to close - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) - * force?: bool, // True if the job should be forcefully closed - * timeout?: int|string, // Controls the time to wait until a job has closed. Default to 30 minutes + * allow_no_match?: bool, // Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * force?: bool, // Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots. If you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future. + * timeout?: int|string, // Controls the time to wait until a job has closed. (DEFAULT: 30m) * 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) @@ -238,8 +238,8 @@ public function deleteCalendarJob(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The ID of the data frame analytics to delete - * force?: bool, // True if the job should be forcefully deleted - * timeout?: int|string, // Controls the time to wait until a job is deleted. Defaults to 1 minute + * force?: bool, // If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + * timeout?: int|string, // The time to wait for the job to be deleted. (DEFAULT: 1m) * 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) @@ -279,7 +279,7 @@ public function deleteDataFrameAnalytics(?array $params = null) * * @param array{ * datafeed_id: string, // (REQUIRED) The ID of the datafeed to delete - * force?: bool, // True if the datafeed should be forcefully deleted + * force?: bool, // Use to forcefully delete a started datafeed; this method is quicker than stopping and deleting the datafeed. * 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) @@ -318,8 +318,8 @@ public function deleteDatafeed(?array $params = null) * * @param array{ * job_id?: string, // The ID of the job(s) to perform expired data hygiene for - * requests_per_second?: int, // The desired requests per second for the deletion processes. - * timeout?: int|string, // How long can the underlying delete processes run until they are canceled + * requests_per_second?: int, // The desired requests per second for the deletion processes. The default behavior is no throttling. + * timeout?: int|string, // How long can the underlying delete processes run until they are canceled. (DEFAULT: 8h) * 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) @@ -402,8 +402,8 @@ public function deleteFilter(?array $params = null) * @param array{ * job_id: string, // (REQUIRED) The ID of the job from which to delete forecasts * forecast_id?: string, // The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all` - * allow_no_forecasts?: bool, // Whether to ignore if `_all` matches no forecasts - * timeout?: int|string, // Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds + * allow_no_forecasts?: bool, // Specifies whether an error occurs when there are no forecasts. In particular, if this parameter is set to `false` and there are no forecasts associated with the job, attempts to delete all forecasts return an error. (DEFAULT: 1) + * timeout?: int|string, // Specifies the period of time to wait for the completion of the delete operation. When this period of time elapses, the API 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) @@ -447,9 +447,9 @@ public function deleteForecast(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The ID of the job to delete - * force?: bool, // True if the job should be forcefully deleted - * wait_for_completion?: bool, // Should this request wait until the operation has completed before returning - * delete_user_annotations?: bool, // Should annotations added by the user be deleted + * force?: bool, // Use to forcefully delete an opened job; this method is quicker than closing and deleting the job. + * wait_for_completion?: bool, // Specifies whether the request should return immediately or wait until the job deletion completes. (DEFAULT: 1) + * delete_user_annotations?: bool, // Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset. * 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) @@ -528,8 +528,8 @@ public function deleteModelSnapshot(?array $params = null) * * @param array{ * model_id: string, // (REQUIRED) The ID of the trained model to delete - * timeout?: int|string, // Controls the amount of time to wait for the model to be deleted. - * force?: bool, // True if the model should be forcefully deleted + * 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) + * force?: bool, // Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. * 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) @@ -730,11 +730,11 @@ public function explainDataFrameAnalytics(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The name of the job to flush - * calc_interim?: bool, // Calculates interim results for the most recent bucket or all buckets within the latency period - * start?: string, // When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results - * end?: string, // When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results - * advance_time?: string, // Advances time to the given value generating results and updating the model for the advanced interval - * skip_time?: string, // Skips time to the given value without generating results or updating the model for the skipped interval + * calc_interim?: bool, // If true, calculates the interim results for the most recent bucket or all buckets within the latency period. + * start?: string, // When used in conjunction with `calc_interim`, specifies the range of buckets on which to calculate interim results. + * end?: string, // When used in conjunction with `calc_interim` and `start`, specifies the range of buckets on which to calculate interim results. + * advance_time?: string, // Specifies to advance to a particular time value. Results are generated and the model is updated for data from the specified time interval. + * skip_time?: string, // Specifies to skip to a particular time value. Results are not generated and the model is not updated for data from the specified time interval. * 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) @@ -775,9 +775,9 @@ public function flushJob(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The ID of the job to forecast for - * duration?: int|string, // The duration of the forecast - * expires_in?: int|string, // The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity. - * max_model_memory?: string, // The max memory able to be used by the forecast. Default is 20mb. + * duration?: int|string, // A period of time that indicates how far into the future to forecast. For example, `30d` corresponds to 30 days. The forecast starts at the last record that was processed. (DEFAULT: 1d) + * expires_in?: int|string, // The period of time that forecast results are retained. After a forecast expires, the results are deleted. If set to a value of 0, the forecast is never automatically deleted. (DEFAULT: 14d) + * max_model_memory?: string, // The maximum memory the forecast can use. If the forecast needs to use more than the provided amount, it will spool to disk. Default is 20mb, maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s configured memory limit, it is automatically reduced to below that amount. (DEFAULT: 20mb) * 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) @@ -819,15 +819,15 @@ public function forecast(?array $params = null) * @param array{ * job_id: string, // (REQUIRED) ID of the job to get bucket results from * timestamp?: string, // The timestamp of the desired single bucket result - * expand?: bool, // Include anomaly records - * exclude_interim?: bool, // Exclude interim results - * from?: int, // skips a number of buckets - * size?: int, // specifies a max number of buckets to get - * start?: string, // Start time filter for buckets - * end?: string, // End time filter for buckets - * anomaly_score?: float, // Filter for the most anomalous buckets - * sort?: string, // Sort buckets by a particular field - * desc?: bool, // Set the sort direction + * expand?: bool, // If true, the output includes anomaly records. + * exclude_interim?: bool, // If `true`, the output excludes interim results. + * from?: int, // Skips the specified number of buckets. + * size?: int, // Specifies the maximum number of buckets to obtain. (DEFAULT: 100) + * start?: string, // Returns buckets with timestamps after this time. `-1` means it is unset and results are not limited to specific timestamps. (DEFAULT: -1) + * end?: string, // Returns buckets with timestamps earlier than this time. `-1` means it is unset and results are not limited to specific timestamps. (DEFAULT: -1) + * anomaly_score?: float, // Returns buckets with anomaly scores greater or equal than this value. + * sort?: string, // Specifies the sort field for the requested buckets. (DEFAULT: timestamp) + * desc?: bool, // If `true`, the buckets are sorted in descending order. * 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) @@ -873,11 +873,11 @@ public function getBuckets(?array $params = null) * * @param array{ * calendar_id: string, // (REQUIRED) The ID of the calendar containing the events - * job_id?: string, // Get events for the job. When this option is used calendar_id must be '_all' - * start?: string, // Get events after this time - * end?: string, // Get events before this time - * from?: int, // Skips a number of events - * size?: int, // Specifies a max number of events to get + * job_id?: string, // Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. + * start?: string, // Specifies to get events with timestamps after this time. + * end?: string, // Specifies to get events with timestamps earlier than this time. + * from?: int, // Skips the specified number of events. + * size?: int, // Specifies the maximum number of events to obtain. (DEFAULT: 100) * 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) @@ -917,8 +917,8 @@ public function getCalendarEvents(?array $params = null) * * @param array{ * calendar_id?: string, // The ID of the calendar to fetch - * from?: int, // skips a number of calendars - * size?: int, // specifies a max number of calendars to get + * from?: int, // Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. + * size?: int, // Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. (DEFAULT: 10000) * 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) @@ -962,9 +962,9 @@ public function getCalendars(?array $params = null) * @param array{ * job_id: string, // (REQUIRED) The name of the job * category_id?: int, // The identifier of the category definition of interest - * from?: int, // skips a number of categories - * size?: int, // specifies a max number of categories to get - * partition_field_value?: string, // Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled. + * from?: int, // Skips the specified number of categories. + * size?: int, // Specifies the maximum number of categories to obtain. (DEFAULT: 100) + * partition_field_value?: string, // Only return categories for the specified partition. * 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) @@ -1010,10 +1010,10 @@ public function getCategories(?array $params = null) * * @param array{ * id?: string, // The ID of the data frame analytics to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) - * from?: int, // skips a number of analytics - * size?: int, // specifies a max number of analytics to get - * exclude_generated?: bool, // Omits fields that are illegal to set on data frame analytics PUT + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * from?: int, // Skips the specified number of data frame analytics jobs. + * size?: int, // Specifies the maximum number of data frame analytics jobs to obtain. (DEFAULT: 100) + * exclude_generated?: bool, // Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. * 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) @@ -1055,10 +1055,10 @@ public function getDataFrameAnalytics(?array $params = null) * * @param array{ * id?: string, // The ID of the data frame analytics stats to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) - * from?: int, // skips a number of analytics - * size?: int, // specifies a max number of analytics to get - * verbose?: bool, // whether the stats response should be verbose + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * from?: int, // Skips the specified number of data frame analytics jobs. + * size?: int, // Specifies the maximum number of data frame analytics jobs to obtain. (DEFAULT: 100) + * verbose?: bool, // Defines whether the stats response should be verbose. * 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) @@ -1100,7 +1100,7 @@ public function getDataFrameAnalyticsStats(?array $params = null) * * @param array{ * datafeed_id?: string, // The ID of the datafeeds stats to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. * 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) @@ -1142,8 +1142,8 @@ public function getDatafeedStats(?array $params = null) * * @param array{ * datafeed_id?: string, // The ID of the datafeeds to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) - * exclude_generated?: bool, // Omits fields that are illegal to set on datafeed PUT + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no datafeeds that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `datafeeds` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. + * exclude_generated?: bool, // Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. * 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) @@ -1185,8 +1185,8 @@ public function getDatafeeds(?array $params = null) * * @param array{ * filter_id?: string, // The ID of the filter to fetch - * from?: int, // skips a number of filters - * size?: int, // specifies a max number of filters to get + * from?: int, // Skips the specified number of filters. + * size?: int, // Specifies the maximum number of filters to obtain. (DEFAULT: 100) * 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) @@ -1227,14 +1227,14 @@ public function getFilters(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) Identifier for the anomaly detection job - * exclude_interim?: bool, // Exclude interim results - * from?: int, // skips a number of influencers - * size?: int, // specifies a max number of influencers to get - * start?: string, // start timestamp for the requested influencers - * end?: string, // end timestamp for the requested influencers - * influencer_score?: float, // influencer score threshold for the requested influencers - * sort?: string, // sort field for the requested influencers - * desc?: bool, // whether the results should be sorted in decending order + * exclude_interim?: bool, // If true, the output excludes interim results. By default, interim results are included. + * from?: int, // Skips the specified number of influencers. + * size?: int, // Specifies the maximum number of influencers to obtain. (DEFAULT: 100) + * start?: string, // Returns influencers with timestamps after this time. The default value means it is unset and results are not limited to specific timestamps. (DEFAULT: -1) + * end?: string, // Returns influencers with timestamps earlier than this time. The default value means it is unset and results are not limited to specific timestamps. (DEFAULT: -1) + * influencer_score?: float, // Returns influencers with anomaly scores greater than or equal to this value. + * sort?: string, // Specifies the sort field for the requested influencers. By default, the influencers are sorted by the `influencer_score` value. + * desc?: bool, // If true, the results are sorted in descending order. * 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) @@ -1276,7 +1276,7 @@ public function getInfluencers(?array $params = null) * * @param array{ * job_id?: string, // The ID of the jobs stats to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a `404` status code when there are no matches or only partial matches. (DEFAULT: 1) * 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) @@ -1318,8 +1318,8 @@ public function getJobStats(?array $params = null) * * @param array{ * job_id?: string, // The ID of the jobs to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) - * exclude_generated?: bool, // Omits fields that are illegal to set on job PUT + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is `true`, which returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. (DEFAULT: 1) + * exclude_generated?: bool, // Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. * 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) @@ -1360,8 +1360,8 @@ public function getJobs(?array $params = null) * * @param array{ * node_id?: string, // Specifies the node or nodes to retrieve stats for. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -1403,7 +1403,7 @@ public function getMemoryStats(?array $params = null) * @param array{ * job_id: string, // (REQUIRED) The ID of the job. May be a wildcard, comma separated list or `_all`. * snapshot_id: string, // (REQUIRED) The ID of the snapshot. May be a wildcard, comma separated list or `_all`. - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.) + * allow_no_match?: bool, // Specifies what to do when the request: - Contains wildcard expressions and there are no jobs that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. The default value is true, which returns an empty jobs array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. * 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) @@ -1443,12 +1443,12 @@ public function getModelSnapshotUpgradeStats(?array $params = null) * @param array{ * job_id: string, // (REQUIRED) The ID of the job to fetch * snapshot_id?: string, // The ID of the snapshot to fetch - * from?: int, // Skips a number of documents - * size?: int, // The default number of documents returned in queries as a string. - * start?: string, // The filter 'start' query parameter - * end?: string, // The filter 'end' query parameter - * sort?: string, // Name of the field to sort on - * desc?: bool, // True if the results should be sorted in descending order + * from?: int, // Skips the specified number of snapshots. + * size?: int, // Specifies the maximum number of snapshots to obtain. (DEFAULT: 100) + * start?: string, // Returns snapshots with timestamps after this time. + * end?: string, // Returns snapshots with timestamps earlier than this time. + * sort?: string, // Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp. + * desc?: bool, // If true, the results are sorted in descending order. * 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) @@ -1494,13 +1494,13 @@ public function getModelSnapshots(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The job IDs for which to calculate overall bucket results - * top_n?: int, // The number of top job bucket scores to be used in the overall_score calculation - * bucket_span?: int|string, // The span of the overall buckets. Defaults to the longest job bucket_span - * overall_score?: float, // Returns overall buckets with overall scores higher than this value - * exclude_interim?: bool, // If true overall buckets that include interim buckets will be excluded - * start?: string, // Returns overall buckets with timestamps after this time - * end?: string, // Returns overall buckets with timestamps earlier than this time - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + * top_n?: int, // The number of top anomaly detection job bucket scores to be used in the `overall_score` calculation. (DEFAULT: 1) + * bucket_span?: int|string, // The span of the overall buckets. Must be greater or equal to the largest bucket span of the specified anomaly detection jobs, which is the default value. By default, an overall bucket has a span equal to the largest bucket span of the specified anomaly detection jobs. To override that behavior, use the optional `bucket_span` parameter. + * overall_score?: float, // Returns overall buckets with overall scores greater than or equal to this value. + * exclude_interim?: bool, // If `true`, the output excludes interim results. + * start?: string, // Returns overall buckets with timestamps after this time. + * end?: string, // Returns overall buckets with timestamps earlier than this time. + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no jobs that match. 2. Contains the `_all` string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If `true`, the request returns an empty `jobs` array when there are no matches and the subset of results when there are partial matches. If this parameter is `false`, the request returns a `404` status code when there are no matches or only partial matches. (DEFAULT: 1) * 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) @@ -1541,14 +1541,14 @@ public function getOverallBuckets(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The ID of the job - * exclude_interim?: bool, // Exclude interim results - * from?: int, // skips a number of records - * size?: int, // specifies a max number of records to get - * start?: string, // Start time filter for records - * end?: string, // End time filter for records - * record_score?: float, // Returns records with anomaly scores greater or equal than this value - * sort?: string, // Sort records by a particular field - * desc?: bool, // Set the sort direction + * exclude_interim?: bool, // If `true`, the output excludes interim results. + * from?: int, // Skips the specified number of records. + * size?: int, // Specifies the maximum number of records to obtain. (DEFAULT: 100) + * start?: string, // Returns records with timestamps after this time. The default value means results are not limited to specific timestamps. (DEFAULT: -1) + * end?: string, // Returns records with timestamps earlier than this time. The default value means results are not limited to specific timestamps. (DEFAULT: -1) + * record_score?: float, // Returns records with anomaly scores greater or equal than this value. + * sort?: string, // Specifies the sort field for the requested records. (DEFAULT: record_score) + * desc?: bool, // If true, the results are sorted in descending order. * 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) @@ -1590,14 +1590,14 @@ public function getRecords(?array $params = null) * * @param array{ * model_id?: string, // The ID of the trained models to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) - * include?: string, // A comma delimited string of optional fields to include in the responsebody. - * include_model_definition?: bool, // Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false. - * decompress_definition?: bool, // Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true. - * from?: int, // skips a number of trained models - * size?: int, // specifies a max number of trained models to get - * tags?: string|array, // A comma-separated list of tags that the model must have. - * exclude_generated?: bool, // Omits fields that are illegal to set on model PUT + * allow_no_match?: bool, // Specifies what to do when the request: - Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If true, it returns an empty array when there are no matches and the subset of results when there are partial matches. (DEFAULT: 1) + * include?: string, // A comma delimited string of optional fields to include in the response body. + * include_model_definition?: bool, // parameter is deprecated! Use [include=definition] instead + * decompress_definition?: bool, // Specifies whether the included model definition should be returned as a JSON map (true) or in a custom compressed format (false). (DEFAULT: 1) + * from?: int, // Skips the specified number of models. + * size?: int, // Specifies the maximum number of models to obtain. (DEFAULT: 100) + * tags?: string|array, // A comma delimited string of tags. A trained model can have many tags, or none. When supplied, only trained models that contain all the supplied tags are returned. + * exclude_generated?: bool, // Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. * 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) @@ -1639,9 +1639,9 @@ public function getTrainedModels(?array $params = null) * * @param array{ * model_id?: string, // The ID of the trained models stats to fetch - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) - * from?: int, // skips a number of trained models - * size?: int, // specifies a max number of trained models to get + * allow_no_match?: bool, // Specifies what to do when the request: - Contains wildcard expressions and there are no models that match. - Contains the _all string or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches. If true, it returns an empty array when there are no matches and the subset of results when there are partial matches. (DEFAULT: 1) + * from?: int, // Skips the specified number of models. + * size?: int, // Specifies the maximum number of models to obtain. (DEFAULT: 100) * 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) @@ -1683,7 +1683,7 @@ public function getTrainedModelsStats(?array $params = null) * * @param array{ * model_id: string, // (REQUIRED) The unique identifier of the trained model. - * timeout?: int|string, // Controls the amount of time to wait for inference results. + * timeout?: int|string, // Controls the amount of time to wait for inference results. (DEFAULT: 10s) * 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) @@ -1760,7 +1760,7 @@ public function info(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The ID of the job to open - * timeout?: int|string, // Controls the time to wait until a job has opened. + * timeout?: int|string, // Controls the time to wait until a job has opened. (DEFAULT: 30m) * 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) @@ -1842,8 +1842,8 @@ public function postCalendarEvents(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The name of the job receiving the data - * reset_start?: string, // Optional parameter to specify the start of the bucket resetting range - * reset_end?: string, // Optional parameter to specify the end of the bucket resetting range + * reset_start?: string, // Specifies the start of the bucket resetting range. + * reset_end?: string, // Specifies the end of the bucket resetting range. * 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) @@ -2095,10 +2095,10 @@ public function putDataFrameAnalytics(?array $params = null) * * @param array{ * datafeed_id: string, // (REQUIRED) The ID of the datafeed to create - * ignore_unavailable?: bool, // Ignore unavailable indexes (default: false) - * allow_no_indices?: bool, // Ignore if the source indices expressions resolves to no concrete indices (default: true) - * ignore_throttled?: bool, // Ignore indices that are marked as throttled (default: true) - * expand_wildcards?: string|array, // Whether source index expressions should get expanded to open or closed indices (default: open) + * ignore_unavailable?: bool, // If true, unavailable indices (missing or closed) are ignored. + * allow_no_indices?: bool, // If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` string or when no indices are specified. (DEFAULT: 1) + * ignore_throttled?: bool, // If true, concrete, expanded, or aliased indices are ignored when frozen. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values. (DEFAULT: open) * 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) @@ -2181,10 +2181,10 @@ public function putFilter(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The ID of the job to create - * ignore_unavailable?: bool, // Ignore unavailable indexes (default: false). Only set if datafeed_config is provided. - * allow_no_indices?: bool, // Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided. - * ignore_throttled?: bool, // Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided. - * expand_wildcards?: string|array, // Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided. + * ignore_unavailable?: bool, // If `true`, unavailable indices (missing or closed) are ignored. + * allow_no_indices?: bool, // If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` string or when no indices are specified. (DEFAULT: 1) + * ignore_throttled?: bool, // If `true`, concrete, expanded or aliased indices are ignored when frozen. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values. (DEFAULT: open) * 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) @@ -2227,7 +2227,7 @@ public function putJob(?array $params = null) * @param array{ * model_id: string, // (REQUIRED) The ID of the trained models to store * defer_definition_decompression?: bool, // If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. - * wait_for_completion?: bool, // Whether to wait for all child operations(e.g. model download) to complete, before returning or not. Default to false + * wait_for_completion?: bool, // Whether to wait for all child operations (e.g. model download) to complete. * 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) @@ -2270,7 +2270,7 @@ public function putTrainedModel(?array $params = null) * @param array{ * model_alias: string, // (REQUIRED) The trained model alias to update * model_id: string, // (REQUIRED) The trained model where the model alias should be assigned - * reassign?: bool, // If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false. + * reassign?: bool, // Specifies whether the alias gets reassigned to the specified trained model if it is already assigned to a different model. If the alias is already assigned and this parameter is false, the API returns an error. * 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) @@ -2394,8 +2394,8 @@ public function putTrainedModelVocabulary(?array $params = null) * * @param array{ * job_id: string, // (REQUIRED) The ID of the job to reset - * wait_for_completion?: bool, // Should this request wait until the operation has completed before returning - * delete_user_annotations?: bool, // Should annotations added by the user be deleted + * wait_for_completion?: bool, // Should this request wait until the operation has completed before returning. (DEFAULT: 1) + * delete_user_annotations?: bool, // Specifies whether annotations that have been added by the user should be deleted along with any auto-generated annotations when the job is reset. * 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) @@ -2435,7 +2435,7 @@ public function resetJob(?array $params = null) * @param array{ * job_id: string, // (REQUIRED) The ID of the job to fetch * snapshot_id: string, // (REQUIRED) The ID of the snapshot to revert to - * delete_intervening_results?: bool, // Should we reset the results back to the time of the snapshot? + * delete_intervening_results?: bool, // If true, deletes the results in the time period between the latest results and the time of the reverted snapshot. It also resets the model to accept records for this time period. If you choose not to delete intervening results when reverting a snapshot, the job will not accept input data that is older than the current time. If you want to resend data, then delete the intervening results. * 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) @@ -2475,8 +2475,8 @@ public function revertModelSnapshot(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/ml-set-upgrade-mode.html * * @param array{ - * enabled?: bool, // Whether to enable upgrade_mode ML setting or not. Defaults to false. - * timeout?: int|string, // Controls the time to wait before action times out. Defaults to 30 seconds + * enabled?: bool, // When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from starting. + * timeout?: int|string, // The time to wait for the request to be completed. (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) @@ -2514,7 +2514,7 @@ public function setUpgradeMode(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The ID of the data frame analytics to start - * timeout?: int|string, // Controls the time to wait until the task has started. Defaults to 20 seconds + * timeout?: int|string, // Controls the amount of time to wait until the data frame analytics job starts. (DEFAULT: 20s) * 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) @@ -2556,9 +2556,9 @@ public function startDataFrameAnalytics(?array $params = null) * * @param array{ * datafeed_id: string, // (REQUIRED) The ID of the datafeed to start - * start?: string, // The start time from where the datafeed should begin - * end?: string, // The end time when the datafeed should stop. When not set, the datafeed continues in real time - * timeout?: int|string, // Controls the time to wait until a datafeed has started. Default to 20 seconds + * start?: string, // The time that the datafeed should begin, which can be specified by using the same formats as the `end` parameter. This value is inclusive. If you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis starts from the earliest time for which data is available. If you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest processed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record. + * end?: string, // The time that the datafeed should end, which can be specified by using one of the following formats: * ISO 8601 format with milliseconds, for example `2017-01-22T06:00:00.000Z` * ISO 8601 format without milliseconds, for example `2017-01-22T06:00:00+00:00` * Milliseconds since the epoch, for example `1485061200000` Date-time arguments using either of the ISO 8601 formats must have a time zone designator, where `Z` is accepted as an abbreviation for UTC time. When a URL is expected (for example, in browsers), the `+` used in time zone designators must be encoded as `%2B`. The end time value is exclusive. If you do not specify an end time, the datafeed runs continuously. + * timeout?: int|string, // Specifies the amount of time to wait until a datafeed starts. (DEFAULT: 20s) * 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) @@ -2600,14 +2600,14 @@ public function startDatafeed(?array $params = null) * * @param array{ * model_id: string, // (REQUIRED) The unique identifier of the trained model. - * cache_size?: string, // A byte-size value for configuring the inference cache size. For example, 20mb. - * deployment_id?: string, // The Id of the new deployment. Defaults to the model_id if not set. - * number_of_allocations?: int, // The total number of allocations this model is assigned across machine learning nodes. - * threads_per_allocation?: int, // The number of threads used by each model allocation during inference. - * priority?: string, // The deployment priority. - * queue_capacity?: int, // Controls how many inference requests are allowed in the queue at a time. - * timeout?: int|string, // Controls the amount of time to wait for the model to deploy. - * wait_for?: string, // Specifies the allocation status to wait for before returning. + * cache_size?: string, // The inference cache size (in memory outside the JVM heap) per node for the model. The default value is the same size as the `model_size_bytes`. To disable the cache, `0b` can be provided. + * deployment_id?: string, // A unique identifier for the deployment of the model. + * number_of_allocations?: int, // The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. If adaptive_allocations is enabled, do not set this value, because it’s automatically set. (DEFAULT: 1) + * threads_per_allocation?: int, // Sets the number of threads used by each model allocation during inference. This generally increases the inference speed. The inference process is a compute-bound process; any number greater than the number of available hardware threads on the machine does not increase the inference speed. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. (DEFAULT: 1) + * priority?: string, // The deployment priority + * queue_capacity?: int, // Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds this value, new requests are rejected with a 429 error. (DEFAULT: 1024) + * timeout?: int|string, // Specifies the amount of time to wait for the model to deploy. (DEFAULT: 20s) + * wait_for?: string, // Specifies the allocation status to wait for before returning. (DEFAULT: started) * 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) @@ -2649,9 +2649,9 @@ public function startTrainedModelDeployment(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The ID of the data frame analytics to stop - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) - * force?: bool, // True if the data frame analytics should be forcefully stopped - * timeout?: int|string, // Controls the time to wait until the task has stopped. Defaults to 20 seconds + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no data frame analytics jobs that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. The default value is true, which returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * force?: bool, // If true, the data frame analytics job is stopped forcefully. + * timeout?: int|string, // Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds. (DEFAULT: 20s) * 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) @@ -2693,9 +2693,9 @@ public function stopDataFrameAnalytics(?array $params = null) * * @param array{ * datafeed_id: string, // (REQUIRED) The ID of the datafeed to stop - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) - * force?: bool, // True if the datafeed should be forcefully stopped. - * timeout?: int|string, // Controls the time to wait until a datafeed has stopped. Default to 20 seconds + * allow_no_match?: bool, // Specifies what to do when the request: * Contains wildcard expressions and there are no datafeeds that match. * Contains the `_all` string or no identifiers and there are no matches. * Contains wildcard expressions and there are only partial matches. If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * force?: bool, // If `true`, the datafeed is stopped forcefully. + * timeout?: int|string, // Specifies the amount of time to wait until a datafeed stops. (DEFAULT: 20s) * 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) @@ -2737,8 +2737,8 @@ public function stopDatafeed(?array $params = null) * * @param array{ * model_id: string, // (REQUIRED) The unique identifier of the trained model. - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified) - * force?: bool, // True if the deployment should be forcefully stopped + * allow_no_match?: bool, // Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. If `false`, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * force?: bool, // Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you restart the model deployment. * 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) @@ -2821,10 +2821,10 @@ public function updateDataFrameAnalytics(?array $params = null) * * @param array{ * datafeed_id: string, // (REQUIRED) The ID of the datafeed to update - * ignore_unavailable?: bool, // Ignore unavailable indexes (default: false) - * allow_no_indices?: bool, // Ignore if the source indices expressions resolves to no concrete indices (default: true) - * ignore_throttled?: bool, // Ignore indices that are marked as throttled (default: true) - * expand_wildcards?: string|array, // Whether source index expressions should get expanded to open or closed indices (default: open) + * ignore_unavailable?: bool, // If `true`, unavailable indices (missing or closed) are ignored. + * allow_no_indices?: bool, // If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` string or when no indices are specified. (DEFAULT: 1) + * ignore_throttled?: bool, // If `true`, concrete, expanded or aliased indices are ignored when frozen. (DEFAULT: 1) + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values. (DEFAULT: open) * 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) @@ -2989,7 +2989,7 @@ public function updateModelSnapshot(?array $params = null) * * @param array{ * model_id: string, // (REQUIRED) The unique identifier of the trained model. - * number_of_allocations?: int, // Update the model deployment to this number of allocations. + * number_of_allocations?: int, // The number of model allocations on each node where the model is deployed. All allocations on a node share the same copy of the model in memory but use a separate set of threads to evaluate the model. Increasing this value generally increases the throughput. If this setting is greater than the number of hardware threads it will automatically be changed to a value less than the number of hardware threads. (DEFAULT: 1) * 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) @@ -3031,8 +3031,8 @@ public function updateTrainedModelDeployment(?array $params = null) * @param array{ * job_id: string, // (REQUIRED) The ID of the job * snapshot_id: string, // (REQUIRED) The ID of the snapshot - * timeout?: int|string, // How long should the API wait for the job to be opened and the old snapshot to be loaded. - * wait_for_completion?: bool, // Should the request wait until the task is complete before responding to the caller. Default is false. + * timeout?: int|string, // Controls the time to wait for the request to complete. (DEFAULT: 30m) + * wait_for_completion?: bool, // When true, the API won’t respond until the upgrade is complete. Otherwise, it responds as soon as the upgrade task is assigned to a node. * 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) diff --git a/src/Endpoints/Monitoring.php b/src/Endpoints/Monitoring.php index 6392eb137..08c020163 100644 --- a/src/Endpoints/Monitoring.php +++ b/src/Endpoints/Monitoring.php @@ -35,7 +35,7 @@ class Monitoring extends AbstractEndpoint * * @param array{ * system_id?: string, // Identifier of the monitored system - * system_api_version?: string, // API Version of the monitored system + * system_api_version?: string, // * interval?: int|string, // Collection interval (e.g., '10s' or '10000ms') of the payload * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) diff --git a/src/Endpoints/Nodes.php b/src/Endpoints/Nodes.php index a2df22425..ac0308557 100644 --- a/src/Endpoints/Nodes.php +++ b/src/Endpoints/Nodes.php @@ -114,13 +114,13 @@ public function getRepositoriesMeteringInfo(?array $params = null) * * @param array{ * node_id?: string|array, // 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 - * interval?: int|string, // The interval for the second sampling of threads - * snapshots?: int, // Number of samples of thread stacktrace (default: 10) - * threads?: int, // Specify the number of threads to provide information for (default: 3) - * ignore_idle_threads?: bool, // Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) - * type?: string, // The type to sample (default: cpu) - * sort?: string, // The sort order for 'cpu' type (default: total) - * timeout?: int|string, // Explicit operation timeout + * interval?: int|string, // The interval to do the second sampling of threads. (DEFAULT: 500ms) + * snapshots?: int, // Number of samples of thread stacktrace. (DEFAULT: 10) + * threads?: int, // Specifies the number of hot threads to provide information for. (DEFAULT: 3) + * ignore_idle_threads?: bool, // If true, known idle threads (e.g. waiting in a socket select, or to get a task from an empty queue) are filtered out. (DEFAULT: 1) + * type?: string, // The type to sample. (DEFAULT: cpu) + * sort?: string, // The sort order for 'cpu' type (DEFAULT: total) + * 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) @@ -162,8 +162,8 @@ public function hotThreads(?array $params = null) * @param array{ * node_id?: string|array, // 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 * metric?: string|array, // A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. - * flat_settings?: bool, // Return settings in flat format (default: false) - * timeout?: int|string, // Explicit operation timeout + * flat_settings?: bool, // If true, returns settings in flat format. + * 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) @@ -210,7 +210,7 @@ public function info(?array $params = null) * * @param array{ * node_id?: string|array, // A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -255,15 +255,15 @@ public function reloadSecureSettings(?array $params = null) * node_id?: string|array, // 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 * metric?: string|array, // Limit the information returned to the specified metrics * index_metric?: string|array, // Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. - * completion_fields?: string|array, // A comma-separated list of fields for the `completion` index metric (supports wildcards) - * fielddata_fields?: string|array, // A comma-separated list of fields for the `fielddata` index metric (supports wildcards) - * fields?: string|array, // A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) - * groups?: bool, // A comma-separated list of search groups for `search` index metric - * level?: string, // Return indices stats aggregated at index, node or shard level - * types?: string|array, // A comma-separated list of document types for the `indexing` index metric - * timeout?: int|string, // Explicit operation timeout - * include_segment_file_sizes?: bool, // Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) - * include_unloaded_segments?: bool, // If set to true segment stats will include stats for segments that are not currently loaded into memory + * completion_fields?: string|array, // Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + * fielddata_fields?: string|array, // Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + * fields?: string|array, // Comma-separated list or wildcard expressions of fields to include in the statistics. + * groups?: bool, // Comma-separated list of search groups to include in the search statistics. + * level?: string, // Indicates whether statistics are aggregated at the node, indices, or shards level. (DEFAULT: node) + * types?: string|array, // A comma-separated list of document types for the indexing index metric. + * 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) + * include_segment_file_sizes?: bool, // If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + * include_unloaded_segments?: bool, // If `true`, the response includes information from segments that are not loaded into memory. * 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) @@ -317,7 +317,7 @@ public function stats(?array $params = null) * @param array{ * node_id?: string|array, // 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 * metric?: string|array, // Limit the information returned to the specified metrics - * timeout?: int|string, // Explicit operation timeout + * 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) diff --git a/src/Endpoints/Profiling.php b/src/Endpoints/Profiling.php index 5fb068db9..126770e15 100644 --- a/src/Endpoints/Profiling.php +++ b/src/Endpoints/Profiling.php @@ -110,8 +110,8 @@ public function stacktraces(?array $params = null) * @link https://www.elastic.co/guide/en/observability/current/universal-profiling.html * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) * wait_for_resources_created?: bool, // Whether to return immediately or wait until resources have been created * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) diff --git a/src/Endpoints/QueryRules.php b/src/Endpoints/QueryRules.php index 01eae9ab9..78b2d171d 100644 --- a/src/Endpoints/QueryRules.php +++ b/src/Endpoints/QueryRules.php @@ -193,8 +193,8 @@ public function getRuleset(?array $params = null) * @group serverless * * @param array{ - * from?: int, // Starting offset (default: 0) - * size?: int, // specifies a max number of results to get (default: 100) + * from?: int, // The offset from the first result to fetch. + * size?: int, // The maximum number of results to retrieve. (DEFAULT: 100) * 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) diff --git a/src/Endpoints/Rollup.php b/src/Endpoints/Rollup.php index 92e819700..dd758dfbf 100644 --- a/src/Endpoints/Rollup.php +++ b/src/Endpoints/Rollup.php @@ -319,8 +319,8 @@ public function startJob(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The ID of the job to stop - * wait_for_completion?: bool, // True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false. - * timeout?: int|string, // Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s. + * wait_for_completion?: bool, // If set to `true`, causes the API to block until the indexer state completely stops. If set to `false`, the API returns immediately and the indexer is stopped asynchronously in the background. + * timeout?: int|string, // If `wait_for_completion` is `true`, the API blocks for (at maximum) the specified duration while waiting for the job to stop. If more than `timeout` time has passed, the API throws a timeout exception. NOTE: Even if a timeout occurs, the stop request is still processing and eventually moves the job to STOPPED. The timeout simply means the API call itself timed out while waiting for the status change. (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) diff --git a/src/Endpoints/SearchApplication.php b/src/Endpoints/SearchApplication.php index b90bbb827..d2c59821f 100644 --- a/src/Endpoints/SearchApplication.php +++ b/src/Endpoints/SearchApplication.php @@ -195,9 +195,9 @@ public function getBehavioralAnalytics(?array $params = null) * @group serverless * * @param array{ - * q?: string, // Query in the Lucene query string syntax - * from?: int, // Starting offset (default: 0) - * size?: int, // specifies a max number of results to get + * q?: string, // Query in the Lucene query string syntax. + * from?: int, // Starting offset. + * size?: int, // Specifies a max number of results to get. * 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) @@ -236,7 +236,7 @@ public function list(?array $params = null) * @param array{ * collection_name: string, // (REQUIRED) The name of behavioral analytics collection * event_type: string, // (REQUIRED) Behavioral analytics event type. Available: page_view, search, search_click - * debug?: bool, // If true, returns event information that will be stored + * debug?: bool, // Whether the response type has to include more details * 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) @@ -278,7 +278,7 @@ public function postBehavioralAnalyticsEvent(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the search application to be created or updated - * create?: bool, // If true, requires that a search application with the specified resource_id does not already exist. (default: false) + * create?: bool, // If `true`, this request cannot replace or update existing Search Applications. * 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) @@ -401,7 +401,7 @@ public function renderQuery(?array $params = null) * * @param array{ * name: string, // (REQUIRED) The name of the search application to be searched - * typed_keys?: bool, // Specify whether aggregation and suggester names should be prefixed by their respective types in the response + * typed_keys?: bool, // Determines whether aggregation names are 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) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) diff --git a/src/Endpoints/SearchableSnapshots.php b/src/Endpoints/SearchableSnapshots.php index 82bd4466f..8d245c1fa 100644 --- a/src/Endpoints/SearchableSnapshots.php +++ b/src/Endpoints/SearchableSnapshots.php @@ -79,7 +79,7 @@ public function cacheStats(?array $params = null) * index?: string|array, // Clear the cache * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both (DEFAULT: open) * 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) @@ -121,9 +121,9 @@ public function clearCache(?array $params = null) * @param array{ * repository: string, // (REQUIRED) The name of the repository containing the snapshot of the index to mount * snapshot: string, // (REQUIRED) The name of the snapshot of the index to mount - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * wait_for_completion?: bool, // Should this request wait until the operation has completed before returning - * storage?: string, // Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy` + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * wait_for_completion?: bool, // If true, the request blocks until the operation is complete. + * storage?: string, // The mount option for the searchable snapshot index. (DEFAULT: full_copy) * 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) @@ -164,7 +164,7 @@ public function mount(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names - * level?: string, // Return stats aggregated at cluster, index or shard level + * level?: string, // Return stats aggregated at cluster, index or shard level (DEFAULT: indices) * 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) diff --git a/src/Endpoints/Security.php b/src/Endpoints/Security.php index f3aa8ed98..4a3484c5a 100644 --- a/src/Endpoints/Security.php +++ b/src/Endpoints/Security.php @@ -345,7 +345,7 @@ public function clearCachedPrivileges(?array $params = null) * * @param array{ * realms: string|array, // (REQUIRED) Comma-separated list of realms to clear - * usernames?: string|array, // Comma-separated list of usernames to clear from the cache + * usernames?: string|array, // A comma-separated list of the users to clear from the cache. If you do not specify this parameter, the API evicts all users from the user cache. * 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) @@ -542,7 +542,7 @@ public function createCrossClusterApiKey(?array $params = null) * namespace: string, // (REQUIRED) An identifier for the namespace * service: string, // (REQUIRED) An identifier for the service name * name?: string, // An identifier for the token name - * refresh?: string, // If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + * refresh?: string, // If `true` (the default) 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` then do nothing with refreshes. * 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) @@ -743,7 +743,7 @@ public function deleteRoleMapping(?array $params = null) * namespace: string, // (REQUIRED) An identifier for the namespace * service: string, // (REQUIRED) An identifier for the service name * name: string, // (REQUIRED) An identifier for the token name - * refresh?: string, // If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + * refresh?: string, // If `true` (the default) 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` then do nothing with refreshes. * 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) @@ -860,7 +860,7 @@ public function disableUser(?array $params = null) * * @param array{ * uid: string, // (REQUIRED) Unique identifier for the user profile - * refresh?: string, // If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + * refresh?: string, // If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes. (DEFAULT: false) * 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) @@ -938,7 +938,7 @@ public function enableUser(?array $params = null) * * @param array{ * uid: string, // (REQUIRED) An unique identifier of the user profile - * refresh?: string, // If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + * refresh?: string, // If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes. (DEFAULT: false) * 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) @@ -1049,14 +1049,14 @@ public function enrollNode(?array $params = null) * @group serverless * * @param array{ - * id?: string, // API key id of the API key to be retrieved - * name?: string, // API key name of the API key to be retrieved - * username?: string, // user name of the user who created this API key to be retrieved - * realm_name?: string, // realm name of the user who created this API key to be retrieved - * owner?: bool, // flag to query API keys owned by the currently authenticated user - * with_limited_by?: bool, // flag to show the limited-by role descriptors of API Keys - * with_profile_uid?: bool, // flag to also retrieve the API Key's owner profile uid, if it exists - * active_only?: bool, // flag to limit response to only active (not invalidated or expired) API keys + * id?: string, // An API key id. This parameter cannot be used with any of `name`, `realm_name` or `username`. + * name?: string, // An API key name. This parameter cannot be used with any of `id`, `realm_name` or `username`. It supports prefix search with wildcard. + * username?: string, // The username of a user. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. + * realm_name?: string, // The name of an authentication realm. This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. + * owner?: bool, // A boolean flag that can be used to query API keys owned by the currently authenticated user. The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. + * with_limited_by?: bool, // Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors. + * with_profile_uid?: bool, // Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. + * active_only?: bool, // A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys. * 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) @@ -1334,7 +1334,7 @@ public function getServiceCredentials(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-get-settings.html * * @param array{ - * master_timeout?: int|string, // Timeout for connection to master + * 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) @@ -1410,7 +1410,7 @@ public function getToken(?array $params = null) * * @param array{ * username?: string|array, // A comma-separated list of usernames - * with_profile_uid?: bool, // flag to retrieve profile uid (if exists) associated to the user + * with_profile_uid?: bool, // Determines whether to retrieve the user profile UID, if it exists, for the users. * 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) @@ -1486,7 +1486,7 @@ public function getUserPrivileges(?array $params = null) * * @param array{ * uid: string|array, // (REQUIRED) A comma-separated list of unique identifier for user profiles - * data?: string|array, // A comma-separated list of keys for which the corresponding application data are retrieved. + * data?: string|array, // A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content use `data=` to retrieve content nested under the specified ``. By default returns no `data` content. * 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) @@ -1524,7 +1524,7 @@ public function getUserProfile(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-grant-api-key.html * * @param array{ - * refresh?: string, // If `true` (the default) 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` then do nothing with refreshes. + * refresh?: string, // If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes. (DEFAULT: false) * 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) @@ -1958,7 +1958,7 @@ public function putRoleMapping(?array $params = null) * * @param array{ * username: string, // (REQUIRED) The username of the User - * refresh?: string, // If `true` (the default) 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` then do nothing with refreshes. + * refresh?: string, // Valid values are `true`, `false`, and `wait_for`. These values have the same meaning as in the index API, but the default value for this API is true. (DEFAULT: true) * 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) @@ -1999,9 +1999,9 @@ public function putUser(?array $params = null) * @group serverless * * @param array{ - * with_limited_by?: bool, // flag to show the limited-by role descriptors of API Keys - * with_profile_uid?: bool, // flag to also retrieve the API Key's owner profile uid, if it exists - * typed_keys?: bool, // flag to prefix aggregation names by their respective types in the response + * with_limited_by?: bool, // Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it). An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges. + * with_profile_uid?: bool, // Determines whether to also retrieve the profile UID for the API key owner principal. If it exists, the profile UID is returned under the `profile_uid` response field for each API key. + * typed_keys?: bool, // Determines whether aggregation names are 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) * error_trace?: bool, // Include the stack trace of returned errors. (DEFAULT: false) @@ -2076,7 +2076,7 @@ public function queryRole(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-query-user.html * * @param array{ - * with_profile_uid?: bool, // flag to retrieve profile uid (if exists) associated with the user + * with_profile_uid?: bool, // Determines whether to retrieve the user profile UID, if it exists, for the users. * 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) @@ -2343,7 +2343,7 @@ public function samlServiceProviderMetadata(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-suggest-user-profile.html * * @param array{ - * data?: string|array, // A comma-separated list of keys for which the corresponding application data are retrieved. + * data?: string|array, // A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content, use `data=` to retrieve content nested under the specified ``. By default, the API returns no `data` content. It is an error to specify `data` as both the query parameter and the request body field. * 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) @@ -2462,8 +2462,8 @@ public function updateCrossClusterApiKey(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/security-api-update-settings.html * * @param array{ - * master_timeout?: int|string, // Timeout for connection to master - * timeout?: int|string, // Timeout for acknowledgements from all nodes + * master_timeout?: int|string, // The 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, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. * 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) @@ -2503,9 +2503,9 @@ public function updateSettings(?array $params = null) * * @param array{ * uid: string, // (REQUIRED) An unique identifier of the user profile - * if_seq_no?: int, // only perform the update operation if the last operation that has changed the document has the specified sequence number - * if_primary_term?: int, // only perform the update operation if the last operation that has changed the document has the specified primary term - * refresh?: string, // If `true` (the default) 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` then do nothing with refreshes. + * if_seq_no?: int, // Only perform the operation if the document has this sequence number. + * if_primary_term?: int, // Only perform the operation if the document has this primary term. + * refresh?: string, // If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', nothing is done with refreshes. (DEFAULT: false) * 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) diff --git a/src/Endpoints/Shutdown.php b/src/Endpoints/Shutdown.php index fc07a3d15..e6c1b4745 100644 --- a/src/Endpoints/Shutdown.php +++ b/src/Endpoints/Shutdown.php @@ -35,8 +35,8 @@ class Shutdown extends AbstractEndpoint * * @param array{ * node_id: string, // (REQUIRED) The node id of node to be removed from the shutdown state - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -76,7 +76,7 @@ public function deleteNode(?array $params = null) * * @param array{ * node_id?: string, // Which node for which to retrieve the shutdown status - * 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) @@ -118,8 +118,8 @@ public function getNode(?array $params = null) * * @param array{ * node_id: string, // (REQUIRED) The node id of node to be shut down - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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, // The 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) diff --git a/src/Endpoints/Simulate.php b/src/Endpoints/Simulate.php index b4eda7e35..b34f82212 100644 --- a/src/Endpoints/Simulate.php +++ b/src/Endpoints/Simulate.php @@ -36,7 +36,7 @@ class Simulate extends AbstractEndpoint * * @param array{ * index?: string, // Default index for docs which don't provide one - * pipeline?: string, // The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document + * pipeline?: string, // The pipeline to use as the default pipeline. This value can be used to override the default pipeline of the index. * 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) diff --git a/src/Endpoints/Slm.php b/src/Endpoints/Slm.php index 80d8e37ce..daa508f0c 100644 --- a/src/Endpoints/Slm.php +++ b/src/Endpoints/Slm.php @@ -35,8 +35,8 @@ class Slm extends AbstractEndpoint * * @param array{ * policy_id: string, // (REQUIRED) The id of the snapshot lifecycle policy to remove - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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, // The 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) @@ -75,8 +75,8 @@ public function deleteLifecycle(?array $params = null) * * @param array{ * policy_id: string, // (REQUIRED) The id of the snapshot lifecycle policy to be executed - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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, // The 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) @@ -114,8 +114,8 @@ public function executeLifecycle(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-execute-retention.html * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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, // The 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) @@ -152,8 +152,8 @@ public function executeRetention(?array $params = null) * * @param array{ * policy_id?: string|array, // Comma-separated list of snapshot lifecycle policies to retrieve - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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, // The 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) @@ -193,8 +193,8 @@ public function getLifecycle(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-get-stats.html * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * 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) @@ -230,8 +230,8 @@ public function getStats(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-get-status.html * * @param array{ - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (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) @@ -268,8 +268,8 @@ public function getStatus(?array $params = null) * * @param array{ * policy_id: string, // (REQUIRED) The id of the snapshot lifecycle policy - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The 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. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (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) @@ -309,8 +309,8 @@ public function putLifecycle(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-start.html * * @param array{ - * 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, // The 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. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (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) @@ -346,8 +346,8 @@ public function start(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/slm-api-stop.html * * @param array{ - * 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, // The 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. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (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) diff --git a/src/Endpoints/Snapshot.php b/src/Endpoints/Snapshot.php index d534f2bf1..e5b578b0b 100644 --- a/src/Endpoints/Snapshot.php +++ b/src/Endpoints/Snapshot.php @@ -35,8 +35,8 @@ class Snapshot extends AbstractEndpoint * * @param array{ * repository: string, // (REQUIRED) A repository name - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1` (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. (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) @@ -77,7 +77,7 @@ public function cleanupRepository(?array $params = null) * repository: string, // (REQUIRED) A repository name * snapshot: string, // (REQUIRED) The name of the snapshot to clone from * target_snapshot: string, // (REQUIRED) The name of the cloned snapshot to create - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (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) @@ -119,8 +119,8 @@ public function clone(?array $params = null) * @param array{ * repository: string, // (REQUIRED) A repository name * snapshot: string, // (REQUIRED) A snapshot name - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * wait_for_completion?: bool, // Should this request wait until the operation has completed before returning + * master_timeout?: int|string, // The 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) + * wait_for_completion?: bool, // If `true`, the request returns a response when the snapshot is complete. If `false`, the request returns a response when the snapshot initializes. * 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) @@ -161,9 +161,9 @@ public function create(?array $params = null) * * @param array{ * repository: string, // (REQUIRED) A repository name - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout - * verify?: bool, // Whether to verify the repository after creation + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * verify?: bool, // If `true`, the request verifies the repository is functional on all master and data nodes in the cluster. If `false`, this verification is skipped. You can also perform this verification with the verify snapshot repository API. (DEFAULT: 1) * 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) @@ -205,8 +205,8 @@ public function createRepository(?array $params = null) * @param array{ * repository: string, // (REQUIRED) A repository name * snapshot: string|array, // (REQUIRED) A comma-separated list of snapshot names - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * wait_for_completion?: bool, // Should this request wait until the operation has completed before returning + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * wait_for_completion?: bool, // If `true`, the request returns a response when the matching snapshots are all deleted. If `false`, the request returns a response as soon as the deletes are scheduled. (DEFAULT: 1) * 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) @@ -245,8 +245,8 @@ public function delete(?array $params = null) * * @param array{ * repository: string|array, // (REQUIRED) Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. (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) @@ -286,19 +286,19 @@ public function deleteRepository(?array $params = null) * @param array{ * repository: string, // (REQUIRED) A repository name * snapshot: string|array, // (REQUIRED) A comma-separated list of snapshot names - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * ignore_unavailable?: bool, // Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown - * index_names?: bool, // Whether to include the name of each index in the snapshot. Defaults to true. - * index_details?: bool, // Whether to include details of each index in the snapshot, if those details are available. Defaults to false. - * include_repository?: bool, // Whether to include the repository name in the snapshot info. Defaults to true. - * sort?: string, // Allows setting a sort order for the result. Defaults to start_time - * size?: int, // Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit. - * order?: string, // Sort order - * from_sort_value?: string, // Value of the current sort column at which to start retrieval. - * after?: string, // Offset identifier to start pagination from as returned by the 'next' field in the response body. - * offset?: int, // Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0 - * slm_policy_filter?: string, // Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy - * verbose?: bool, // Whether to show verbose snapshot info or only show the basic info found in the repository index blob + * master_timeout?: int|string, // The 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) + * ignore_unavailable?: bool, // If `false`, the request returns an error for any snapshots that are unavailable. + * index_names?: bool, // If `true`, the response includes the name of each index in each snapshot. (DEFAULT: 1) + * index_details?: bool, // If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. The default is `false`, meaning that this information is omitted. + * include_repository?: bool, // If `true`, the response includes the repository name in each snapshot. (DEFAULT: 1) + * sort?: string, // The sort order for the result. The default behavior is sorting by snapshot start time stamp. (DEFAULT: start_time) + * size?: int, // The maximum number of snapshots to return. The default is -1, which means to return all that match the request without limit. (DEFAULT: -1) + * order?: string, // The sort order. Valid values are `asc` for ascending and `desc` for descending order. The default behavior is ascending order. (DEFAULT: asc) + * from_sort_value?: string, // The value of the current sort column at which to start retrieval. It can be a string `snapshot-` or a repository name when sorting by snapshot or repository name. It can be a millisecond time value or a number when sorting by `index-` or shard count. + * after?: string, // An offset identifier to start pagination from as returned by the next field in the response body. + * offset?: int, // Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. + * slm_policy_filter?: string, // Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to. You can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`. For example, the pattern `*,-policy-a-\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`. Note that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy. + * verbose?: bool, // If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted. NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined. (DEFAULT: 1) * 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) @@ -337,8 +337,8 @@ public function get(?array $params = null) * * @param array{ * repository?: string|array, // A comma-separated list of repository names - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * local?: bool, // If `true`, the request gets information from the local node only. If `false`, the request gets information from the master node. * 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) @@ -379,18 +379,18 @@ public function getRepository(?array $params = null) * * @param array{ * repository: string, // (REQUIRED) A repository name - * blob_count?: int, // Number of blobs to create during the test. Defaults to 100. - * concurrency?: int, // Number of operations to run concurrently during the test. Defaults to 10. - * register_operation_count?: int, // The minimum number of linearizable register operations to perform in total. Defaults to 10. - * read_node_count?: int, // Number of nodes on which to read a blob after writing. Defaults to 10. - * early_read_node_count?: int, // Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2. - * seed?: int, // Seed for the random number generator used to create the test workload. Defaults to a random value. - * rare_action_probability?: float, // Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02. - * max_blob_size?: string, // Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'. - * max_total_data_size?: string, // Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'. - * timeout?: int|string, // Explicit operation timeout. Defaults to '30s'. - * detailed?: bool, // Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned. - * rarely_abort_writes?: bool, // Whether to rarely abort writes before they complete. Defaults to 'true'. + * blob_count?: int, // The total number of blobs to write to the repository during the test. For realistic experiments, you should set it to at least `2000`. (DEFAULT: 100) + * concurrency?: int, // The number of operations to run concurrently during the test. (DEFAULT: 10) + * register_operation_count?: int, // The minimum number of linearizable register operations to perform in total. For realistic experiments, you should set it to at least `100`. (DEFAULT: 10) + * read_node_count?: int, // The number of nodes on which to read a blob after writing. (DEFAULT: 10) + * early_read_node_count?: int, // The number of nodes on which to perform an early read operation while writing each blob. Early read operations are only rarely performed. (DEFAULT: 2) + * seed?: int, // The seed for the pseudo-random number generator used to generate the list of operations performed during the test. To repeat the same set of operations in multiple experiments, use the same seed in each experiment. Note that the operations are performed concurrently so might not always happen in the same order on each run. + * rare_action_probability?: float, // The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob. (DEFAULT: 0.02) + * max_blob_size?: string, // The maximum size of a blob to be written during the test. For realistic experiments, you should set it to at least `2gb`. (DEFAULT: 10mb) + * max_total_data_size?: string, // An upper limit on the total size of all the blobs written during the test. For realistic experiments, you should set it to at least `1tb`. (DEFAULT: 1gb) + * timeout?: int|string, // The period of time to wait for the test to complete. If no response is received before the timeout expires, the test is cancelled and returns an error. (DEFAULT: 30s) + * detailed?: bool, // Indicates whether to return detailed results, including timing information for every operation performed during the analysis. If false, it returns only a summary of the analysis. + * rarely_abort_writes?: bool, // Indicates whether to rarely cancel writes before they complete. (DEFAULT: 1) * 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) @@ -430,8 +430,8 @@ public function repositoryAnalyze(?array $params = null) * @param array{ * repository: string, // (REQUIRED) A repository name * snapshot: string, // (REQUIRED) A snapshot name - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * wait_for_completion?: bool, // Should this request wait until the operation has completed before returning + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * wait_for_completion?: bool, // If `true`, the request returns a response when the restore operation completes. The operation is complete when it finishes all attempts to recover primary shards for restored indices. This applies even if one or more of the recovery attempts fail. If `false`, the request returns a response when the restore operation initializes. * 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) @@ -473,8 +473,8 @@ public function restore(?array $params = null) * @param array{ * repository?: string, // A repository name * snapshot?: string|array, // A comma-separated list of snapshot names - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * ignore_unavailable?: bool, // Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * ignore_unavailable?: bool, // If `false`, the request returns an error for any snapshots that are unavailable. If `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. * 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) @@ -518,8 +518,8 @@ public function status(?array $params = null) * * @param array{ * repository: string, // (REQUIRED) A repository name - * master_timeout?: int|string, // Explicit operation timeout for connection to master node - * timeout?: int|string, // Explicit operation timeout + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (DEFAULT: 30s) + * timeout?: int|string, // The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. (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) diff --git a/src/Endpoints/Sql.php b/src/Endpoints/Sql.php index 70f0e2131..13eed3371 100644 --- a/src/Endpoints/Sql.php +++ b/src/Endpoints/Sql.php @@ -114,10 +114,10 @@ public function deleteAsync(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The async search ID - * delimiter?: string, // Separator for CSV results - * format?: string, // Short version of the Accept header, e.g. json, yaml - * keep_alive?: int|string, // Retention period for the search and its results - * wait_for_completion_timeout?: int|string, // Duration to wait for complete results + * delimiter?: string, // The separator for CSV results. The API supports this parameter only for CSV responses. (DEFAULT: ,) + * format?: string, // The format for the response. You must specify a format using this parameter or the `Accept` HTTP header. If you specify both, the API uses this parameter. + * keep_alive?: int|string, // The retention period for the search and its results. It defaults to the `keep_alive` period for the original SQL search. (DEFAULT: 5d) + * wait_for_completion_timeout?: int|string, // The period to wait for complete results. It defaults to no timeout, meaning the request waits for complete search results. * 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) @@ -195,7 +195,7 @@ public function getAsyncStatus(?array $params = null) * @group serverless * * @param array{ - * format?: string, // a short version of the Accept header, e.g. json, yaml + * format?: string, // The format for the response. You can also specify a format using the `Accept` HTTP header. If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence. * 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) diff --git a/src/Endpoints/Synonyms.php b/src/Endpoints/Synonyms.php index 9e151305f..433845885 100644 --- a/src/Endpoints/Synonyms.php +++ b/src/Endpoints/Synonyms.php @@ -116,8 +116,8 @@ public function deleteSynonymRule(?array $params = null) * * @param array{ * id: string, // (REQUIRED) The name of the synonyms set to be retrieved - * from?: int, // Starting offset - * size?: int, // specifies a max number of results to get + * from?: int, // The starting offset for query rules to retrieve. + * size?: int, // The max number of query rules to retrieve. (DEFAULT: 10) * 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) @@ -197,8 +197,8 @@ public function getSynonymRule(?array $params = null) * @group serverless * * @param array{ - * from?: int, // Starting offset - * size?: int, // specifies a max number of results to get + * from?: int, // The starting offset for synonyms sets to retrieve. + * size?: int, // The maximum number of synonyms sets to retrieve. (DEFAULT: 10) * 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) diff --git a/src/Endpoints/Tasks.php b/src/Endpoints/Tasks.php index 215f042aa..0576d14ef 100644 --- a/src/Endpoints/Tasks.php +++ b/src/Endpoints/Tasks.php @@ -36,10 +36,10 @@ class Tasks extends AbstractEndpoint * * @param array{ * task_id?: string, // Cancel the task with specified task id (node_id:task_number) - * nodes?: string|array, // 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 - * actions?: string|array, // A comma-separated list of actions that should be cancelled. Leave empty to cancel all. - * parent_task_id?: string, // Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. - * wait_for_completion?: bool, // Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + * nodes?: string|array, // A comma-separated list of node IDs or names that is used to limit the request. + * actions?: string|array, // A comma-separated list or wildcard expression of actions that is used to limit the request. + * parent_task_id?: string, // A parent task ID that is used to limit the tasks. + * wait_for_completion?: bool, // If true, the request blocks until all found tasks are complete. * 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) @@ -82,8 +82,8 @@ public function cancel(?array $params = null) * * @param array{ * task_id: string, // (REQUIRED) Return the task with specified id (node_id:task_number) - * wait_for_completion?: bool, // Wait for the matching tasks to complete (default: false) - * timeout?: int|string, // Explicit operation timeout + * wait_for_completion?: bool, // If `true`, the request blocks until the task has completed. + * timeout?: int|string, // The 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) @@ -122,13 +122,13 @@ public function get(?array $params = null) * @internal This API is EXPERIMENTAL and may be changed or removed completely in a future release * * @param array{ - * nodes?: string|array, // 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 - * actions?: string|array, // A comma-separated list of actions that should be returned. Leave empty to return all. - * detailed?: bool, // Return detailed task information (default: false) - * parent_task_id?: string, // Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. - * wait_for_completion?: bool, // Wait for the matching tasks to complete (default: false) - * group_by?: string, // Group tasks by nodes or parent/child relationships - * timeout?: int|string, // Explicit operation timeout + * nodes?: string|array, // A comma-separated list of node IDs or names that is used to limit the returned information. + * actions?: string|array, // A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use `cluser:*` to retrieve all cluster-related tasks. + * detailed?: bool, // If `true`, the response includes detailed information about the running tasks. This information is useful to distinguish tasks from each other but is more costly to run. + * parent_task_id?: string, // A parent task identifier that is used to limit returned information. To return all tasks, omit this parameter or use a value of `-1`. If the parent task is not found, the API does not return a 404 response code. + * wait_for_completion?: bool, // If `true`, the request blocks until the operation is complete. + * group_by?: string, // A key that is used to group tasks in the response. The task lists can be grouped either by nodes or by parent tasks. (DEFAULT: nodes) + * timeout?: int|string, // The period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its information. However, timed out nodes are included in the `node_failures` property. (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) diff --git a/src/Endpoints/TextStructure.php b/src/Endpoints/TextStructure.php index 39c43acd1..8f3c712dd 100644 --- a/src/Endpoints/TextStructure.php +++ b/src/Endpoints/TextStructure.php @@ -34,20 +34,20 @@ class TextStructure extends AbstractEndpoint * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-field-structure.html * * @param array{ - * index?: string, // The index containing the analyzed field - * field?: string, // The field that should be analyzed - * documents_to_sample?: int, // How many documents should be included in the analysis - * timeout?: int|string, // Timeout after which the analysis will be aborted - * format?: string, // Optional parameter to specify the high level file format - * column_names?: string|array, // Optional parameter containing a comma separated list of the column names for a delimited file - * delimiter?: string, // Optional parameter to specify the delimiter character for a delimited file - must be a single character - * quote?: string, // Optional parameter to specify the quote character for a delimited file - must be a single character - * should_trim_fields?: bool, // Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them - * grok_pattern?: string, // Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file - * ecs_compatibility?: string, // The mode of compatibility with ECS compliant Grok patterns.Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output.The intention in that situation is that a user who knows the meanings will rename the fields before using them. - * timestamp_field?: string, // Optional parameter to specify the timestamp field in the file - * timestamp_format?: string, // Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format - * explain?: bool, // Whether to include a commentary on how the structure was derived + * index?: string, // The name of the index that contains the analyzed field. + * field?: string, // The field that should be analyzed. + * documents_to_sample?: int, // The number of documents to include in the structural analysis. The minimum value is 2. (DEFAULT: 1000) + * timeout?: int|string, // The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires, it will be stopped. (DEFAULT: 25s) + * format?: string, // The high level structure of the text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + * column_names?: string|array, // If `format` is set to `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header row, columns are named "column1", "column2", "column3", for example. + * delimiter?: string, // If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + * quote?: string, // If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (`"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + * should_trim_fields?: bool, // If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. Otherwise, the default value is `false`. + * grok_pattern?: string, // If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern. + * ecs_compatibility?: string, // The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output. The intention in that situation is that a user who knows the meanings will rename the fields before using them. (DEFAULT: disabled) + * timestamp_field?: string, // The name of the field that contains the primary timestamp of each record in the text. In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text. + * timestamp_format?: string, // The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz` Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + * explain?: bool, // If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. * 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) @@ -84,17 +84,17 @@ public function findFieldStructure(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-message-structure.html * * @param array{ - * timeout?: int|string, // Timeout after which the analysis will be aborted - * format?: string, // Optional parameter to specify the high level file format - * column_names?: string|array, // Optional parameter containing a comma separated list of the column names for a delimited file - * delimiter?: string, // Optional parameter to specify the delimiter character for a delimited file - must be a single character - * quote?: string, // Optional parameter to specify the quote character for a delimited file - must be a single character - * should_trim_fields?: bool, // Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them - * grok_pattern?: string, // Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file - * ecs_compatibility?: string, // The mode of compatibility with ECS compliant Grok patterns.Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. - * timestamp_field?: string, // Optional parameter to specify the timestamp field in the file - * timestamp_format?: string, // Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format - * explain?: bool, // Whether to include a commentary on how the structure was derived + * timeout?: int|string, // The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires, it will be stopped. (DEFAULT: 25s) + * format?: string, // The high level structure of the text. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + * column_names?: string|array, // If the format is `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example. + * delimiter?: string, // If you the format is `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + * quote?: string, // If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (`"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + * should_trim_fields?: bool, // If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. Otherwise, the default value is `false`. + * grok_pattern?: string, // If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern. + * ecs_compatibility?: string, // The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. (DEFAULT: disabled) + * timestamp_field?: string, // The name of the field that contains the primary timestamp of each record in the text. In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text. + * timestamp_format?: string, // The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz` Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + * explain?: bool, // If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. * 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) @@ -133,21 +133,21 @@ public function findMessageStructure(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/find-structure.html * * @param array{ - * lines_to_sample?: int, // How many lines of the file should be included in the analysis - * line_merge_size_limit?: int, // Maximum number of characters permitted in a single message when lines are merged to create messages. - * timeout?: int|string, // Timeout after which the analysis will be aborted - * charset?: string, // Optional parameter to specify the character set of the file - * format?: string, // Optional parameter to specify the high level file format - * has_header_row?: bool, // Optional parameter to specify whether a delimited file includes the column names in its first row - * column_names?: string|array, // Optional parameter containing a comma separated list of the column names for a delimited file - * delimiter?: string, // Optional parameter to specify the delimiter character for a delimited file - must be a single character - * quote?: string, // Optional parameter to specify the quote character for a delimited file - must be a single character - * should_trim_fields?: bool, // Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them - * grok_pattern?: string, // Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file - * ecs_compatibility?: string, // Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' - * timestamp_field?: string, // Optional parameter to specify the timestamp field in the file - * timestamp_format?: string, // Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format - * explain?: bool, // Whether to include a commentary on how the structure was derived + * lines_to_sample?: int, // The number of lines to include in the structural analysis, starting from the beginning of the text. The minimum is 2. If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines. NOTE: The number of lines and the variation of the lines affects the speed of the analysis. For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample. If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety. (DEFAULT: 1000) + * line_merge_size_limit?: int, // The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected. (DEFAULT: 10000) + * timeout?: int|string, // The maximum amount of time that the structure analysis can take. If the analysis is still running when the timeout expires then it will be stopped. (DEFAULT: 25s) + * charset?: string, // The text's character set. It must be a character set that is supported by the JVM that Elasticsearch uses. For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`. If this parameter is not specified, the structure finder chooses an appropriate character set. + * format?: string, // The high level structure of the text. Valid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`. By default, the API chooses the format. In this default scenario, all rows must have the same number of fields for a delimited format to be detected. If the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + * has_header_row?: bool, // If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text. If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows. + * column_names?: string|array, // If you have set format to `delimited`, you can specify the column names in a comma-separated list. If this parameter is not specified, the structure finder uses the column names from the header row of the text. If the text does not have a header role, columns are named "column1", "column2", "column3", for example. + * delimiter?: string, // If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. Only a single character is supported; the delimiter cannot have multiple characters. By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). In this default scenario, all rows must have the same number of fields for the delimited format to be detected. If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + * quote?: string, // If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. Only a single character is supported. If this parameter is not specified, the default value is a double quote (`"`). If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + * should_trim_fields?: bool, // If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. If this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`. Otherwise, the default value is `false`. + * grok_pattern?: string, // If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". If `grok_pattern` is not specified, the structure finder creates a Grok pattern. + * ecs_compatibility?: string, // The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are `disabled` and `v1`. This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. (DEFAULT: disabled) + * timestamp_field?: string, // The name of the field that contains the primary timestamp of each record in the text. In particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field. If the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified. For structured text, if you specify this parameter, the field must exist within the text. If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. For structured text, it is not compulsory to have a timestamp in the text. + * timestamp_format?: string, // The Java time format of the timestamp field in the text. Only a subset of Java time format letter groups are supported: * `a` * `d` * `dd` * `EEE` * `EEEE` * `H` * `HH` * `h` * `M` * `MM` * `MMM` * `MMMM` * `mm` * `ss` * `XX` * `XXX` * `yy` * `yyyy` * `zzz` Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`. Spacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes. For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format. One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. Another is when the timestamp format is one that the structure finder does not consider by default. If this parameter is not specified, the structure finder chooses the best format from a built-in set. If the special value `null` is specified the structure finder will not look for a primary timestamp in the text. When the format is semi-structured text this will result in the structure finder treating the text as single-line messages. + * explain?: bool, // If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen. * 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) @@ -186,7 +186,7 @@ public function findStructure(?array $params = null) * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/test-grok-pattern.html * * @param array{ - * ecs_compatibility?: string, // Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' + * ecs_compatibility?: string, // The mode of compatibility with ECS compliant Grok patterns. Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. Valid values are `disabled` and `v1`. (DEFAULT: disabled) * 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) diff --git a/src/Endpoints/Transform.php b/src/Endpoints/Transform.php index c005678f0..bd44a4029 100644 --- a/src/Endpoints/Transform.php +++ b/src/Endpoints/Transform.php @@ -36,9 +36,9 @@ class Transform extends AbstractEndpoint * * @param array{ * transform_id: string, // (REQUIRED) The id of the transform to delete - * force?: bool, // When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted. - * delete_dest_index?: bool, // When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted. - * timeout?: int|string, // Controls the time to wait for the transform deletion + * force?: bool, // If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state. + * delete_dest_index?: bool, // If this value is true, the destination index is deleted together with the transform. If false, the destination index will not be deleted + * 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) @@ -114,10 +114,10 @@ public function getNodeStats(?array $params = null) * * @param array{ * transform_id?: string, // The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms - * from?: int, // skips a number of transform configs, defaults to 0 - * size?: int, // specifies a max number of transforms to get, defaults to 100 - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) - * exclude_generated?: bool, // Omits fields that are illegal to set on transform PUT + * from?: int, // Skips the specified number of transforms. + * size?: int, // Specifies the maximum number of transforms to obtain. (DEFAULT: 100) + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * exclude_generated?: bool, // Excludes fields that were automatically added when creating the transform. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster. * 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) @@ -159,10 +159,10 @@ public function getTransform(?array $params = null) * * @param array{ * transform_id: string, // (REQUIRED) The id of the transform for which to get stats. '_all' or '*' implies all transforms - * from?: int, // skips a number of transform stats, defaults to 0 - * size?: int, // specifies a max number of transform stats to get, defaults to 100 - * timeout?: int|string, // Controls the time to wait for the stats - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) + * from?: int, // Skips the specified number of transforms. + * size?: int, // Specifies the maximum number of transforms to obtain. (DEFAULT: 100) + * timeout?: int|string, // Controls the time to wait for the stats (DEFAULT: 30s) + * allow_no_match?: bool, // Specifies what to do when the request: 1. Contains wildcard expressions and there are no transforms that match. 2. Contains the _all string or no identifiers and there are no matches. 3. Contains wildcard expressions and there are only partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) * 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) @@ -202,7 +202,7 @@ public function getTransformStats(?array $params = null) * * @param array{ * transform_id?: string, // The id of the transform to preview. - * timeout?: int|string, // Controls the time to wait for the preview + * 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) @@ -246,8 +246,8 @@ public function previewTransform(?array $params = null) * * @param array{ * transform_id: string, // (REQUIRED) The id of the new transform. - * defer_validation?: bool, // If validations should be deferred until transform starts, defaults to false. - * timeout?: int|string, // Controls the time to wait for the transform to start + * defer_validation?: bool, // When the transform is created, a series of validations occur to ensure its success. For example, there is a check for the existence of the source indices and a check that the destination index is not part of the source index pattern. You can use this parameter to skip the checks, for example when the source index does not exist until after the transform is created. The validations are always run when you start the transform, however, with the exception of privilege checks. + * 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) @@ -289,8 +289,8 @@ public function putTransform(?array $params = null) * * @param array{ * transform_id: string, // (REQUIRED) The id of the transform to reset - * force?: bool, // When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset. - * timeout?: int|string, // Controls the time to wait for the transform to reset + * force?: bool, // If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform must be stopped before it can be reset. + * 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) @@ -330,7 +330,7 @@ public function resetTransform(?array $params = null) * * @param array{ * transform_id: string, // (REQUIRED) The id of the transform. - * timeout?: int|string, // Controls the time to wait for the scheduling to take place + * timeout?: int|string, // Controls the time to wait for the scheduling to take place (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) @@ -369,8 +369,8 @@ public function scheduleNowTransform(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode * * @param array{ - * enabled?: bool, // Whether to enable upgrade_mode Transform setting or not. Defaults to false. - * timeout?: int|string, // Controls the time to wait before action times out. Defaults to 30 seconds + * enabled?: bool, // When `true`, it enables `upgrade_mode` which temporarily halts all transform tasks and prohibits new transform tasks from starting. + * timeout?: int|string, // The time to wait for the request to be completed. (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) @@ -408,8 +408,8 @@ public function setUpgradeMode(?array $params = null) * * @param array{ * transform_id: string, // (REQUIRED) The id of the transform to start - * from?: string, // Restricts the set of transformed entities to those changed after this time - * timeout?: int|string, // Controls the time to wait for the transform to start + * from?: string, // Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + * 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) @@ -449,11 +449,11 @@ public function startTransform(?array $params = null) * * @param array{ * transform_id: string, // (REQUIRED) The id of the transform to stop - * force?: bool, // Whether to force stop a failed transform or not. Default to false - * wait_for_completion?: bool, // Whether to wait for the transform to fully stop before returning or not. Default to false - * timeout?: int|string, // Controls the time to wait until the transform has stopped. Default to 30 seconds - * allow_no_match?: bool, // Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) - * wait_for_checkpoint?: bool, // Whether to wait for the transform to reach a checkpoint before stopping. Default to false + * force?: bool, // If it is true, the API forcefully stops the transforms. + * wait_for_completion?: bool, // If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns immediately and the indexer is stopped asynchronously in the background. + * timeout?: int|string, // Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the timeout expires, the request returns a timeout exception. However, the request continues processing and eventually moves the transform to a STOPPED state. (DEFAULT: 30s) + * allow_no_match?: bool, // Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. If it is true, the API returns a successful acknowledgement message when there are no matches. When there are only partial matches, the API stops the appropriate transforms. If it is false, the request returns a 404 status code when there are no matches or only partial matches. (DEFAULT: 1) + * wait_for_checkpoint?: bool, // If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, the transform stops as soon as possible. * 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) @@ -493,8 +493,8 @@ public function stopTransform(?array $params = null) * * @param array{ * transform_id: string, // (REQUIRED) The id of the transform. - * defer_validation?: bool, // If validations should be deferred until transform starts, defaults to false. - * timeout?: int|string, // Controls the time to wait for the update + * defer_validation?: bool, // When true, deferrable validations are not run. This behavior may be desired if the source index does not exist until after the transform is created. + * 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) @@ -534,8 +534,8 @@ public function updateTransform(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-transform-upgrade-transforms * * @param array{ - * dry_run?: bool, // Whether to only check for updates but don't execute - * timeout?: int|string, // Controls the time to wait for the upgrade + * dry_run?: bool, // When true, the request checks for updates but does not run them. + * 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) diff --git a/src/Endpoints/Watcher.php b/src/Endpoints/Watcher.php index 77fb5c706..aac6a9a98 100644 --- a/src/Endpoints/Watcher.php +++ b/src/Endpoints/Watcher.php @@ -192,7 +192,7 @@ public function deleteWatch(?array $params = null) * * @param array{ * id?: string, // Watch ID - * debug?: bool, // indicates whether the watch should execute in debug mode + * debug?: bool, // Defines whether the watch runs in debug mode. * 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) @@ -234,7 +234,7 @@ public function executeWatch(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-get-settings * * @param array{ - * master_timeout?: int|string, // Specify timeout for connection to master + * master_timeout?: int|string, // The 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) @@ -310,10 +310,10 @@ public function getWatch(?array $params = null) * * @param array{ * id: string, // (REQUIRED) Watch ID - * active?: bool, // Specify whether the watch is in/active by default + * active?: bool, // The initial state of the watch. The default value is `true`, which means the watch is active by default. (DEFAULT: 1) * version?: int, // Explicit version number for concurrency control - * if_seq_no?: int, // only update the watch if the last operation that has changed the watch has the specified sequence number - * if_primary_term?: int, // only update the watch if the last operation that has changed the watch has the specified primary term + * if_seq_no?: int, // Only update the watch if the last operation that has changed the watch has the specified sequence number + * if_primary_term?: int, // Only update the watch if the last operation that has changed the watch has the specified primary term * 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) @@ -390,7 +390,7 @@ public function queryWatches(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-start * * @param array{ - * master_timeout?: int|string, // Specify timeout for connection to master + * master_timeout?: int|string, // Period to wait for a connection to the master node. (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) @@ -427,7 +427,7 @@ public function start(?array $params = null) * * @param array{ * metric?: string|array, // Controls what additional stat metrics should be include in the response - * emit_stacktraces?: bool, // Emits stack traces of currently running watches + * emit_stacktraces?: bool, // Defines whether stack traces are generated for each watch that is running. * 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) @@ -467,7 +467,7 @@ public function stats(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-stop * * @param array{ - * master_timeout?: int|string, // Specify timeout for connection to master + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. (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) @@ -503,8 +503,8 @@ public function stop(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/operation/operation-watcher-update-settings * * @param array{ - * timeout?: int|string, // Specify timeout for waiting for acknowledgement from all nodes - * master_timeout?: int|string, // Specify timeout for connection to master + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. + * master_timeout?: int|string, // The 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) diff --git a/src/Endpoints/Xpack.php b/src/Endpoints/Xpack.php index f6cf07bd6..deea536a5 100644 --- a/src/Endpoints/Xpack.php +++ b/src/Endpoints/Xpack.php @@ -34,9 +34,9 @@ class Xpack extends AbstractEndpoint * @link https://www.elastic.co/guide/en/elasticsearch/reference/8.19/info-api.html * * @param array{ - * human?: bool, // Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true. - * categories?: string|array, // Comma-separated list of info categories. Can be any of: build, license, features - * accept_enterprise?: bool, // If this param is used it must be set to true + * human?: bool, // Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. (DEFAULT: 1) + * categories?: string|array, // A comma-separated list of the information categories to include in the response. For example, `build,license,features`. + * accept_enterprise?: bool, // If used, this otherwise ignored parameter must be set to true * 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) @@ -72,7 +72,7 @@ public function info(?array $params = null) * @link https://www.elastic.co/docs/api/doc/elasticsearch/v8/group/endpoint-xpack * * @param array{ - * master_timeout?: int|string, // Specify timeout for watch write operation + * master_timeout?: int|string, // The 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. To indicate that the request should never timeout, set it to `-1`. (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) diff --git a/src/Traits/ClientEndpointsTrait.php b/src/Traits/ClientEndpointsTrait.php index ec527f377..54a9134cf 100644 --- a/src/Traits/ClientEndpointsTrait.php +++ b/src/Traits/ClientEndpointsTrait.php @@ -36,18 +36,18 @@ trait ClientEndpointsTrait * * @param array{ * index?: string, // Default index for items which don't provide one - * 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) - * refresh?: string, // 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. - * routing?: string|array, // Specific routing value - * timeout?: int|string, // Explicit operation timeout - * _source?: string|array, // True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request - * _source_excludes?: string|array, // Default list of fields to exclude from the returned _source field, can be overridden on each sub-request - * _source_includes?: string|array, // Default list of fields to extract and return from the _source field, can be overridden on each sub-request - * pipeline?: string, // The pipeline id to preprocess incoming documents with - * require_alias?: bool, // If true, the request's actions must target an index alias. Defaults to false. - * require_data_stream?: bool, // If true, the request's actions must target a data stream (existing or to-be-created). Default to false - * list_executed_pipelines?: bool, // Sets list_executed_pipelines for all incoming documents. Defaults to unset (false) - * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default is `1`, which waits for each primary shard to be active. (DEFAULT: 1) + * refresh?: string, // If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, wait for a refresh to make this operation visible to search. If `false`, do nothing with refreshes. Valid values: `true`, `false`, `wait_for`. (DEFAULT: false) + * routing?: string|array, // A custom value that is used to route operations to a specific shard. + * timeout?: int|string, // The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. (DEFAULT: 1m) + * _source?: string|array, // Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return. + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * pipeline?: string, // The pipeline identifier to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter. + * require_alias?: bool, // If `true`, the request's actions must target an index alias. + * require_data_stream?: bool, // If `true`, the request's actions must target a data stream (existing or to be created). + * list_executed_pipelines?: bool, // If `true`, the response will include the ingest pipelines that were run for each index or create. + * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. (DEFAULT: 1) * 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) @@ -174,20 +174,20 @@ public function closePointInTime(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of indices to restrict the results - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * min_score?: float, // Include only documents with a specific `_score` value in the result - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * routing?: string|array, // A comma-separated list of specific routing values - * q?: string, // Query in the Lucene query string syntax - * analyzer?: string, // The analyzer to use for the query string - * analyze_wildcard?: bool, // Specify whether wildcard and prefix queries should be analyzed (default: false) - * default_operator?: string, // The default operator for query string query (AND or OR) - * df?: string, // The field to use as default where no field prefix is given in the query string - * lenient?: bool, // Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - * terminate_after?: int, // The maximum count for each shard, upon reaching which the query execution will terminate early + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * ignore_throttled?: bool, // If `true`, concrete, expanded, or aliased indices are ignored when frozen. (DEFAULT: 1) + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * min_score?: float, // The minimum `_score` value that documents must have to be included in the result. + * preference?: string, // The node or shard the operation should be performed on. By default, it is random. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * q?: string, // The query in Lucene query string syntax. This parameter cannot be used with a request body. + * analyzer?: string, // The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. + * analyze_wildcard?: bool, // If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. + * default_operator?: string, // The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified. (DEFAULT: or) + * df?: string, // The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. + * lenient?: bool, // If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. + * terminate_after?: int, // The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. * 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) @@ -232,16 +232,16 @@ public function count(?array $params = null) * @param array{ * id: string, // (REQUIRED) Document ID * index: string, // (REQUIRED) The name of the index - * 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) - * refresh?: string, // 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. - * routing?: string|array, // Specific routing value - * timeout?: int|string, // Explicit operation timeout - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type - * pipeline?: string, // The pipeline id to preprocess incoming documents with - * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. Defaults to true. - * require_alias?: bool, // When true, requires destination to be an alias. Default is false - * require_data_stream?: bool, // When true, requires destination to be a data stream (existing or to be created). Default is false + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. (DEFAULT: 1) + * refresh?: string, // If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. (DEFAULT: false) + * routing?: string|array, // A custom value that is used to route operations to a specific shard. + * timeout?: int|string, // The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. Elasticsearch waits for at least the specified timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur. (DEFAULT: 1m) + * version?: int, // The explicit version number for concurrency control. It must be a non-negative long number. + * version_type?: string, // The version type. + * pipeline?: string, // The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. If a final pipeline is configured, it will always run regardless of the value of this parameter. + * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. (DEFAULT: 1) + * require_alias?: bool, // If `true`, the destination must be an index alias. + * require_data_stream?: bool, // If `true`, the request's actions must target a data stream (existing or to be created). * 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) @@ -284,14 +284,14 @@ public function create(?array $params = null) * @param array{ * id: string, // (REQUIRED) The document ID * index: string, // (REQUIRED) The name of the index - * 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) - * refresh?: string, // 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. - * routing?: string|array, // Specific routing value - * timeout?: int|string, // Explicit operation timeout - * if_seq_no?: int, // only perform the delete operation if the last operation that has changed the document has the specified sequence number - * if_primary_term?: int, // only perform the delete operation if the last operation that has changed the document has the specified primary term - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type + * wait_for_active_shards?: string, // The minimum number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. (DEFAULT: 1) + * refresh?: string, // If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. (DEFAULT: false) + * routing?: string|array, // A custom value used to route operations to a specific shard. + * timeout?: int|string, // The period to wait for active shards. This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs. Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation. By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error. (DEFAULT: 1m) + * if_seq_no?: int, // Only perform the operation if the document has this sequence number. + * if_primary_term?: int, // Only perform the operation if the document has this primary term. + * version?: int, // An explicit version number for concurrency control. It must match the current version of the document for the request to succeed. + * version_type?: string, // The version type. * 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) @@ -331,35 +331,35 @@ public function delete(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * analyzer?: string, // The analyzer to use for the query string - * analyze_wildcard?: bool, // Specify whether wildcard and prefix queries should be analyzed (default: false) - * default_operator?: string, // The default operator for query string query (AND or OR) - * df?: string, // The field to use as default where no field prefix is given in the query string - * from?: int, // Starting offset (default: 0) - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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) - * conflicts?: string, // What to do when the delete by query hits version conflicts? - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * 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) - * q?: string, // Query in the Lucene query string syntax - * routing?: string|array, // A comma-separated list of specific routing values - * scroll?: int|string, // Specify how long a consistent view of the index should be maintained for scrolled search - * search_type?: string, // Search operation type - * search_timeout?: int|string, // Explicit timeout for each search request. Defaults to no timeout. - * max_docs?: int, // Maximum number of documents to process (default: all documents) - * sort?: string|array, // A comma-separated list of : pairs - * 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, // Specific 'tag' of the request for logging and statistical purposes - * version?: bool, // Specify whether to return document version as part of a hit - * request_cache?: bool, // Specify if request cache should be used for this request or not, defaults to index level setting - * refresh?: bool, // Should the affected indexes be refreshed? - * timeout?: int|string, // Time each individual bulk request should wait for shards that are unavailable. - * 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) - * scroll_size?: int, // Size on the scroll request powering the delete by query - * wait_for_completion?: bool, // Should the request should block until the delete by query is complete. - * requests_per_second?: int, // The throttle for this request in sub-requests per second. -1 means no throttle. - * slices?: int|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`. + * analyzer?: string, // Analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. + * analyze_wildcard?: bool, // If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. + * default_operator?: string, // The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified. (DEFAULT: or) + * df?: string, // The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. + * from?: int, // Skips the specified number of documents. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * conflicts?: string, // What to do if delete by query hits version conflicts: `abort` or `proceed`. (DEFAULT: abort) + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * lenient?: bool, // If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. + * preference?: string, // The node or shard the operation should be performed on. It is random by default. + * q?: string, // A query in the Lucene query string syntax. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * scroll?: int|string, // The period to retain the search context for scrolling. + * search_type?: string, // The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`. + * search_timeout?: int|string, // The explicit timeout for each search request. It defaults to no timeout. + * max_docs?: int, // The maximum number of documents to process. Defaults to all documents. When set to a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. + * sort?: string|array, // A comma-separated list of `:` pairs. + * terminate_after?: int, // The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + * stats?: string|array, // The specific `tag` of the request for logging and statistical purposes. + * version?: bool, // If `true`, returns the document version as part of a hit. + * request_cache?: bool, // If `true`, the request cache is used for this request. Defaults to the index-level setting. + * refresh?: bool, // If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed. Unlike the delete API, it does not support `wait_for`. + * timeout?: int|string, // The period each deletion request waits for active shards. (DEFAULT: 1m) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` value controls how long each write request waits for unavailable shards to become available. (DEFAULT: 1) + * scroll_size?: int, // The size of the scroll request that powers the operation. (DEFAULT: 1000) + * wait_for_completion?: bool, // If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. (DEFAULT: 1) + * requests_per_second?: int, // The throttle for this request in sub-requests per second. (DEFAULT: -1) + * slices?: int|string, // The number of slices this task should be divided into. (DEFAULT: 1) * 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) @@ -400,7 +400,7 @@ public function deleteByQuery(?array $params = null) * * @param array{ * task_id: string, // (REQUIRED) The task id to rethrottle - * requests_per_second?: int, // The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. + * requests_per_second?: int, // The throttle for this request in sub-requests per second. To disable throttling, set it to `-1`. * 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) @@ -440,8 +440,8 @@ public function deleteByQueryRethrottle(?array $params = null) * * @param array{ * id: string, // (REQUIRED) Script ID - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (DEFAULT: 30s) + * master_timeout?: int|string, // The 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. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -482,16 +482,16 @@ public function deleteScript(?array $params = null) * @param array{ * id: string, // (REQUIRED) The document ID * index: string, // (REQUIRED) The name of the index - * stored_fields?: string|array, // A comma-separated list of stored fields to return in the response - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * realtime?: bool, // Specify whether to perform the operation in realtime or search mode - * refresh?: bool, // Refresh the shard containing the document before performing the operation - * routing?: string|array, // Specific routing value - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // A list of fields to extract and return from the _source field - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type + * stored_fields?: string|array, // A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. + * preference?: string, // The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name. + * realtime?: bool, // If `true`, the request is real-time as opposed to near-real-time. (DEFAULT: 1) + * refresh?: bool, // If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + * routing?: string|array, // A custom value used to route operations to a specific shard. + * _source?: string|array, // Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * version?: int, // Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed. + * version_type?: string, // The version type. * 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) @@ -532,15 +532,15 @@ public function exists(?array $params = null) * @param array{ * id: string, // (REQUIRED) The document ID * index: string, // (REQUIRED) The name of the index - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * realtime?: bool, // Specify whether to perform the operation in realtime or search mode - * refresh?: bool, // Refresh the shard containing the document before performing the operation - * routing?: string|array, // Specific routing value - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // A list of fields to extract and return from the _source field - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type + * preference?: string, // The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. + * realtime?: bool, // If `true`, the request is real-time as opposed to near-real-time. (DEFAULT: 1) + * refresh?: bool, // If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + * routing?: string|array, // A custom value used to route operations to a specific shard. + * _source?: string|array, // Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude in the response. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. + * version?: int, // The version number for concurrency control. It must match the current version of the document for the request to succeed. + * version_type?: string, // The version type. * 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) @@ -581,18 +581,18 @@ public function existsSource(?array $params = null) * @param array{ * id: string, // (REQUIRED) The document ID * index: string, // (REQUIRED) The name of the index - * analyze_wildcard?: bool, // Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) - * analyzer?: string, // The analyzer for the query string query - * default_operator?: string, // The default operator for query string query (AND or OR) - * df?: string, // The default field for query string query (default: _all) - * stored_fields?: string|array, // A comma-separated list of stored fields to return in the response - * 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) - * q?: string, // Query in the Lucene query string syntax - * routing?: string|array, // Specific routing value - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // A list of fields to extract and return from the _source field + * analyze_wildcard?: bool, // If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. + * analyzer?: string, // The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. + * default_operator?: string, // The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified. (DEFAULT: or) + * df?: string, // The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. + * stored_fields?: string|array, // A comma-separated list of stored fields to return in the response. + * lenient?: bool, // If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. + * preference?: string, // The node or shard the operation should be performed on. It is random by default. + * q?: string, // The query in the Lucene query string syntax. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * _source?: string|array, // `True` or `false` to return the `_source` field or not or a list of fields to return. + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. * 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) @@ -634,14 +634,14 @@ public function explain(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - * fields?: string|array, // A comma-separated list of field names - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * include_unmapped?: bool, // Indicates whether unmapped fields should be included in the response. - * filters?: string|array, // An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent - * types?: string|array, // Only return results for fields that have one of the types in the list - * include_empty_fields?: bool, // Include empty fields in result + * fields?: string|array, // A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + * ignore_unavailable?: bool, // If `true`, missing or closed indices are not included in the response. + * allow_no_indices?: bool, // If false, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with bar. (DEFAULT: 1) + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * include_unmapped?: bool, // If true, unmapped fields are included in the response. + * filters?: string|array, // A comma-separated list of filters to apply to the response. + * types?: string|array, // A comma-separated list of field types to include. Any fields that do not match one of these types will be excluded from the results. It defaults to empty, meaning that all field types are returned. + * include_empty_fields?: bool, // If false, empty fields are not included in the response. (DEFAULT: 1) * 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) @@ -686,17 +686,17 @@ public function fieldCaps(?array $params = null) * @param array{ * id: string, // (REQUIRED) The document ID * index: string, // (REQUIRED) The name of the index - * force_synthetic_source?: bool, // Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. - * stored_fields?: string|array, // A comma-separated list of stored fields to return in the response - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * realtime?: bool, // Specify whether to perform the operation in realtime or search mode - * refresh?: bool, // Refresh the shard containing the document before performing the operation - * routing?: string|array, // Specific routing value - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // A list of fields to extract and return from the _source field - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type + * force_synthetic_source?: bool, // Indicates whether the request forces synthetic `_source`. Use this paramater to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance. Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index. + * stored_fields?: string|array, // A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. Only leaf fields can be retrieved with the `stored_field` option. Object fields can't be returned;​if specified, the request fails. + * preference?: string, // The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name. + * realtime?: bool, // If `true`, the request is real-time as opposed to near-real-time. (DEFAULT: 1) + * refresh?: bool, // If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + * routing?: string|array, // A custom value used to route operations to a specific shard. + * _source?: string|array, // Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * version?: int, // The version number for concurrency control. It must match the current version of the document for the request to succeed. + * version_type?: string, // The version type. * 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) @@ -736,7 +736,7 @@ public function get(?array $params = null) * * @param array{ * id: string, // (REQUIRED) Script ID - * master_timeout?: int|string, // Specify timeout for connection to master + * master_timeout?: int|string, // The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -847,15 +847,15 @@ public function getScriptLanguages(?array $params = null) * @param array{ * id: string, // (REQUIRED) The document ID * index: string, // (REQUIRED) The name of the index - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * realtime?: bool, // Specify whether to perform the operation in realtime or search mode - * refresh?: bool, // Refresh the shard containing the document before performing the operation - * routing?: string|array, // Specific routing value - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // A list of fields to extract and return from the _source field - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type + * preference?: string, // The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. + * realtime?: bool, // If `true`, the request is real-time as opposed to near-real-time. (DEFAULT: 1) + * refresh?: bool, // If `true`, the request refreshes the relevant shards before retrieving the document. Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + * routing?: string|array, // A custom value used to route operations to a specific shard. + * _source?: string|array, // Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude in the response. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. + * version?: int, // The version number for concurrency control. It must match the current version of the document for the request to succeed. + * version_type?: string, // The version type. * 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) @@ -894,9 +894,9 @@ public function getSource(?array $params = null) * * @param array{ * feature?: string, // A feature of the cluster, as returned by the top-level health API - * timeout?: int|string, // Explicit operation timeout - * verbose?: bool, // Opt in for more information about the health of the system - * size?: int, // Limit the number of affected resources the health API returns + * timeout?: int|string, // Explicit operation timeout. + * verbose?: bool, // Opt-in for more information about the health of the system. (DEFAULT: 1) + * size?: int, // Limit the number of affected resources the health report API returns. (DEFAULT: 1000) * 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) @@ -939,19 +939,19 @@ public function healthReport(?array $params = null) * @param array{ * id?: string, // Document ID * index: string, // (REQUIRED) The name of the index - * 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) - * op_type?: string, // Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID - * refresh?: string, // 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. - * routing?: string|array, // Specific routing value - * timeout?: int|string, // Explicit operation timeout - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type - * if_seq_no?: int, // only perform the index operation if the last operation that has changed the document has the specified sequence number - * if_primary_term?: int, // only perform the index operation if the last operation that has changed the document has the specified primary term - * pipeline?: string, // The pipeline id to preprocess incoming documents with - * require_alias?: bool, // When true, requires destination to be an alias. Default is false - * require_data_stream?: bool, // When true, requires the destination to be a data stream (existing or to-be-created). Default is false - * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value of `1` means it waits for each primary shard to be active. (DEFAULT: 1) + * op_type?: string, // Set to `create` to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. The behavior is the same as using the `/_create` endpoint. If a document ID is specified, this paramater defaults to `index`. Otherwise, it defaults to `create`. If the request targets a data stream, an `op_type` of `create` is required. + * refresh?: string, // If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. If `wait_for`, it waits for a refresh to make this operation visible to search. If `false`, it does nothing with refreshes. (DEFAULT: false) + * routing?: string|array, // A custom value that is used to route operations to a specific shard. + * timeout?: int|string, // The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. The actual wait time could be longer, particularly when multiple waits occur. (DEFAULT: 1m) + * version?: int, // An explicit version number for concurrency control. It must be a non-negative long number. + * version_type?: string, // The version type. + * if_seq_no?: int, // Only perform the operation if the document has this sequence number. + * if_primary_term?: int, // Only perform the operation if the document has this primary term. + * pipeline?: string, // The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. + * require_alias?: bool, // If `true`, the destination must be an index alias. + * require_data_stream?: bool, // If `true`, the request's actions must target a data stream (existing or to be created). + * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. (DEFAULT: 1) * 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) @@ -1033,7 +1033,7 @@ public function info(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names to search; use `_all` to perform the operation on all indices - * routing?: string|array, // A comma-separated list of specific routing values + * routing?: string|array, // A comma-separated list of specific routing values. * 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) @@ -1076,14 +1076,14 @@ public function knnSearch(?array $params = null) * @param array{ * index?: string, // The name of the index * force_synthetic_source?: bool, // Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. - * stored_fields?: string|array, // A comma-separated list of stored fields to return in the response - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * realtime?: bool, // Specify whether to perform the operation in realtime or search mode - * refresh?: bool, // Refresh the shard containing the document before performing the operation - * routing?: string|array, // Specific routing value - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // A list of fields to extract and return from the _source field + * stored_fields?: string|array, // If `true`, retrieves the document fields stored in the index rather than the document `_source`. (DEFAULT: false) + * preference?: string, // Specifies the node or shard the operation should be performed on. Random by default. + * realtime?: bool, // If `true`, the request is real-time as opposed to near-real-time. (DEFAULT: 1) + * refresh?: bool, // If `true`, the request refreshes relevant shards before retrieving documents. + * routing?: string|array, // Custom value used to route operations to a specific shard. + * _source?: string|array, // True or false to return the `_source` field or not, or a list of fields to return. + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. * 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) @@ -1128,19 +1128,19 @@ public function mget(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to use as default - * search_type?: string, // Search operation type - * max_concurrent_searches?: int, // Controls the maximum number of concurrent searches the multi search api will execute - * typed_keys?: bool, // Specify whether aggregation and suggester names should be prefixed by their respective types in the response - * pre_filter_shard_size?: int, // 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. - * max_concurrent_shard_requests?: int, // 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 - * rest_total_hits_as_int?: bool, // Indicates whether hits.total should be rendered as an integer or an object in the rest search response - * ccs_minimize_roundtrips?: bool, // Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * routing?: string|array, // A comma-separated list of specific routing values - * include_named_queries_score?: bool, // Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + * search_type?: string, // Indicates whether global term and document frequencies should be used when scoring returned documents. + * max_concurrent_searches?: int, // Maximum number of concurrent searches the multi search API can execute. + * typed_keys?: bool, // Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + * pre_filter_shard_size?: int, // Defines 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 i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + * max_concurrent_shard_requests?: int, // Maximum number of concurrent shard requests that each sub-search request executes per node. (DEFAULT: 5) + * rest_total_hits_as_int?: bool, // If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + * ccs_minimize_roundtrips?: bool, // If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. (DEFAULT: 1) + * ignore_unavailable?: bool, // If true, missing or closed indices are not included in the response. + * ignore_throttled?: bool, // If true, concrete, expanded or aliased indices are ignored when frozen. + * allow_no_indices?: bool, // If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. + * expand_wildcards?: string|array, // Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. (DEFAULT: open) + * routing?: string|array, // Custom routing value used to route search operations to a specific shard. + * include_named_queries_score?: bool, // Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead. * 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) @@ -1185,11 +1185,11 @@ public function msearch(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to use as default - * search_type?: string, // Search operation type - * typed_keys?: bool, // Specify whether aggregation and suggester names should be prefixed by their respective types in the response - * max_concurrent_searches?: int, // Controls the maximum number of concurrent searches the multi search api will execute - * rest_total_hits_as_int?: bool, // Indicates whether hits.total should be rendered as an integer or an object in the rest search response - * ccs_minimize_roundtrips?: bool, // Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + * search_type?: string, // The type of the search operation. + * typed_keys?: bool, // If `true`, the response prefixes aggregation and suggester names with their respective types. + * max_concurrent_searches?: int, // The maximum number of concurrent searches the API can run. + * rest_total_hits_as_int?: bool, // If `true`, the response returns `hits.total` as an integer. If `false`, it returns `hits.total` as an object. + * ccs_minimize_roundtrips?: bool, // If `true`, network round-trips are minimized for cross-cluster search requests. (DEFAULT: 1) * 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) @@ -1235,17 +1235,17 @@ public function msearchTemplate(?array $params = null) * @param array{ * index?: string, // The index in which the document resides. * ids?: string|array, // A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body - * term_statistics?: bool, // Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - * field_statistics?: bool, // 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". - * fields?: string|array, // A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs". - * offsets?: bool, // Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - * positions?: bool, // Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - * payloads?: bool, // Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - * 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". - * routing?: string|array, // Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs". - * realtime?: bool, // Specifies if requests are real-time as opposed to near-real-time (default: true). - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type + * term_statistics?: bool, // If true, the response includes term frequency and document frequency. + * field_statistics?: bool, // If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. (DEFAULT: 1) + * fields?: string|array, // A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + * offsets?: bool, // If `true`, the response includes term offsets. (DEFAULT: 1) + * positions?: bool, // If `true`, the response includes term positions. (DEFAULT: 1) + * payloads?: bool, // If `true`, the response includes term payloads. (DEFAULT: 1) + * preference?: string, // The node or shard the operation should be performed on. It is random by default. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * realtime?: bool, // If true, the request is real-time as opposed to near-real-time. (DEFAULT: 1) + * version?: int, // If `true`, returns the document version as part of a hit. + * version_type?: string, // The version type. * 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) @@ -1289,13 +1289,13 @@ public function mtermvectors(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * routing?: string|array, // Specific routing value - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * keep_alive?: int|string, // Specific the time to live for the point in time - * allow_partial_search_results?: bool, // Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false) - * max_concurrent_shard_requests?: int, // The number of concurrent shard requests per node executed concurrently when opening this point-in-time. This value should be used to limit the impact of opening the point-in-time on the cluster + * preference?: string, // The node or shard the operation should be performed on. By default, it is random. + * routing?: string|array, // A custom value that is used to route operations to a specific shard. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * keep_alive?: int|string, // Extend the length of time that the point in time persists. + * allow_partial_search_results?: bool, // Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. If `true`, the point in time will contain all the shards that are available at the time of the request. + * max_concurrent_shard_requests?: int, // Maximum number of concurrent shard requests that each sub-search request executes per node. (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) @@ -1374,8 +1374,8 @@ public function ping(?array $params = null) * @param array{ * id: string, // (REQUIRED) Script ID * context?: string, // Script context - * timeout?: int|string, // Explicit operation timeout - * master_timeout?: int|string, // Specify timeout for connection to master + * timeout?: int|string, // The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. It can also be set to `-1` to indicate that the request should never timeout. (DEFAULT: 30s) + * master_timeout?: int|string, // The 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. It can also be set to `-1` to indicate that the request should never timeout. (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) @@ -1421,9 +1421,9 @@ public function putScript(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. + * ignore_unavailable?: bool, // If `true`, missing or closed indices are not included in the response. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. (DEFAULT: open) * search_type?: string, // Search operation type * pretty?: bool, // Pretty format the returned JSON response. (DEFAULT: false) * human?: bool, // Return human readable values for statistics. (DEFAULT: true) @@ -1468,15 +1468,15 @@ public function rankEval(?array $params = null) * @group serverless * * @param array{ - * refresh?: bool, // Should the affected indexes be refreshed? - * timeout?: int|string, // Time each individual bulk request should wait for shards that are unavailable. - * wait_for_active_shards?: string, // Sets the number of shard copies that must be active before proceeding with the reindex 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) - * wait_for_completion?: bool, // Should the request should block until the reindex is complete. - * requests_per_second?: int, // The throttle to set on this request in sub-requests per second. -1 means no throttle. - * scroll?: int|string, // Control how long to keep the search context alive - * slices?: int|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`. - * max_docs?: int, // Maximum number of documents to process (default: all documents) - * require_alias?: bool, // When true, requires destination to be an alias. + * refresh?: bool, // If `true`, the request refreshes affected shards to make this operation visible to search. + * timeout?: int|string, // The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. By default, Elasticsearch waits for at least one minute before failing. The actual wait time could be longer, particularly when multiple waits occur. (DEFAULT: 1m) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The default value is one, which means it waits for each primary shard to be active. (DEFAULT: 1) + * wait_for_completion?: bool, // If `true`, the request blocks until the operation is complete. (DEFAULT: 1) + * requests_per_second?: int, // The throttle for this request in sub-requests per second. By default, there is no throttle. (DEFAULT: -1) + * scroll?: int|string, // The period of time that a consistent view of the index should be maintained for scrolled search. (DEFAULT: 5m) + * slices?: int|string, // The number of slices this task should be divided into. It defaults to one slice, which means the task isn't sliced into subtasks. Reindex supports sliced scroll to parallelize the reindexing process. This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts. NOTE: Reindexing from remote clusters does not support manual or automatic slicing. If set to `auto`, Elasticsearch chooses the number of slices to use. This setting will use one slice per shard, up to a certain limit. If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards. (DEFAULT: 1) + * max_docs?: int, // The maximum number of documents to reindex. By default, all documents are reindexed. If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. + * require_alias?: bool, // If `true`, the destination must be an index alias. * 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) @@ -1516,7 +1516,7 @@ public function reindex(?array $params = null) * * @param array{ * task_id: string, // (REQUIRED) The task id to rethrottle - * requests_per_second?: int, // The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. + * requests_per_second?: int, // The throttle for this request in sub-requests per second. It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. * 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) @@ -1640,8 +1640,8 @@ public function scriptsPainlessExecute(?array $params = null) * * @param array{ * scroll_id?: string, // The scroll ID - * scroll?: int|string, // Specify how long a consistent view of the index should be maintained for scrolled search - * rest_total_hits_as_int?: bool, // Indicates whether hits.total should be rendered as an integer or an object in the rest search response + * scroll?: int|string, // The period to retain the search context for scrolling. (DEFAULT: 1d) + * rest_total_hits_as_int?: bool, // If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. * 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) @@ -1685,51 +1685,51 @@ public function scroll(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * 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, // Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution - * default_operator?: string, // The default operator for query string query (AND or 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, // A comma-separated list of stored fields to return as part of a hit - * docvalue_fields?: string|array, // A comma-separated list of fields to return as the docvalue representation of a field for each hit - * from?: int, // Starting offset (default: 0) + * analyzer?: string, // The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. + * analyze_wildcard?: bool, // If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. + * ccs_minimize_roundtrips?: bool, // If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests. (DEFAULT: 1) + * default_operator?: string, // The default operator for the query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified. (DEFAULT: or) + * df?: string, // The field to use as a default when no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. + * explain?: bool, // If `true`, the request returns detailed information about score computation as part of a hit. + * stored_fields?: string|array, // A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the `_source` parameter defaults to `false`. You can pass `_source: true` to return both source fields and stored fields in the search response. + * docvalue_fields?: string|array, // A comma-separated list of fields to return as the docvalue representation of a field for each hit. + * from?: int, // The starting document offset, which must be non-negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. * force_synthetic_source?: bool, // Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * 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) - * q?: string, // Query in the Lucene query string syntax - * routing?: string|array, // A comma-separated list of specific routing values - * scroll?: int|string, // Specify how long a consistent view of the index should be maintained for scrolled search - * search_type?: string, // Search operation type - * size?: int, // Number of hits to return (default: 10) - * sort?: string|array, // A comma-separated list of : pairs - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // 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. - * stats?: string|array, // 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_size?: int, // How many suggestions to return in response - * 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 - * 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 - * request_cache?: bool, // Specify if request cache should be used for this request or not, defaults to index level setting - * 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 a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. - * 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 - * pre_filter_shard_size?: int, // 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. - * rest_total_hits_as_int?: bool, // Indicates whether hits.total should be rendered as an integer or an object in the rest search response - * min_compatible_shard_node?: string, // The minimum compatible version that all shards involved in search should have for this request to be successful - * include_named_queries_score?: bool, // Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * ignore_throttled?: bool, // If `true`, concrete, expanded or aliased indices will be ignored when frozen. (DEFAULT: 1) + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values such as `open,hidden`. (DEFAULT: open) + * lenient?: bool, // If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. + * preference?: string, // The nodes and shards used for the search. By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. Valid values are: * `_only_local` to run the search only on shards on the local node; * `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method; * `_only_nodes:,` to run the search on only the specified nodes IDs, where, if suitable shards exist on more than one selected node, use shards on those nodes using the default method, or if none of the specified nodes are available, select shards from any available node using the default method; * `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs, or if not, select shards using the default method; * `_shards:,` to run the search only on the specified shards; * `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + * q?: string, // A query in the Lucene query string syntax. Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing. IMPORTANT: This parameter overrides the query parameter in the request body. If both parameters are specified, documents matching the query request body parameter are not returned. + * routing?: string|array, // A custom value that is used to route operations to a specific shard. + * scroll?: int|string, // The period to retain the search context for scrolling. By default, this value cannot exceed `1d` (24 hours). You can change this limit by using the `search.max_keep_alive` cluster-level setting. + * search_type?: string, // Indicates how distributed term frequencies are calculated for relevance scoring. + * size?: int, // The number of hits to return. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` parameter. (DEFAULT: 10) + * sort?: string|array, // A comma-separated list of `:` pairs. + * _source?: string|array, // The source fields that are returned for matching documents. These fields are returned in the `hits._source` property of the search response. Valid values are: * `true` to return the entire document source. * `false` to not return the document source. * `` to return the source fields that are specified as a comma-separated list that supports wildcard (`*`) patterns. (DEFAULT: true) + * _source_excludes?: string|array, // A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * _source_includes?: string|array, // A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored. + * terminate_after?: int, // The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. If set to `0` (default), the query does not terminate early. + * stats?: string|array, // Specific `tag` of the request for logging and statistical purposes. + * suggest_field?: string, // The field to use for suggestions. + * suggest_mode?: string, // The suggest mode. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. (DEFAULT: missing) + * suggest_size?: int, // The number of suggestions to return. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. + * suggest_text?: string, // The source text for which the suggestions should be returned. This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. + * timeout?: int|string, // The period of time to wait for a response from each shard. If no response is received before the timeout expires, the request fails and returns an error. It defaults to no timeout. + * track_scores?: bool, // If `true`, the request calculates and returns document scores, even if the scores are not used for sorting. + * track_total_hits?: bool|int, // The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. (DEFAULT: 10000) + * allow_partial_search_results?: bool, // If `true` and there are shard request timeouts or shard failures, the request returns partial results. If `false`, it returns an error with no partial results. To override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`. (DEFAULT: 1) + * typed_keys?: bool, // If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + * version?: bool, // If `true`, the request returns the document version as part of a hit. + * seq_no_primary_term?: bool, // If `true`, the request returns the sequence number and primary term of the last modification of each hit. + * request_cache?: bool, // If `true`, the caching of search results is enabled for requests where `size` is `0`. It defaults to index level settings. + * batched_reduce_size?: int, // The number of shard results that should be reduced at once on the coordinating node. If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request. (DEFAULT: 512) + * max_concurrent_shard_requests?: int, // The number of concurrent shard requests per node that the search runs 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) + * pre_filter_shard_size?: int, // 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 (if date filters are mandatory to match but the shard bounds and the query are disjoint). When unspecified, the pre-filter phase is executed if any of these conditions is met: * The request targets more than 128 shards. * The request targets one or more read-only index. * The primary sort of the query targets an indexed field. + * rest_total_hits_as_int?: bool, // Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + * min_compatible_shard_node?: string, // The minimum version of the node that can handle the request Any handling node with a lower version will fail the request. + * include_named_queries_score?: bool, // If `true`, the response includes the score contribution from any named queries. This functionality reruns each named query on every hit in a search response. Typically, this adds a small overhead to a request. However, using computationally expensive named queries on a large number of hits may add significant overhead. * 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) @@ -1777,14 +1777,14 @@ public function search(?array $params = null) * zoom: int, // (REQUIRED) Zoom level for the vector tile to search * x: int, // (REQUIRED) X coordinate for the vector tile to search * y: int, // (REQUIRED) Y coordinate for the vector tile to search - * exact_bounds?: bool, // If false, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. - * extent?: int, // Size, in pixels, of a side of the vector tile. - * grid_precision?: int, // Additional zoom levels available through the aggs layer. Accepts 0-8. - * grid_type?: string, // Determines the geometry type for features in the aggs layer. - * grid_agg?: string, // Aggregation used to create a grid for `field`. - * size?: int, // Maximum number of features to return in the hits layer. Accepts 0-10000. - * 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. - * with_labels?: bool, // If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features. + * exact_bounds?: bool, // If `false`, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a geo_bounds aggregation. The aggregation runs on values that intersect the // tile with wrap_longitude set to false. The resulting bounding box may be larger than the vector tile. + * extent?: int, // The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. (DEFAULT: 4096) + * grid_precision?: int, // Additional zoom levels available through the aggs layer. For example, if is 7 and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results don't include the aggs layer. (DEFAULT: 8) + * grid_type?: string, // Determines the geometry type for features in the aggs layer. In the aggs layer, each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon of the cells bounding box. If 'point' each feature is a Point that is the centroid of the cell. (DEFAULT: grid) + * grid_agg?: string, // Aggregation used to create a grid for `field`. (DEFAULT: geotile) + * size?: int, // Maximum number of features to return in the hits layer. Accepts 0-10000. If 0, results don't include the hits layer. (DEFAULT: 10000) + * track_total_hits?: bool|int, // The number of hits matching the query to count accurately. If `true`, the exact number of hits is returned at the cost of some performance. If `false`, the response does not include the total number of hits matching the query. (DEFAULT: 10000) + * with_labels?: bool, // If `true`, the hits and aggs layers will contain additional point features representing suggested label positions for the original features. * `Point` and `MultiPoint` features will have one of the points selected. * `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. * `LineString` features will likewise provide a roughly central point selected from the triangle-tree. * The aggregation results will provide one central point for each aggregation bucket. All attributes from the original features will also be copied to the new label features. In addition, the new features will be distinguishable using the tag `_mvt_label_position`. * 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) @@ -1825,13 +1825,13 @@ public function searchMvt(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * routing?: string|array, // Specific routing value - * local?: bool, // Return local information, do not retrieve the state from master node (default: false) - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * master_timeout?: int|string, // Explicit operation timeout for connection to master node + * preference?: string, // The node or shard the operation should be performed on. It is random by default. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * local?: bool, // If `true`, the request retrieves information from the local node only. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. + * expand_wildcards?: string|array, // Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * master_timeout?: int|string, // The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. IT can also be set to `-1` to indicate that the request should never timeout. (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) @@ -1873,19 +1873,19 @@ public function searchShards(?array $params = null) * * @param array{ * index?: string|array, // A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * 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, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * routing?: string|array, // A comma-separated list of specific routing values - * scroll?: int|string, // Specify how long a consistent view of the index should be maintained for scrolled search - * search_type?: string, // Search operation type - * explain?: bool, // Specify whether to return detailed information about score computation as part of a hit - * profile?: bool, // Specify whether to profile the query execution - * typed_keys?: bool, // Specify whether aggregation and suggester names should be prefixed by their respective types in the response - * rest_total_hits_as_int?: bool, // Indicates whether hits.total should be rendered as an integer or an object in the rest search response - * ccs_minimize_roundtrips?: bool, // Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * ignore_throttled?: bool, // If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. (DEFAULT: 1) + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * preference?: string, // The node or shard the operation should be performed on. It is random by default. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * scroll?: int|string, // Specifies how long a consistent view of the index should be maintained for scrolled search. + * search_type?: string, // The type of the search operation. + * explain?: bool, // If `true`, the response includes additional details about score computation as part of a hit. + * profile?: bool, // If `true`, the query execution is profiled. + * typed_keys?: bool, // If `true`, the response prefixes aggregation and suggester names with their respective types. + * rest_total_hits_as_int?: bool, // If `true`, `hits.total` is rendered as an integer in the response. If `false`, it is rendered as an object. + * ccs_minimize_roundtrips?: bool, // If `true`, network round-trips are minimized for cross-cluster search requests. * 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) @@ -1972,17 +1972,17 @@ public function termsEnum(?array $params = null) * @param array{ * index: string, // (REQUIRED) The index in which the document resides. * id?: string, // The id of the document, when not specified a doc param should be supplied. - * term_statistics?: bool, // Specifies if total term frequency and document frequency should be returned. - * field_statistics?: bool, // Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. - * fields?: string|array, // A comma-separated list of fields to return. - * offsets?: bool, // Specifies if term offsets should be returned. - * positions?: bool, // Specifies if term positions should be returned. - * payloads?: bool, // Specifies if term payloads should be returned. - * preference?: string, // Specify the node or shard the operation should be performed on (default: random). - * routing?: string|array, // Specific routing value. - * realtime?: bool, // Specifies if request is real-time as opposed to near-real-time (default: true). - * version?: int, // Explicit version number for concurrency control - * version_type?: string, // Specific version type + * term_statistics?: bool, // If `true`, the response includes: * The total term frequency (how often a term occurs in all documents). * The document frequency (the number of documents containing the current term). By default these values are not returned since term statistics can have a serious performance impact. + * field_statistics?: bool, // If `true`, the response includes: * The document count (how many documents contain this field). * The sum of document frequencies (the sum of document frequencies for all terms in this field). * The sum of total term frequencies (the sum of total term frequencies of each term in this field). (DEFAULT: 1) + * fields?: string|array, // A comma-separated list or wildcard expressions of fields to include in the statistics. It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + * offsets?: bool, // If `true`, the response includes term offsets. (DEFAULT: 1) + * positions?: bool, // If `true`, the response includes term positions. (DEFAULT: 1) + * payloads?: bool, // If `true`, the response includes term payloads. (DEFAULT: 1) + * preference?: string, // The node or shard the operation should be performed on. It is random by default. + * routing?: string|array, // A custom value that is used to route operations to a specific shard. + * realtime?: bool, // If true, the request is real-time as opposed to near-real-time. (DEFAULT: 1) + * version?: int, // If `true`, returns the document version as part of a hit. + * version_type?: string, // The version type. * 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) @@ -2029,19 +2029,19 @@ public function termvectors(?array $params = null) * @param array{ * id: string, // (REQUIRED) Document ID * index: string, // (REQUIRED) The name of the index - * wait_for_active_shards?: string, // Sets the number of shard copies that must be active before proceeding with the update 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) - * _source?: string|array, // True or false to return the _source field or not, or a list of fields to return - * _source_excludes?: string|array, // A list of fields to exclude from the returned _source field - * _source_includes?: string|array, // A list of fields to extract and return from the _source field - * lang?: string, // The script language (default: painless) - * refresh?: string, // 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. - * retry_on_conflict?: int, // Specify how many times should the operation be retried when a conflict occurs (default: 0) - * routing?: string|array, // Specific routing value - * timeout?: int|string, // Explicit operation timeout - * if_seq_no?: int, // only perform the update operation if the last operation that has changed the document has the specified sequence number - * if_primary_term?: int, // only perform the update operation if the last operation that has changed the document has the specified primary term - * require_alias?: bool, // When true, requires destination is an alias. Default is false - * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + * wait_for_active_shards?: string, // The number of copies of each shard that must be active before proceeding with the operation. Set to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1). The default value of `1` means it waits for each primary shard to be active. (DEFAULT: 1) + * _source?: string|array, // If `false`, source retrieval is turned off. You can also specify a comma-separated list of the fields you want to retrieve. (DEFAULT: true) + * _source_excludes?: string|array, // The source fields you want to exclude. + * _source_includes?: string|array, // The source fields you want to retrieve. + * lang?: string, // The script language. (DEFAULT: painless) + * refresh?: string, // If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. If 'wait_for', it waits for a refresh to make this operation visible to search. If 'false', it does nothing with refreshes. (DEFAULT: false) + * retry_on_conflict?: int, // The number of times the operation should be retried when a conflict occurs. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * timeout?: int|string, // The period to wait for the following operations: dynamic mapping updates and waiting for active shards. Elasticsearch waits for at least the timeout period before failing. The actual wait time could be longer, particularly when multiple waits occur. (DEFAULT: 1m) + * if_seq_no?: int, // Only perform the operation if the document has this sequence number. + * if_primary_term?: int, // Only perform the operation if the document has this primary term. + * require_alias?: bool, // If `true`, the destination must be an index alias. + * include_source_on_error?: bool, // True or false if to include the document source in the error message in case of parsing errors. (DEFAULT: 1) * 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) @@ -2083,37 +2083,37 @@ public function update(?array $params = null) * * @param array{ * index: string|array, // (REQUIRED) A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - * analyzer?: string, // The analyzer to use for the query string - * analyze_wildcard?: bool, // Specify whether wildcard and prefix queries should be analyzed (default: false) - * default_operator?: string, // The default operator for query string query (AND or OR) - * df?: string, // The field to use as default where no field prefix is given in the query string - * from?: int, // Starting offset (default: 0) - * ignore_unavailable?: bool, // Whether specified concrete indices should be ignored when unavailable (missing or closed) - * 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) - * conflicts?: string, // What to do when the update by query hits version conflicts? - * expand_wildcards?: string|array, // Whether to expand wildcard expression to concrete indices that are open, closed or both. - * lenient?: bool, // Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - * pipeline?: string, // Ingest pipeline to set on index requests made by this action. (default: none) - * preference?: string, // Specify the node or shard the operation should be performed on (default: random) - * q?: string, // Query in the Lucene query string syntax - * routing?: string|array, // A comma-separated list of specific routing values - * scroll?: int|string, // Specify how long a consistent view of the index should be maintained for scrolled search - * search_type?: string, // Search operation type - * search_timeout?: int|string, // Explicit timeout for each search request. Defaults to no timeout. - * max_docs?: int, // Maximum number of documents to process (default: all documents) - * sort?: string|array, // A comma-separated list of : pairs - * 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, // Specific 'tag' of the request for logging and statistical purposes - * version?: bool, // Specify whether to return document version as part of a hit + * analyzer?: string, // The analyzer to use for the query string. This parameter can be used only when the `q` query string parameter is specified. + * analyze_wildcard?: bool, // If `true`, wildcard and prefix queries are analyzed. This parameter can be used only when the `q` query string parameter is specified. + * default_operator?: string, // The default operator for query string query: `and` or `or`. This parameter can be used only when the `q` query string parameter is specified. (DEFAULT: or) + * df?: string, // The field to use as default where no field prefix is given in the query string. This parameter can be used only when the `q` query string parameter is specified. + * from?: int, // Skips the specified number of documents. + * ignore_unavailable?: bool, // If `false`, the request returns an error if it targets a missing or closed index. + * allow_no_indices?: bool, // If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`. (DEFAULT: 1) + * conflicts?: string, // The preferred behavior when update by query hits version conflicts: `abort` or `proceed`. (DEFAULT: abort) + * expand_wildcards?: string|array, // The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as `open,hidden`. (DEFAULT: open) + * lenient?: bool, // If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the `q` query string parameter is specified. + * pipeline?: string, // The ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. + * preference?: string, // The node or shard the operation should be performed on. It is random by default. + * q?: string, // A query in the Lucene query string syntax. + * routing?: string|array, // A custom value used to route operations to a specific shard. + * scroll?: int|string, // The period to retain the search context for scrolling. (DEFAULT: 5m) + * search_type?: string, // The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`. + * search_timeout?: int|string, // An explicit timeout for each search request. By default, there is no timeout. + * max_docs?: int, // The maximum number of documents to process. It defaults to all documents. When set to a value less then or equal to `scroll_size` then a scroll will not be used to retrieve the results for the operation. + * sort?: string|array, // A comma-separated list of : pairs. + * terminate_after?: int, // The maximum number of documents to collect for each shard. If a query reaches this limit, Elasticsearch terminates the query early. Elasticsearch collects documents before sorting. IMPORTANT: Use with caution. Elasticsearch applies this parameter to each shard handling the request. When possible, let Elasticsearch perform early termination automatically. Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + * stats?: string|array, // The specific `tag` of the request for logging and statistical purposes. + * version?: bool, // If `true`, returns the document version as part of a hit. * version_type?: bool, // Should the document increment the version number (internal) on hit or not (reindex) - * request_cache?: bool, // Specify if request cache should be used for this request or not, defaults to index level setting - * refresh?: bool, // Should the affected indexes be refreshed? - * timeout?: int|string, // Time each individual bulk request should wait for shards that are unavailable. - * wait_for_active_shards?: string, // Sets the number of shard copies that must be active before proceeding with the update 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) - * scroll_size?: int, // Size on the scroll request powering the update by query - * wait_for_completion?: bool, // Should the request should block until the update by query operation is complete. - * requests_per_second?: int, // The throttle to set on this request in sub-requests per second. -1 means no throttle. - * slices?: int|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`. + * request_cache?: bool, // If `true`, the request cache is used for this request. It defaults to the index-level setting. + * refresh?: bool, // If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. This is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed. + * timeout?: int|string, // The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. By default, it is one minute. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur. (DEFAULT: 1m) + * wait_for_active_shards?: string, // The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). The `timeout` parameter controls how long each write request waits for unavailable shards to become available. Both work exactly the way they work in the bulk API. (DEFAULT: 1) + * scroll_size?: int, // The size of the scroll request that powers the operation. (DEFAULT: 1000) + * wait_for_completion?: bool, // If `true`, the request blocks until the operation is complete. If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. (DEFAULT: 1) + * requests_per_second?: int, // The throttle for this request in sub-requests per second. (DEFAULT: -1) + * slices?: int|string, // The number of slices this task should be divided into. (DEFAULT: 1) * 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) @@ -2154,7 +2154,7 @@ public function updateByQuery(?array $params = null) * * @param array{ * task_id: string, // (REQUIRED) The task id to rethrottle - * requests_per_second?: int, // The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. + * requests_per_second?: int, // The throttle for this request in sub-requests per second. To turn off throttling, set it to `-1`. * 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)