Auto-generated code for 8.x (#2500)
This commit is contained in:
@ -818,6 +818,8 @@ Random by default.
|
||||
** *`expand_wildcards` (Optional, Enum("all" | "open" | "closed" | "hidden" | "none") | Enum("all" | "open" | "closed" | "hidden" | "none")[])*: 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 a list of values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
||||
** *`allow_partial_search_results` (Optional, boolean)*: 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.
|
||||
|
||||
[discrete]
|
||||
=== ping
|
||||
@ -1558,6 +1560,8 @@ client.asyncSearch.status({ id })
|
||||
|
||||
* *Request (object):*
|
||||
** *`id` (string)*: A unique identifier for the async search.
|
||||
** *`keep_alive` (Optional, string | -1 | 0)*: Specifies how long the async search needs to be available.
|
||||
Ongoing async searches and any saved search results are deleted after this period.
|
||||
|
||||
[discrete]
|
||||
==== submit
|
||||
@ -1659,14 +1663,13 @@ A partial reduction is performed every time the coordinating node has received a
|
||||
** *`pre_filter_shard_size` (Optional, number)*: The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.
|
||||
** *`request_cache` (Optional, boolean)*: Specify if request cache should be used for this request or not, defaults to true
|
||||
** *`routing` (Optional, string)*: A list of specific routing values
|
||||
** *`scroll` (Optional, string | -1 | 0)*
|
||||
** *`search_type` (Optional, Enum("query_then_fetch" | "dfs_query_then_fetch"))*: Search operation type
|
||||
** *`suggest_field` (Optional, string)*: Specifies which field to use for suggestions.
|
||||
** *`suggest_mode` (Optional, Enum("missing" | "popular" | "always"))*: Specify suggest mode
|
||||
** *`suggest_size` (Optional, number)*: How many suggestions to return in response
|
||||
** *`suggest_text` (Optional, string)*: The source text for which the suggestions should be returned.
|
||||
** *`typed_keys` (Optional, boolean)*: Specify whether aggregation and suggester names should be prefixed by their respective types in the response
|
||||
** *`rest_total_hits_as_int` (Optional, boolean)*
|
||||
** *`rest_total_hits_as_int` (Optional, boolean)*: Indicates whether hits.total should be rendered as an integer or an object in the rest search response
|
||||
** *`_source_excludes` (Optional, string | string[])*: A list of fields to exclude from the returned _source field
|
||||
** *`_source_includes` (Optional, string | string[])*: A list of fields to extract and return from the _source field
|
||||
** *`q` (Optional, string)*: Query in the Lucene query string syntax
|
||||
@ -1690,6 +1693,9 @@ client.autoscaling.deleteAutoscalingPolicy({ name })
|
||||
|
||||
* *Request (object):*
|
||||
** *`name` (string)*: the name of the autoscaling policy
|
||||
** *`master_timeout` (Optional, string | -1 | 0)*: 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.
|
||||
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
|
||||
|
||||
[discrete]
|
||||
==== get_autoscaling_capacity
|
||||
@ -1711,9 +1717,15 @@ Do not use this information to make autoscaling decisions.
|
||||
{ref}/autoscaling-get-autoscaling-capacity.html[Endpoint documentation]
|
||||
[source,ts]
|
||||
----
|
||||
client.autoscaling.getAutoscalingCapacity()
|
||||
client.autoscaling.getAutoscalingCapacity({ ... })
|
||||
----
|
||||
|
||||
[discrete]
|
||||
==== Arguments
|
||||
|
||||
* *Request (object):*
|
||||
** *`master_timeout` (Optional, string | -1 | 0)*: 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.
|
||||
|
||||
[discrete]
|
||||
==== get_autoscaling_policy
|
||||
@ -1732,6 +1744,8 @@ client.autoscaling.getAutoscalingPolicy({ name })
|
||||
|
||||
* *Request (object):*
|
||||
** *`name` (string)*: the name of the autoscaling policy
|
||||
** *`master_timeout` (Optional, string | -1 | 0)*: 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.
|
||||
|
||||
[discrete]
|
||||
==== put_autoscaling_policy
|
||||
@ -1751,6 +1765,9 @@ client.autoscaling.putAutoscalingPolicy({ name })
|
||||
* *Request (object):*
|
||||
** *`name` (string)*: the name of the autoscaling policy
|
||||
** *`policy` (Optional, { roles, deciders })*
|
||||
** *`master_timeout` (Optional, string | -1 | 0)*: 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.
|
||||
** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
|
||||
|
||||
[discrete]
|
||||
=== cat
|
||||
@ -9204,7 +9221,7 @@ client.security.bulkPutRole({ roles })
|
||||
==== Arguments
|
||||
|
||||
* *Request (object):*
|
||||
** *`roles` (Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, transient_metadata }>)*: A dictionary of role name to RoleDescriptor objects to add or update
|
||||
** *`roles` (Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, restriction, transient_metadata }>)*: A dictionary of role name to RoleDescriptor objects to add or update
|
||||
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: 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.
|
||||
|
||||
[discrete]
|
||||
@ -9361,7 +9378,7 @@ client.security.createApiKey({ ... })
|
||||
* *Request (object):*
|
||||
** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key. By default, API keys never expire.
|
||||
** *`name` (Optional, string)*: Specifies the name for this API key.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, restriction, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage.
|
||||
** *`refresh` (Optional, Enum(true | false | "wait_for"))*: 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.
|
||||
|
||||
@ -10431,7 +10448,7 @@ client.security.updateApiKey({ id })
|
||||
|
||||
* *Request (object):*
|
||||
** *`id` (string)*: The ID of the API key to update.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`role_descriptors` (Optional, Record<string, { cluster, indices, remote_indices, remote_cluster, global, applications, metadata, run_as, description, restriction, transient_metadata }>)*: An array of role descriptors for this API key. This parameter is optional. When it is not specified or is an empty array, then the API key will have a point in time snapshot of permissions of the authenticated user. If you supply role descriptors then the resultant permissions would be an intersection of API keys permissions and authenticated user’s permissions thereby limiting the access scope for API keys. The structure of role descriptor is the same as the request for create role API. For more details, see create or update roles API.
|
||||
** *`metadata` (Optional, Record<string, User-defined value>)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage.
|
||||
** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user