Skip to content

Commit 49d7dac

Browse files
Auto-generated API code (#3007)
1 parent e543e69 commit 49d7dac

File tree

3 files changed

+77
-35
lines changed

3 files changed

+77
-35
lines changed

docs/reference/api-reference.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2776,7 +2776,7 @@ client.cat.plugins({ ... })
27762776
### Arguments [_arguments_cat.plugins]
27772777

27782778
#### Request (object) [_request_cat.plugins]
2779-
- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards.
2779+
- **`h` (Optional, Enum("id" \| "name" \| "component" \| "version" \| "description") \| Enum("id" \| "name" \| "component" \| "version" \| "description")[])**: A list of columns names to display. It supports simple wildcards.
27802780
- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted.
27812781
Sorting defaults to ascending and can be changed by setting `:asc`
27822782
or `:desc` as a suffix to the column name.
@@ -2809,7 +2809,7 @@ Supports wildcards (`*`). To target all data streams and indices, omit this para
28092809
- **`active_only` (Optional, boolean)**: If `true`, the response only includes ongoing shard recoveries.
28102810
- **`bytes` (Optional, Enum("b" \| "kb" \| "mb" \| "gb" \| "tb" \| "pb"))**: The unit used to display byte values.
28112811
- **`detailed` (Optional, boolean)**: If `true`, the response includes detailed information about shard recoveries.
2812-
- **`h` (Optional, Enum("index" \| "shard" \| "time" \| "type" \| "stage" \| "source_host" \| "source_node" \| "target_host" \| "target_node" \| "repository" \| "snapshot" \| "files" \| "files_recovered" \| "files_percent" \| "files_total" \| "bytes" \| "bytes_recovered" \| "bytes_percent" \| "bytes_total" \| "translog_ops" \| "translog_ops_recovered" \| "translog_ops_percent" \| "start_time" \| "start_time_millis" \| "stop_time" \| "stop_time_millis") \| Enum("index" \| "shard" \| "time" \| "type" \| "stage" \| "source_host" \| "source_node" \| "target_host" \| "target_node" \| "repository" \| "snapshot" \| "files" \| "files_recovered" \| "files_percent" \| "files_total" \| "bytes" \| "bytes_recovered" \| "bytes_percent" \| "bytes_total" \| "translog_ops" \| "translog_ops_recovered" \| "translog_ops_percent" \| "start_time" \| "start_time_millis" \| "stop_time" \| "stop_time_millis")[])**: A list of columns names to display.
2812+
- **`h` (Optional, Enum("index" \| "shard" \| "start_time" \| "start_time_millis" \| "stop_time" \| "stop_time_millis" \| "time" \| "type" \| "stage" \| "source_host" \| "source_node" \| "target_host" \| "target_node" \| "repository" \| "snapshot" \| "files" \| "files_recovered" \| "files_percent" \| "files_total" \| "bytes" \| "bytes_recovered" \| "bytes_percent" \| "bytes_total" \| "translog_ops" \| "translog_ops_recovered" \| "translog_ops_percent") \| Enum("index" \| "shard" \| "start_time" \| "start_time_millis" \| "stop_time" \| "stop_time_millis" \| "time" \| "type" \| "stage" \| "source_host" \| "source_node" \| "target_host" \| "target_node" \| "repository" \| "snapshot" \| "files" \| "files_recovered" \| "files_percent" \| "files_total" \| "bytes" \| "bytes_recovered" \| "bytes_percent" \| "bytes_total" \| "translog_ops" \| "translog_ops_recovered" \| "translog_ops_percent")[])**: A list of columns names to display.
28132813
It supports simple wildcards.
28142814
- **`s` (Optional, string \| string[])**: A list of column names or aliases that determines the sort order.
28152815
Sorting defaults to ascending and can be changed by setting `:asc`
@@ -2947,7 +2947,7 @@ client.cat.tasks({ ... })
29472947
- **`detailed` (Optional, boolean)**: If `true`, the response includes detailed information about shard recoveries.
29482948
- **`nodes` (Optional, string[])**: Unique node identifiers, which are used to limit the response.
29492949
- **`parent_task_id` (Optional, string)**: The parent task identifier, which is used to limit the response.
2950-
- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards.
2950+
- **`h` (Optional, Enum("id" \| "action" \| "task_id" \| "parent_task_id" \| "type" \| "start_time" \| "timestamp" \| "running_time_ns" \| "running_time" \| "node_id" \| "ip" \| "port" \| "node" \| "version" \| "x_opaque_id") \| Enum("id" \| "action" \| "task_id" \| "parent_task_id" \| "type" \| "start_time" \| "timestamp" \| "running_time_ns" \| "running_time" \| "node_id" \| "ip" \| "port" \| "node" \| "version" \| "x_opaque_id")[])**: A list of columns names to display. It supports simple wildcards.
29512951
- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted.
29522952
Sorting defaults to ascending and can be changed by setting `:asc`
29532953
or `:desc` as a suffix to the column name.
@@ -2974,7 +2974,7 @@ client.cat.templates({ ... })
29742974
#### Request (object) [_request_cat.templates]
29752975
- **`name` (Optional, string)**: The name of the template to return.
29762976
Accepts wildcard expressions. If omitted, all templates are returned.
2977-
- **`h` (Optional, string \| string[])**: List of columns to appear in the response. Supports simple wildcards.
2977+
- **`h` (Optional, Enum("name" \| "index_patterns" \| "order" \| "version" \| "composed_of") \| Enum("name" \| "index_patterns" \| "order" \| "version" \| "composed_of")[])**: A list of columns names to display. It supports simple wildcards.
29782978
- **`s` (Optional, string \| string[])**: List of columns that determine how the table should be sorted.
29792979
Sorting defaults to ascending and can be changed by setting `:asc`
29802980
or `:desc` as a suffix to the column name.
@@ -7162,6 +7162,7 @@ Supports a list of values, such as `open,hidden`.
71627162
- **`allow_no_indices` (Optional, boolean)**: If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
71637163
This behavior applies even if the request targets other open indices.
71647164
For example, a request targeting `foo*,bar*` returns an error if an index starts with `foo` but no index starts with `bar`.
7165+
- **`mode` (Optional, Enum("standard" \| "time_series" \| "logsdb" \| "lookup") \| Enum("standard" \| "time_series" \| "logsdb" \| "lookup")[])**: Filter indices by index mode - standard, lookup, time_series, etc. List of IndexMode. Empty means no filter.
71657166

71667167
## client.indices.rollover [_indices.rollover]
71677168
Roll over to a new index.
@@ -8066,6 +8067,7 @@ client.inference.putElser({ task_type, elser_inference_id, service, service_sett
80668067
- **`service` (Enum("elser"))**: The type of service supported for the specified task type. In this case, `elser`.
80678068
- **`service_settings` ({ adaptive_allocations, num_allocations, num_threads })**: Settings used to install the inference model. These settings are specific to the `elser` service.
80688069
- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, separator_group, separators, strategy })**: The chunking configuration object.
8070+
Note that for ELSER endpoints, the max_chunk_size may not exceed `300`.
80698071
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
80708072

80718073
## client.inference.putGoogleaistudio [_inference.put_googleaistudio]
@@ -8108,7 +8110,7 @@ client.inference.putGooglevertexai({ task_type, googlevertexai_inference_id, ser
81088110
- **`service` (Enum("googlevertexai"))**: The type of service supported for the specified task type. In this case, `googlevertexai`.
81098111
- **`service_settings` ({ location, model_id, project_id, rate_limit, service_account_json })**: Settings used to install the inference model. These settings are specific to the `googlevertexai` service.
81108112
- **`chunking_settings` (Optional, { max_chunk_size, overlap, sentence_overlap, separator_group, separators, strategy })**: The chunking configuration object.
8111-
- **`task_settings` (Optional, { auto_truncate, top_n })**: Settings to configure the inference task.
8113+
- **`task_settings` (Optional, { auto_truncate, top_n, thinking_config })**: Settings to configure the inference task.
81128114
These settings are specific to the task type you specified.
81138115
- **`timeout` (Optional, string \| -1 \| 0)**: Specifies the amount of time to wait for the inference endpoint to be created.
81148116

@@ -14062,26 +14064,33 @@ client.snapshot.repositoryAnalyze({ repository })
1406214064
#### Request (object) [_request_snapshot.repository_analyze]
1406314065
- **`repository` (string)**: The name of the repository.
1406414066
- **`blob_count` (Optional, number)**: The total number of blobs to write to the repository during the test.
14065-
For realistic experiments, you should set it to at least `2000`.
14067+
For realistic experiments, set this parameter to at least `2000`.
1406614068
- **`concurrency` (Optional, number)**: The number of operations to run concurrently during the test.
14069+
For realistic experiments, leave this parameter unset.
1406714070
- **`detailed` (Optional, boolean)**: Indicates whether to return detailed results, including timing information for every operation performed during the analysis.
1406814071
If false, it returns only a summary of the analysis.
1406914072
- **`early_read_node_count` (Optional, number)**: The number of nodes on which to perform an early read operation while writing each blob.
1407014073
Early read operations are only rarely performed.
14074+
For realistic experiments, leave this parameter unset.
1407114075
- **`max_blob_size` (Optional, number \| string)**: The maximum size of a blob to be written during the test.
14072-
For realistic experiments, you should set it to at least `2gb`.
14076+
For realistic experiments, set this parameter to at least `2gb`.
1407314077
- **`max_total_data_size` (Optional, number \| string)**: An upper limit on the total size of all the blobs written during the test.
14074-
For realistic experiments, you should set it to at least `1tb`.
14078+
For realistic experiments, set this parameter to at least `1tb`.
1407514079
- **`rare_action_probability` (Optional, number)**: The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob.
14080+
For realistic experiments, leave this parameter unset.
1407614081
- **`rarely_abort_writes` (Optional, boolean)**: Indicates whether to rarely cancel writes before they complete.
14082+
For realistic experiments, leave this parameter unset.
1407714083
- **`read_node_count` (Optional, number)**: The number of nodes on which to read a blob after writing.
14084+
For realistic experiments, leave this parameter unset.
1407814085
- **`register_operation_count` (Optional, number)**: The minimum number of linearizable register operations to perform in total.
14079-
For realistic experiments, you should set it to at least `100`.
14086+
For realistic experiments, set this parameter to at least `100`.
1408014087
- **`seed` (Optional, number)**: The seed for the pseudo-random number generator used to generate the list of operations performed during the test.
1408114088
To repeat the same set of operations in multiple experiments, use the same seed in each experiment.
1408214089
Note that the operations are performed concurrently so might not always happen in the same order on each run.
14090+
For realistic experiments, leave this parameter unset.
1408314091
- **`timeout` (Optional, string \| -1 \| 0)**: The period of time to wait for the test to complete.
1408414092
If no response is received before the timeout expires, the test is cancelled and returns an error.
14093+
For realistic experiments, set this parameter sufficiently long to allow the test to complete.
1408514094

1408614095
## client.snapshot.repositoryVerifyIntegrity [_snapshot.repository_verify_integrity]
1408714096
Verify the repository integrity.

src/api/api/indices.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -793,7 +793,8 @@ export default class Indices {
793793
query: [
794794
'expand_wildcards',
795795
'ignore_unavailable',
796-
'allow_no_indices'
796+
'allow_no_indices',
797+
'mode'
797798
]
798799
},
799800
'indices.rollover': {

0 commit comments

Comments
 (0)