Updates to generated docs
This commit is contained in:
Josh Mock
@ -133,6 +133,7 @@ Get the async search status. Get the status of a previously submitted async sear
|
||||
----
|
||||
interface AsyncSearchStatusRequest extends <<RequestBase>> {
|
||||
id: <<Id>>
|
||||
keep_alive?: <<Duration>>
|
||||
}
|
||||
|
||||
----
|
||||
@ -172,7 +173,6 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
|
||||
index?: <<Indices>>
|
||||
wait_for_completion_timeout?: <<Duration>>
|
||||
keep_on_completion?: boolean
|
||||
keep_alive?: <<Duration>>
|
||||
allow_no_indices?: boolean
|
||||
allow_partial_search_results?: boolean
|
||||
analyzer?: string
|
||||
@ -186,12 +186,9 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
|
||||
ignore_unavailable?: boolean
|
||||
lenient?: boolean
|
||||
max_concurrent_shard_requests?: <<long>>
|
||||
min_compatible_shard_node?: <<VersionString>>
|
||||
preference?: string
|
||||
pre_filter_shard_size?: <<long>>
|
||||
request_cache?: boolean
|
||||
routing?: <<Routing>>
|
||||
scroll?: <<Duration>>
|
||||
search_type?: <<SearchType>>
|
||||
suggest_field?: <<Field>>
|
||||
suggest_mode?: <<SuggestMode>>
|
||||
|
||||
@ -56,6 +56,8 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
|
||||
----
|
||||
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
master_timeout?: <<Duration>>
|
||||
timeout?: <<Duration>>
|
||||
}
|
||||
|
||||
----
|
||||
@ -91,7 +93,9 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {}
|
||||
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
|
||||
master_timeout?: <<Duration>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -130,6 +134,7 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
|
||||
----
|
||||
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
master_timeout?: <<Duration>>
|
||||
}
|
||||
|
||||
----
|
||||
@ -167,6 +172,8 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
|
||||
----
|
||||
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
master_timeout?: <<Duration>>
|
||||
timeout?: <<Duration>>
|
||||
policy?: <<AutoscalingAutoscalingPolicy>>
|
||||
}
|
||||
|
||||
|
||||
@ -76,7 +76,7 @@ type CatAliasesResponse = CatAliasesAliasesRecord[]
|
||||
[[client.cat.allocation]]
|
||||
== `client.cat.allocation()`
|
||||
|
||||
Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
||||
Get shard allocation information. Get a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
||||
|
||||
{ref}/cat-allocation.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -95,6 +95,7 @@ Provides a snapshot of the number of shards allocated to each data node and thei
|
||||
interface CatAllocationRequest extends <<CatCatRequestBase>> {
|
||||
node_id?: <<NodeIds>>
|
||||
bytes?: <<Bytes>>
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
@ -132,6 +133,7 @@ Get component templates. Returns information about component templates in a clus
|
||||
----
|
||||
interface CatComponentTemplatesRequest extends <<CatCatRequestBase>> {
|
||||
name?: string
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
@ -188,7 +190,7 @@ type CatCountResponse = CatCountCountRecord[]
|
||||
[[client.cat.fielddata]]
|
||||
== `client.cat.fielddata()`
|
||||
|
||||
Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
|
||||
Get field data cache information. Get the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
|
||||
|
||||
{ref}/cat-fielddata.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -226,7 +228,7 @@ type CatFielddataResponse = CatFielddataFielddataRecord[]
|
||||
[[client.cat.health]]
|
||||
== `client.cat.health()`
|
||||
|
||||
Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
|
||||
Get the cluster health status. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
|
||||
|
||||
{ref}/cat-health.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -342,7 +344,7 @@ type CatIndicesResponse = CatIndicesIndicesRecord[]
|
||||
[[client.cat.master]]
|
||||
== `client.cat.master()`
|
||||
|
||||
Returns information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
Get master node information. Get information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-master.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -358,7 +360,9 @@ Returns information about the master node, including the ID, bound IP address, a
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatMasterRequest extends <<CatCatRequestBase>> {}
|
||||
interface CatMasterRequest extends <<CatCatRequestBase>> {
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -545,7 +549,7 @@ type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[]
|
||||
[[client.cat.nodeattrs]]
|
||||
== `client.cat.nodeattrs()`
|
||||
|
||||
Returns information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
Get node attribute information. Get information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-nodeattrs.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -561,7 +565,9 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatNodeattrsRequest extends <<CatCatRequestBase>> {}
|
||||
interface CatNodeattrsRequest extends <<CatCatRequestBase>> {
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -580,7 +586,7 @@ type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[]
|
||||
[[client.cat.nodes]]
|
||||
== `client.cat.nodes()`
|
||||
|
||||
Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
Get node information. Get information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-nodes.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -619,7 +625,7 @@ type CatNodesResponse = CatNodesNodesRecord[]
|
||||
[[client.cat.pendingTasks]]
|
||||
== `client.cat.pendingTasks()`
|
||||
|
||||
Returns cluster-level changes that have not yet been executed. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
|
||||
Get pending task information. Get information about cluster-level changes that have not yet taken effect. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
|
||||
|
||||
{ref}/cat-pending-tasks.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -635,7 +641,9 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatPendingTasksRequest extends <<CatCatRequestBase>> {}
|
||||
interface CatPendingTasksRequest extends <<CatCatRequestBase>> {
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -654,7 +662,7 @@ type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[]
|
||||
[[client.cat.plugins]]
|
||||
== `client.cat.plugins()`
|
||||
|
||||
Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
Get plugin information. Get a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-plugins.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -670,7 +678,9 @@ Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatPluginsRequest extends <<CatCatRequestBase>> {}
|
||||
interface CatPluginsRequest extends <<CatCatRequestBase>> {
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -689,7 +699,7 @@ type CatPluginsResponse = CatPluginsPluginsRecord[]
|
||||
[[client.cat.recovery]]
|
||||
== `client.cat.recovery()`
|
||||
|
||||
Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
|
||||
Get shard recovery information. Get information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
|
||||
|
||||
{ref}/cat-recovery.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -729,7 +739,7 @@ type CatRecoveryResponse = CatRecoveryRecoveryRecord[]
|
||||
[[client.cat.repositories]]
|
||||
== `client.cat.repositories()`
|
||||
|
||||
Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
|
||||
Get snapshot repository information. Get a list of snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
|
||||
|
||||
{ref}/cat-repositories.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -764,7 +774,7 @@ type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[]
|
||||
[[client.cat.segments]]
|
||||
== `client.cat.segments()`
|
||||
|
||||
Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
|
||||
Get segment information. Get low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
|
||||
|
||||
{ref}/cat-segments.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -783,6 +793,7 @@ Returns low-level information about the Lucene segments in index shards. For dat
|
||||
interface CatSegmentsRequest extends <<CatCatRequestBase>> {
|
||||
index?: <<Indices>>
|
||||
bytes?: <<Bytes>>
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
@ -802,7 +813,7 @@ type CatSegmentsResponse = CatSegmentsSegmentsRecord[]
|
||||
[[client.cat.shards]]
|
||||
== `client.cat.shards()`
|
||||
|
||||
Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
||||
Get shard information. Get information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
||||
|
||||
{ref}/cat-shards.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -840,7 +851,7 @@ type CatShardsResponse = CatShardsShardsRecord[]
|
||||
[[client.cat.snapshots]]
|
||||
== `client.cat.snapshots()`
|
||||
|
||||
Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
|
||||
Get snapshot information Get information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
|
||||
|
||||
{ref}/cat-snapshots.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -878,7 +889,7 @@ type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[]
|
||||
[[client.cat.tasks]]
|
||||
== `client.cat.tasks()`
|
||||
|
||||
Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
|
||||
Get task information. Get information about tasks currently running in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
|
||||
|
||||
{ref}/tasks.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -918,7 +929,7 @@ type CatTasksResponse = CatTasksTasksRecord[]
|
||||
[[client.cat.templates]]
|
||||
== `client.cat.templates()`
|
||||
|
||||
Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
|
||||
Get index template information. Get information about the index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
|
||||
|
||||
{ref}/cat-templates.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -936,6 +947,7 @@ Returns information about index templates in a cluster. You can use index templa
|
||||
----
|
||||
interface CatTemplatesRequest extends <<CatCatRequestBase>> {
|
||||
name?: <<Name>>
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
@ -955,7 +967,7 @@ type CatTemplatesResponse = CatTemplatesTemplatesRecord[]
|
||||
[[client.cat.threadPool]]
|
||||
== `client.cat.threadPool()`
|
||||
|
||||
Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
Get thread pool statistics. Get thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-thread-pool.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -974,6 +986,7 @@ Returns thread pool statistics for each node in a cluster. Returned information
|
||||
interface CatThreadPoolRequest extends <<CatCatRequestBase>> {
|
||||
thread_pool_patterns?: <<Names>>
|
||||
time?: <<TimeUnit>>
|
||||
local?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
@ -993,7 +1006,7 @@ type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[]
|
||||
[[client.cat.transforms]]
|
||||
== `client.cat.transforms()`
|
||||
|
||||
Get transforms. Returns configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
|
||||
Get transform information. Get configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
|
||||
|
||||
{ref}/cat-transforms.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -94,18 +94,20 @@ Creates a new follower index configured to follow the referenced leader index.
|
||||
interface CcrFollowRequest extends <<RequestBase>> {
|
||||
index: <<IndexName>>
|
||||
wait_for_active_shards?: <<WaitForActiveShards>>
|
||||
leader_index?: <<IndexName>>
|
||||
data_stream_name?: string
|
||||
leader_index: <<IndexName>>
|
||||
max_outstanding_read_requests?: <<long>>
|
||||
max_outstanding_write_requests?: <<long>>
|
||||
max_read_request_operation_count?: <<long>>
|
||||
max_read_request_size?: string
|
||||
max_outstanding_write_requests?: <<integer>>
|
||||
max_read_request_operation_count?: <<integer>>
|
||||
max_read_request_size?: <<ByteSize>>
|
||||
max_retry_delay?: <<Duration>>
|
||||
max_write_buffer_count?: <<long>>
|
||||
max_write_buffer_size?: string
|
||||
max_write_request_operation_count?: <<long>>
|
||||
max_write_request_size?: string
|
||||
max_write_buffer_count?: <<integer>>
|
||||
max_write_buffer_size?: <<ByteSize>>
|
||||
max_write_request_operation_count?: <<integer>>
|
||||
max_write_request_size?: <<ByteSize>>
|
||||
read_poll_timeout?: <<Duration>>
|
||||
remote_cluster?: string
|
||||
remote_cluster: string
|
||||
settings?: <<IndicesIndexSettings>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.count]]
|
||||
== `client.count()`
|
||||
|
||||
Returns number of documents matching a query.
|
||||
Count search results. Get the number of documents matching a query.
|
||||
|
||||
{ref}/search-count.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -75,7 +75,7 @@ type EnrichDeletePolicyResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.enrich.executePolicy]]
|
||||
== `client.enrich.executePolicy()`
|
||||
|
||||
Creates the enrich index for an existing enrich policy.
|
||||
Run an enrich policy. Create the enrich index for an existing enrich policy.
|
||||
|
||||
{ref}/execute-enrich-policy-api.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.eql.delete]]
|
||||
== `client.eql.delete()`
|
||||
|
||||
Deletes an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
|
||||
Delete an async EQL search. Delete an async EQL search or a stored synchronous EQL search. The API also deletes results for the search.
|
||||
|
||||
{ref}/eql-search-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -75,7 +75,7 @@ type EqlDeleteResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.eql.get]]
|
||||
== `client.eql.get()`
|
||||
|
||||
Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
|
||||
Get async EQL search results. Get the current status and available results for an async EQL search or a stored synchronous EQL search.
|
||||
|
||||
{ref}/get-async-eql-search-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -114,7 +114,7 @@ type EqlGetResponse<TEvent = unknown> = <<EqlEqlSearchResponseBase>><TEvent>
|
||||
[[client.eql.getStatus]]
|
||||
== `client.eql.getStatus()`
|
||||
|
||||
Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
|
||||
Get the async EQL status. Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
|
||||
|
||||
{ref}/get-async-eql-status-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -158,7 +158,7 @@ interface EqlGetStatusResponse {
|
||||
[[client.eql.search]]
|
||||
== `client.eql.search()`
|
||||
|
||||
Returns results matching a query expressed in Event Query Language (EQL)
|
||||
Get EQL search results. Returns search results for an Event Query Language (EQL) query. EQL assumes each document in a data stream or index corresponds to an event.
|
||||
|
||||
{ref}/eql-search-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -193,6 +193,7 @@ interface EqlSearchRequest extends <<RequestBase>> {
|
||||
fields?: <<QueryDslFieldAndFormat>> | <<Field>> | (<<QueryDslFieldAndFormat>> | <<Field>>)[]
|
||||
result_position?: EqlSearchResultPosition
|
||||
runtime_mappings?: <<MappingRuntimeFields>>
|
||||
max_samples_per_key?: <<integer>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -68,7 +68,7 @@ Retrieves the results of a previously submitted async query request given its ID
|
||||
[[client.esql.query]]
|
||||
== `client.esql.query()`
|
||||
|
||||
Executes an ES|QL request
|
||||
Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query.
|
||||
|
||||
{ref}/esql-rest.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.fleet.globalCheckpoints]]
|
||||
== `client.fleet.globalCheckpoints()`
|
||||
|
||||
Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
|
||||
Get global checkpoints. Get the current global checkpoints for an index. This API is designed for internal use by the Fleet server project.
|
||||
|
||||
{ref}/get-global-checkpoints.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -82,7 +82,7 @@ interface FleetGlobalCheckpointsResponse {
|
||||
[[client.fleet.msearch]]
|
||||
== `client.fleet.msearch()`
|
||||
|
||||
Executes several [fleet searches](https://www.elastic.co/guide/en/elasticsearch/reference/current/fleet-search.html) with a single API request. The API follows the same structure as the [multi search](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html) API. However, similar to the fleet search API, it supports the wait_for_checkpoints parameter.
|
||||
Run multiple Fleet searches. Run several Fleet searches with a single API request. The API follows the same structure as the multi search API. However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
|
||||
[discrete]
|
||||
=== Function signature
|
||||
|
||||
@ -133,7 +133,7 @@ interface FleetMsearchResponse<TDocument = unknown> {
|
||||
[[client.fleet.search]]
|
||||
== `client.fleet.search()`
|
||||
|
||||
The purpose of the fleet search api is to provide a search api where the search will only be executed after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
|
||||
Run a Fleet search. The purpose of the Fleet search API is to provide an API where the search will be run only after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
|
||||
[discrete]
|
||||
=== Function signature
|
||||
|
||||
@ -161,7 +161,6 @@ interface FleetSearchRequest extends <<RequestBase>> {
|
||||
ignore_unavailable?: boolean
|
||||
lenient?: boolean
|
||||
max_concurrent_shard_requests?: <<long>>
|
||||
min_compatible_shard_node?: <<VersionString>>
|
||||
preference?: string
|
||||
pre_filter_shard_size?: <<long>>
|
||||
request_cache?: boolean
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.graph.explore]]
|
||||
== `client.graph.explore()`
|
||||
|
||||
Extracts and summarizes information about the documents and terms in an Elasticsearch data stream or index.
|
||||
Explore graph analytics. Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned.
|
||||
|
||||
{ref}/graph-explore-api.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -788,7 +788,7 @@ interface IndicesExistsAliasRequest extends <<RequestBase>> {
|
||||
allow_no_indices?: boolean
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
ignore_unavailable?: boolean
|
||||
local?: boolean
|
||||
master_timeout?: <<Duration>>
|
||||
}
|
||||
|
||||
----
|
||||
@ -808,7 +808,7 @@ type IndicesExistsAliasResponse = boolean
|
||||
[[client.indices.existsIndexTemplate]]
|
||||
== `client.indices.existsIndexTemplate()`
|
||||
|
||||
Returns information about whether a particular index template exists.
|
||||
Check index templates. Check whether index templates exist.
|
||||
|
||||
{ref}/index-templates.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -1124,7 +1124,7 @@ interface IndicesGetAliasRequest extends <<RequestBase>> {
|
||||
allow_no_indices?: boolean
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
ignore_unavailable?: boolean
|
||||
local?: boolean
|
||||
master_timeout?: <<Duration>>
|
||||
}
|
||||
|
||||
----
|
||||
@ -1668,8 +1668,7 @@ interface IndicesPutDataLifecycleRequest extends <<RequestBase>> {
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
master_timeout?: <<Duration>>
|
||||
timeout?: <<Duration>>
|
||||
data_retention?: <<Duration>>
|
||||
downsampling?: <<IndicesDataStreamLifecycleDownsampling>>
|
||||
lifecycle?: <<IndicesDataStreamLifecycle>>
|
||||
}
|
||||
|
||||
----
|
||||
@ -2044,7 +2043,7 @@ type IndicesResolveClusterResponse = Record<<<ClusterAlias>>, IndicesResolveClus
|
||||
[[client.indices.resolveIndex]]
|
||||
== `client.indices.resolveIndex()`
|
||||
|
||||
Resolves the specified name(s) and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
|
||||
Resolve indices. Resolve the names and/or index patterns for indices, aliases, and data streams. Multiple patterns and remote clusters are supported.
|
||||
|
||||
{ref}/indices-resolve-index-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -2163,7 +2162,6 @@ interface IndicesSegmentsRequest extends <<RequestBase>> {
|
||||
allow_no_indices?: boolean
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
ignore_unavailable?: boolean
|
||||
verbose?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.ingest.deleteGeoipDatabase]]
|
||||
== `client.ingest.deleteGeoipDatabase()`
|
||||
|
||||
Deletes a geoip database configuration.
|
||||
Delete GeoIP database configurations. Delete one or more IP geolocation database configurations.
|
||||
|
||||
{ref}/delete-geoip-database-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -73,11 +73,26 @@ type IngestDeleteGeoipDatabaseResponse = <<AcknowledgedResponseBase>>
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.ingest.deleteIpLocationDatabase]]
|
||||
== `client.ingest.deleteIpLocationDatabase()`
|
||||
|
||||
Deletes an ip location database configuration
|
||||
|
||||
{ref}/delete-ip-location-database-api.html[{es} documentation]
|
||||
[discrete]
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(request: IngestDeleteIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestDeleteIpLocationDatabaseResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
[[client.ingest.deletePipeline]]
|
||||
== `client.ingest.deletePipeline()`
|
||||
|
||||
Deletes one or more existing ingest pipeline.
|
||||
Delete pipelines. Delete one or more ingest pipelines.
|
||||
|
||||
{ref}/delete-pipeline-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -116,7 +131,7 @@ type IngestDeletePipelineResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.ingest.geoIpStats]]
|
||||
== `client.ingest.geoIpStats()`
|
||||
|
||||
Gets download statistics for GeoIP2 databases used with the geoip processor.
|
||||
Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
|
||||
|
||||
{ref}/geoip-processor.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -154,7 +169,7 @@ interface IngestGeoIpStatsResponse {
|
||||
[[client.ingest.getGeoipDatabase]]
|
||||
== `client.ingest.getGeoipDatabase()`
|
||||
|
||||
Returns information about one or more geoip database configurations.
|
||||
Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.
|
||||
|
||||
{ref}/get-geoip-database-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -190,11 +205,26 @@ interface IngestGetGeoipDatabaseResponse {
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.ingest.getIpLocationDatabase]]
|
||||
== `client.ingest.getIpLocationDatabase()`
|
||||
|
||||
Returns the specified ip location database configuration
|
||||
|
||||
{ref}/get-ip-location-database-api.html[{es} documentation]
|
||||
[discrete]
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(request: IngestGetIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestGetIpLocationDatabaseResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
[[client.ingest.getPipeline]]
|
||||
== `client.ingest.getPipeline()`
|
||||
|
||||
Returns information about one or more ingest pipelines. This API returns a local reference of the pipeline.
|
||||
Get pipelines. Get information about one or more ingest pipelines. This API returns a local reference of the pipeline.
|
||||
|
||||
{ref}/get-pipeline-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -233,7 +263,7 @@ type IngestGetPipelineResponse = Record<string, <<IngestPipeline>>>
|
||||
[[client.ingest.processorGrok]]
|
||||
== `client.ingest.processorGrok()`
|
||||
|
||||
Extracts structured fields out of a single text field within a document. You choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
|
||||
Run a grok processor. Extract structured fields out of a single text field within a document. You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. A grok pattern is like a regular expression that supports aliased expressions that can be reused.
|
||||
|
||||
{ref}/grok-processor.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -270,7 +300,7 @@ interface IngestProcessorGrokResponse {
|
||||
[[client.ingest.putGeoipDatabase]]
|
||||
== `client.ingest.putGeoipDatabase()`
|
||||
|
||||
Returns information about one or more geoip database configurations.
|
||||
Create or update GeoIP database configurations. Create or update IP geolocation database configurations.
|
||||
|
||||
{ref}/put-geoip-database-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -307,11 +337,26 @@ type IngestPutGeoipDatabaseResponse = <<AcknowledgedResponseBase>>
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.ingest.putIpLocationDatabase]]
|
||||
== `client.ingest.putIpLocationDatabase()`
|
||||
|
||||
Puts the configuration for a ip location database to be downloaded
|
||||
|
||||
{ref}/put-ip-location-database-api.html[{es} documentation]
|
||||
[discrete]
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(request: IngestPutIpLocationDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestPutIpLocationDatabaseResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
[[client.ingest.putPipeline]]
|
||||
== `client.ingest.putPipeline()`
|
||||
|
||||
Creates or updates an ingest pipeline. Changes made using this API take effect immediately.
|
||||
Create or update a pipeline. Changes made using this API take effect immediately.
|
||||
|
||||
{ref}/ingest.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -357,7 +402,7 @@ type IngestPutPipelineResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.ingest.simulate]]
|
||||
== `client.ingest.simulate()`
|
||||
|
||||
Executes an ingest pipeline against a set of provided documents.
|
||||
Simulate a pipeline. Run an ingest pipeline against a set of provided documents. You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.
|
||||
|
||||
{ref}/simulate-pipeline-api.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -69,6 +69,7 @@ interface MigrationDeprecationsRequest extends <<RequestBase>> {
|
||||
interface MigrationDeprecationsResponse {
|
||||
cluster_settings: MigrationDeprecationsDeprecation[]
|
||||
index_settings: Record<string, MigrationDeprecationsDeprecation[]>
|
||||
data_streams: Record<string, MigrationDeprecationsDeprecation[]>
|
||||
node_settings: MigrationDeprecationsDeprecation[]
|
||||
ml_settings: MigrationDeprecationsDeprecation[]
|
||||
}
|
||||
|
||||
@ -2099,7 +2099,7 @@ interface MlPutDataFrameAnalyticsResponse {
|
||||
[[client.ml.putDatafeed]]
|
||||
== `client.ml.putDatafeed()`
|
||||
|
||||
Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay') at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.
|
||||
Create a datafeed. Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. You can associate only one datafeed with each anomaly detection job. The datafeed contains a query that runs at a defined interval (`frequency`). If you are concerned about delayed data, you can add a delay (`query_delay`) at each interval. When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, those credentials are used instead. You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index.
|
||||
|
||||
{ref}/ml-put-datafeed.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -61,6 +61,7 @@ interface OpenPointInTimeRequest extends <<RequestBase>> {
|
||||
preference?: string
|
||||
routing?: <<Routing>>
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
allow_partial_search_results?: boolean
|
||||
index_filter?: <<QueryDslQueryContainer>>
|
||||
}
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.queryRules.deleteRule]]
|
||||
== `client.queryRules.deleteRule()`
|
||||
|
||||
Deletes a query rule within a query ruleset.
|
||||
Delete a query rule. Delete a query rule within a query ruleset.
|
||||
|
||||
{ref}/delete-query-rule.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -76,7 +76,7 @@ type QueryRulesDeleteRuleResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.queryRules.deleteRuleset]]
|
||||
== `client.queryRules.deleteRuleset()`
|
||||
|
||||
Deletes a query ruleset.
|
||||
Delete a query ruleset.
|
||||
|
||||
{ref}/delete-query-ruleset.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -113,7 +113,7 @@ type QueryRulesDeleteRulesetResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.queryRules.getRule]]
|
||||
== `client.queryRules.getRule()`
|
||||
|
||||
Returns the details about a query rule within a query ruleset
|
||||
Get a query rule. Get details about a query rule within a query ruleset.
|
||||
|
||||
{ref}/get-query-rule.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -151,7 +151,7 @@ type QueryRulesGetRuleResponse = <<QueryRulesQueryRule>>
|
||||
[[client.queryRules.getRuleset]]
|
||||
== `client.queryRules.getRuleset()`
|
||||
|
||||
Returns the details about a query ruleset
|
||||
Get a query ruleset. Get details about a query ruleset.
|
||||
|
||||
{ref}/get-query-ruleset.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -188,7 +188,7 @@ type QueryRulesGetRulesetResponse = <<QueryRulesQueryRuleset>>
|
||||
[[client.queryRules.listRulesets]]
|
||||
== `client.queryRules.listRulesets()`
|
||||
|
||||
Returns summarized information about existing query rulesets.
|
||||
Get all query rulesets. Get summarized information about the query rulesets.
|
||||
|
||||
{ref}/list-query-rulesets.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -229,7 +229,7 @@ interface QueryRulesListRulesetsResponse {
|
||||
[[client.queryRules.putRule]]
|
||||
== `client.queryRules.putRule()`
|
||||
|
||||
Creates or updates a query rule within a query ruleset.
|
||||
Create or update a query rule. Create or update a query rule within a query ruleset.
|
||||
|
||||
{ref}/put-query-rule.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -273,7 +273,7 @@ interface QueryRulesPutRuleResponse {
|
||||
[[client.queryRules.putRuleset]]
|
||||
== `client.queryRules.putRuleset()`
|
||||
|
||||
Creates or updates a query ruleset.
|
||||
Create or update a query ruleset.
|
||||
|
||||
{ref}/put-query-ruleset.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -313,7 +313,7 @@ interface QueryRulesPutRulesetResponse {
|
||||
[[client.queryRules.test]]
|
||||
== `client.queryRules.test()`
|
||||
|
||||
Creates or updates a query ruleset.
|
||||
Test a query ruleset. Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.
|
||||
|
||||
{ref}/test-query-ruleset.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -70,7 +70,6 @@ interface SearchRequest extends <<RequestBase>> {
|
||||
include_named_queries_score?: boolean
|
||||
lenient?: boolean
|
||||
max_concurrent_shard_requests?: <<long>>
|
||||
min_compatible_shard_node?: <<VersionString>>
|
||||
preference?: string
|
||||
pre_filter_shard_size?: <<long>>
|
||||
request_cache?: boolean
|
||||
|
||||
@ -218,7 +218,7 @@ interface SearchApplicationListRequest extends <<RequestBase>> {
|
||||
----
|
||||
interface SearchApplicationListResponse {
|
||||
count: <<long>>
|
||||
results: SearchApplicationListSearchApplicationListItem[]
|
||||
results: <<SearchApplicationSearchApplication>>[]
|
||||
}
|
||||
|
||||
----
|
||||
@ -262,7 +262,7 @@ Create or update a search application.
|
||||
interface SearchApplicationPutRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
create?: boolean
|
||||
search_application?: <<SearchApplicationSearchApplication>>
|
||||
search_application?: <<SearchApplicationSearchApplicationParameters>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -105,7 +105,7 @@ interface SecurityAuthenticateRequest extends <<RequestBase>> {}
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface SecurityAuthenticateResponse {
|
||||
api_key?: <<SecurityApiKey>>
|
||||
api_key?: SecurityAuthenticateAuthenticateApiKey
|
||||
authentication_realm: <<SecurityRealmInfo>>
|
||||
email?: string | null
|
||||
full_name?: <<Name>> | null
|
||||
@ -1115,8 +1115,9 @@ interface SecurityGetBuiltinPrivilegesRequest extends <<RequestBase>> {}
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface SecurityGetBuiltinPrivilegesResponse {
|
||||
cluster: string[]
|
||||
index: <<Indices>>
|
||||
cluster: <<SecurityClusterPrivilege>>[]
|
||||
index: <<IndexName>>[]
|
||||
remote_cluster: <<SecurityRemoteClusterPrivilege>>[]
|
||||
}
|
||||
|
||||
----
|
||||
@ -1164,7 +1165,7 @@ type SecurityGetPrivilegesResponse = Record<string, Record<string, SecurityPutPr
|
||||
[[client.security.getRole]]
|
||||
== `client.security.getRole()`
|
||||
|
||||
Get roles. Get roles in the native realm. The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. The get roles API cannot retrieve roles that are defined in roles files.
|
||||
Get roles. Get roles in the native realm.
|
||||
|
||||
{ref}/security-api-get-role.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -1842,6 +1843,7 @@ interface SecurityPutRoleRequest extends <<RequestBase>> {
|
||||
global?: Record<string, any>
|
||||
indices?: <<SecurityIndicesPrivileges>>[]
|
||||
remote_indices?: <<SecurityRemoteIndicesPrivileges>>[]
|
||||
remote_cluster?: <<SecurityRemoteClusterPrivileges>>[]
|
||||
metadata?: <<Metadata>>
|
||||
run_as?: string[]
|
||||
description?: string
|
||||
|
||||
@ -136,6 +136,31 @@ interface HealthReportDiskIndicatorDetails {
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[HealthReportFileSettingsIndicator]]
|
||||
==== HealthReportFileSettingsIndicator
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface HealthReportFileSettingsIndicator extends <<HealthReportBaseIndicator>> {
|
||||
details?: <<HealthReportFileSettingsIndicatorDetails>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[HealthReportFileSettingsIndicatorDetails]]
|
||||
==== HealthReportFileSettingsIndicatorDetails
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface HealthReportFileSettingsIndicatorDetails {
|
||||
failure_streak: <<long>>
|
||||
most_recent_failure: string
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[HealthReportIlmIndicator]]
|
||||
==== HealthReportIlmIndicator
|
||||
@ -225,6 +250,7 @@ interface HealthReportIndicators {
|
||||
ilm?: <<HealthReportIlmIndicator>>
|
||||
slm?: <<HealthReportSlmIndicator>>
|
||||
shards_capacity?: <<HealthReportShardsCapacityIndicator>>
|
||||
file_settings?: <<HealthReportFileSettingsIndicator>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
@ -48,6 +48,7 @@ interface OpenPointInTimeRequest extends <<RequestBase>> {
|
||||
preference?: string
|
||||
routing?: <<Routing>>
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
allow_partial_search_results?: boolean
|
||||
index_filter?: <<QueryDslQueryContainer>>
|
||||
}
|
||||
----
|
||||
|
||||
@ -57,7 +57,6 @@ interface SearchRequest extends <<RequestBase>> {
|
||||
include_named_queries_score?: boolean
|
||||
lenient?: boolean
|
||||
max_concurrent_shard_requests?: <<long>>
|
||||
min_compatible_shard_node?: <<VersionString>>
|
||||
preference?: string
|
||||
pre_filter_shard_size?: <<long>>
|
||||
request_cache?: boolean
|
||||
|
||||
@ -1795,6 +1795,8 @@ interface RetrieverContainer {
|
||||
rrf?: <<RRFRetriever>>
|
||||
pass:[/**] @property text_similarity_reranker A retriever that reranks the top documents based on a reranking model using the InferenceAPI */
|
||||
text_similarity_reranker?: <<TextSimilarityReranker>>
|
||||
pass:[/**] @property rule A retriever that replaces the functionality of a rule query. */
|
||||
rule?: <<RuleRetriever>>
|
||||
}
|
||||
----
|
||||
|
||||
@ -1827,6 +1829,26 @@ interface RrfRank {
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[RuleRetriever]]
|
||||
=== RuleRetriever
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface RuleRetriever extends <<RetrieverBase>> {
|
||||
pass:[/**] @property ruleset_ids The ruleset IDs containing the rules this retriever is evaluating against. */
|
||||
ruleset_ids: <<Id>>[]
|
||||
pass:[/**] @property match_criteria The match criteria that will determine if a rule in the provided rulesets should be applied. */
|
||||
match_criteria: any
|
||||
pass:[/**] @property retriever The retriever whose results rules should be applied to. */
|
||||
retriever: <<RetrieverContainer>>
|
||||
pass:[/**] @property rank_window_size This value determines the size of the individual result set. */
|
||||
rank_window_size?: <<integer>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[ScalarValue]]
|
||||
=== ScalarValue
|
||||
@ -2919,8 +2941,6 @@ interface SpecUtilsCommonCatQueryParameters {
|
||||
h?: <<Names>>
|
||||
pass:[/**] @property help When set to `true` will output available columns. This option can't be combined with any other query string option. */
|
||||
help?: boolean
|
||||
pass:[/**] @property local 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. */
|
||||
local?: boolean
|
||||
pass:[/**] @property master_timeout Period to wait for a connection to the master node. */
|
||||
master_timeout?: <<Duration>>
|
||||
pass:[/**] @property s 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. */
|
||||
@ -9490,6 +9510,17 @@ interface MappingDateRangeProperty extends <<MappingRangePropertyBase>> {
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[MappingDenseVectorElementType]]
|
||||
=== MappingDenseVectorElementType
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type MappingDenseVectorElementType = 'bit' | '<<byte>>' | '<<float>>'
|
||||
----
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[MappingDenseVectorIndexOptions]]
|
||||
=== MappingDenseVectorIndexOptions
|
||||
@ -9497,15 +9528,30 @@ interface MappingDateRangeProperty extends <<MappingRangePropertyBase>> {
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface MappingDenseVectorIndexOptions {
|
||||
type: string
|
||||
m?: <<integer>>
|
||||
ef_construction?: <<integer>>
|
||||
pass:[/**] @property confidence_interval The confidence interval to use when quantizing the vectors. Can be any value between and including `0.90` and `1.0` or exactly `0`. When the value is `0`, this indicates that dynamic quantiles should be calculated for optimized quantization. When between `0.90` and `1.0`, this value restricts the values used when calculating the quantization thresholds. For example, a value of `0.95` will only use the middle `95%` of the values when calculating the quantization thresholds (e.g. the highest and lowest `2.5%` of values will be ignored). Defaults to `1/(dims + 1)` for `int8` quantized vectors and `0` for `int4` for dynamic quantile calculation. Only applicable to `int8_hnsw`, `int4_hnsw`, `int8_flat`, and `int4_flat` index types. */
|
||||
confidence_interval?: <<float>>
|
||||
pass:[/**] @property ef_construction The number of candidates to track while assembling the list of nearest neighbors for each new node. Only applicable to `hnsw`, `int8_hnsw`, and `int4_hnsw` index types. */
|
||||
ef_construction?: <<integer>>
|
||||
pass:[/**] @property m The number of neighbors each node will be connected to in the HNSW graph. Only applicable to `hnsw`, `int8_hnsw`, and `int4_hnsw` index types. */
|
||||
m?: <<integer>>
|
||||
pass:[/**] @property type The type of kNN algorithm to use. */
|
||||
type: <<MappingDenseVectorIndexOptionsType>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[MappingDenseVectorIndexOptionsType]]
|
||||
=== MappingDenseVectorIndexOptionsType
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type MappingDenseVectorIndexOptionsType = 'flat' | 'hnsw' | 'int4_flat' | 'int4_hnsw' | 'int8_flat' | 'int8_hnsw'
|
||||
----
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[MappingDenseVectorProperty]]
|
||||
=== MappingDenseVectorProperty
|
||||
@ -9514,16 +9560,32 @@ interface MappingDenseVectorIndexOptions {
|
||||
----
|
||||
interface MappingDenseVectorProperty extends <<MappingPropertyBase>> {
|
||||
type: 'dense_vector'
|
||||
element_type?: string
|
||||
pass:[/**] @property dims Number of vector dimensions. Can't exceed `4096`. If `dims` is not specified, it will be set to the length of the first vector added to the field. */
|
||||
dims?: <<integer>>
|
||||
similarity?: string
|
||||
pass:[/**] @property element_type The data type used to encode vectors. The supported data types are `<<float>>` (default), `<<byte>>`, and `bit`. */
|
||||
element_type?: <<MappingDenseVectorElementType>>
|
||||
pass:[/**] @property index If `true`, you can search this field using the kNN search API. */
|
||||
index?: boolean
|
||||
pass:[/**] @property index_options An optional section that configures the kNN indexing algorithm. The HNSW algorithm has two internal parameters that influence how the data structure is built. These can be adjusted to improve the accuracy of results, at the expense of slower indexing speed. This parameter can only be specified when `index` is `true`. */
|
||||
index_options?: <<MappingDenseVectorIndexOptions>>
|
||||
pass:[/**] @property similarity The vector similarity metric to use in kNN search. Documents are ranked by their vector field's similarity to the query vector. The `_score` of each document will be derived from the similarity, in a way that ensures scores are positive and that a larger score corresponds to a higher ranking. Defaults to `l2_norm` when `element_type` is `bit` otherwise defaults to `cosine`. `bit` vectors only support `l2_norm` as their similarity metric. This parameter can only be specified when `index` is `true`. */
|
||||
similarity?: <<MappingDenseVectorSimilarity>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[MappingDenseVectorSimilarity]]
|
||||
=== MappingDenseVectorSimilarity
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type MappingDenseVectorSimilarity = 'cosine' | 'dot_product' | 'l2_norm' | 'max_inner_product'
|
||||
----
|
||||
|
||||
|
||||
|
||||
[discrete]
|
||||
[[MappingDocValuesPropertyBase]]
|
||||
=== MappingDocValuesPropertyBase
|
||||
@ -12691,7 +12753,7 @@ interface QueryDslTermsSetQuery extends <<QueryDslQueryBase>> {
|
||||
pass:[/**] @property minimum_should_match_script Custom script containing the number of matching terms required to return a document. */
|
||||
minimum_should_match_script?: <<Script>> | string
|
||||
pass:[/**] @property terms Array of terms you wish to find in the provided field. */
|
||||
terms: string[]
|
||||
terms: <<FieldValue>>[]
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
@ -166,8 +166,12 @@ interface IndicesDataStreamIndex {
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface IndicesDataStreamLifecycle {
|
||||
pass:[/**] @property data_retention If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely. */
|
||||
data_retention?: <<Duration>>
|
||||
pass:[/**] @property downsampling The downsampling configuration to execute for the managed backing index after rollover. */
|
||||
downsampling?: <<IndicesDataStreamLifecycleDownsampling>>
|
||||
pass:[/**] @property enabled If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle that's disabled (enabled: `false`) will have no effect on the data stream. */
|
||||
enabled?: boolean
|
||||
}
|
||||
----
|
||||
|
||||
@ -212,11 +216,7 @@ interface IndicesDataStreamLifecycleRolloverConditions {
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface IndicesDataStreamLifecycleWithRollover {
|
||||
pass:[/**] @property data_retention If defined, every document added to this data stream will be stored at least for this time frame. Any time after this duration the document could be deleted. When empty, every document in this data stream will be stored indefinitely. */
|
||||
data_retention?: <<Duration>>
|
||||
pass:[/**] @property downsampling The downsampling configuration to execute for the managed backing index after rollover. */
|
||||
downsampling?: <<IndicesDataStreamLifecycleDownsampling>>
|
||||
interface IndicesDataStreamLifecycleWithRollover extends <<IndicesDataStreamLifecycle>> {
|
||||
pass:[/**] @property rollover The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`. This property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true. The contents of this field are subject to change. */
|
||||
rollover?: <<IndicesDataStreamLifecycleRolloverConditions>>
|
||||
}
|
||||
@ -617,6 +617,10 @@ interface IndicesIndexTemplate {
|
||||
allow_auto_create?: boolean
|
||||
pass:[/**] @property data_stream If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a `data_stream` object. */
|
||||
data_stream?: <<IndicesIndexTemplateDataStreamConfiguration>>
|
||||
pass:[/**] @property deprecated Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning. */
|
||||
deprecated?: boolean
|
||||
pass:[/**] @property ignore_missing_component_templates A list of component template names that are allowed to be absent. */
|
||||
ignore_missing_component_templates?: <<Names>>
|
||||
}
|
||||
----
|
||||
|
||||
@ -822,9 +826,9 @@ interface IndicesMappingLimitSettingsNestedObjects {
|
||||
----
|
||||
interface IndicesMappingLimitSettingsTotalFields {
|
||||
pass:[/**] @property limit The maximum number of fields in an index. <<Field>> and object mappings, as well as field aliases count towards this limit. The limit is in place to prevent mappings and searches from becoming too large. Higher values can lead to performance degradations and memory issues, especially in clusters with a high load or few resources. */
|
||||
limit?: <<long>>
|
||||
limit?: <<long>> | string
|
||||
pass:[/**] @property ignore_dynamic_beyond_limit This setting determines what happens when a dynamically mapped field would exceed the total fields limit. When set to false (the default), the index request of the document that tries to add a dynamic field to the mapping will fail with the message Limit of total fields [X] has been exceeded. When set to true, the index request will not fail. Instead, fields that would exceed the limit are not added to the mapping, similar to dynamic: false. The fields that were not added to the mapping will be added to the _ignored field. */
|
||||
ignore_dynamic_beyond_limit?: boolean
|
||||
ignore_dynamic_beyond_limit?: boolean | string
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
@ -350,6 +350,12 @@ interface MlCalendarEvent {
|
||||
end_time: <<DateTime>>
|
||||
pass:[/**] @property start_time The timestamp for the beginning of the scheduled event in milliseconds since the epoch or ISO 8601 format. */
|
||||
start_time: <<DateTime>>
|
||||
pass:[/**] @property skip_result When true the model will not create results for this calendar period. */
|
||||
skip_result?: boolean
|
||||
pass:[/**] @property skip_model_update When true the model will not be updated for this calendar period. */
|
||||
skip_model_update?: boolean
|
||||
pass:[/**] @property force_time_shift Shift time by this many seconds. For example adjust time for daylight savings changes */
|
||||
force_time_shift?: <<integer>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
@ -66,13 +66,24 @@ interface SearchApplicationEventDataStream {
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface SearchApplicationSearchApplication {
|
||||
pass:[/**] @property name Search Application name. */
|
||||
interface SearchApplicationSearchApplication extends <<SearchApplicationSearchApplicationParameters>> {
|
||||
pass:[/**] @property name Search Application name */
|
||||
name: <<Name>>
|
||||
pass:[/**] @property indices <<Indices>> that are part of the Search Application. */
|
||||
indices: <<IndexName>>[]
|
||||
pass:[/**] @property updated_at_millis Last time the Search Application was updated. */
|
||||
updated_at_millis: <<EpochTime>><<<UnitMillis>>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SearchApplicationSearchApplicationParameters]]
|
||||
=== SearchApplicationSearchApplicationParameters
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface SearchApplicationSearchApplicationParameters {
|
||||
pass:[/**] @property indices <<Indices>> that are part of the Search Application. */
|
||||
indices: <<IndexName>>[]
|
||||
pass:[/**] @property analytics_collection_name Analytics collection associated to the Search Application. */
|
||||
analytics_collection_name?: <<Name>>
|
||||
pass:[/**] @property template Search template to use on search operations. */
|
||||
|
||||
@ -57,35 +57,52 @@ interface SecurityAccess {
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface SecurityApiKey {
|
||||
pass:[/**] @property creation Creation time for the API key in milliseconds. */
|
||||
creation?: <<long>>
|
||||
pass:[/**] @property expiration Expiration time for the API key in milliseconds. */
|
||||
expiration?: <<long>>
|
||||
pass:[/**] @property id <<Id>> for the API key */
|
||||
id: <<Id>>
|
||||
pass:[/**] @property invalidated Invalidation status for the API key. If the key has been invalidated, it has a value of `true`. Otherwise, it is `false`. */
|
||||
invalidated?: boolean
|
||||
pass:[/**] @property name <<Name>> of the API key. */
|
||||
name: <<Name>>
|
||||
pass:[/**] @property type The type of the API key (e.g. `rest` or `cross_cluster`). */
|
||||
type: <<SecurityApiKeyType>>
|
||||
pass:[/**] @property creation Creation time for the API key in milliseconds. */
|
||||
creation: <<EpochTime>><<<UnitMillis>>>
|
||||
pass:[/**] @property expiration Expiration time for the API key in milliseconds. */
|
||||
expiration?: <<EpochTime>><<<UnitMillis>>>
|
||||
pass:[/**] @property invalidated Invalidation status for the API key. If the key has been invalidated, it has a value of `true`. Otherwise, it is `false`. */
|
||||
invalidated: boolean
|
||||
pass:[/**] @property invalidation If the key has been invalidated, invalidation time in milliseconds. */
|
||||
invalidation?: <<EpochTime>><<<UnitMillis>>>
|
||||
pass:[/**] @property username Principal for which this API key was created */
|
||||
username: <<Username>>
|
||||
pass:[/**] @property realm Realm name of the principal for which this API key was created. */
|
||||
realm?: string
|
||||
realm: string
|
||||
pass:[/**] @property realm_type Realm type of the principal for which this API key was created */
|
||||
realm_type?: string
|
||||
pass:[/**] @property username Principal for which this API key was created */
|
||||
username?: <<Username>>
|
||||
pass:[/**] @property profile_uid The profile uid for the API key owner principal, if requested and if it exists */
|
||||
profile_uid?: string
|
||||
pass:[/**] @property metadata <<Metadata>> of the API key */
|
||||
metadata?: <<Metadata>>
|
||||
metadata: <<Metadata>>
|
||||
pass:[/**] @property role_descriptors The role descriptors assigned to this API key when it was created or last updated. An empty role descriptor means the API key inherits the owner user’s permissions. */
|
||||
role_descriptors?: Record<string, <<SecurityRoleDescriptor>>>
|
||||
pass:[/**] @property limited_by The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions. */
|
||||
limited_by?: Record<string, <<SecurityRoleDescriptor>>>[]
|
||||
pass:[/**] @property access The access granted to cross-cluster API keys. The access is composed of permissions for cross cluster search and cross cluster replication. At least one of them must be specified. When specified, the new access assignment fully replaces the previously assigned access. */
|
||||
access?: <<SecurityAccess>>
|
||||
pass:[/**] @property profile_uid The profile uid for the API key owner principal, if requested and if it exists */
|
||||
profile_uid?: string
|
||||
pass:[/**] @property _sort Sorting values when using the `sort` parameter with the `security.query_api_keys` API. */
|
||||
_sort?: <<SortResults>>
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityApiKeyType]]
|
||||
=== SecurityApiKeyType
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type SecurityApiKeyType = 'rest' | 'cross_cluster'
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityApplicationGlobalUserPrivileges]]
|
||||
=== SecurityApplicationGlobalUserPrivileges
|
||||
@ -148,7 +165,7 @@ interface SecurityClusterNode {
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string
|
||||
type SecurityClusterPrivilege = 'all' | 'cancel_task' | 'create_snapshot' | 'cross_cluster_replication' | 'cross_cluster_search' | 'delegate_pki' | 'grant_api_key' | 'manage' | 'manage_api_key' | 'manage_autoscaling' | 'manage_behavioral_analytics' | 'manage_ccr' | 'manage_data_frame_transforms' | 'manage_data_stream_global_retention' | 'manage_enrich' | 'manage_ilm' | 'manage_index_templates' | 'manage_inference' | 'manage_ingest_pipelines' | 'manage_logstash_pipelines' | 'manage_ml' | 'manage_oidc' | 'manage_own_api_key' | 'manage_pipeline' | 'manage_rollup' | 'manage_saml' | 'manage_search_application' | 'manage_search_query_rules' | 'manage_search_synonyms' | 'manage_security' | 'manage_service_account' | 'manage_slm' | 'manage_token' | 'manage_transform' | 'manage_user_profile' | 'manage_watcher' | 'monitor' | 'monitor_data_frame_transforms' | 'monitor_data_stream_global_retention' | 'monitor_enrich' | 'monitor_inference' | 'monitor_ml' | 'monitor_rollup' | 'monitor_snapshot' | 'monitor_stats' | 'monitor_text_structure' | 'monitor_transform' | 'monitor_watcher' | 'none' | 'post_behavioral_analytics_event' | 'read_ccr' | 'read_fleet_secrets' | 'read_ilm' | 'read_pipeline' | 'read_security' | 'read_slm' | 'transport_client' | 'write_connector_secrets' | 'write_fleet_secrets' | string
|
||||
----
|
||||
|
||||
|
||||
@ -233,7 +250,7 @@ interface SecurityIndicesPrivileges {
|
||||
pass:[/**] @property field_security The document fields that the owners of the role have read access to. */
|
||||
field_security?: <<SecurityFieldSecurity>>
|
||||
pass:[/**] @property names A list of indices (or index name patterns) to which the permissions in this entry apply. */
|
||||
names: <<Indices>>
|
||||
names: <<IndexName>> | <<IndexName>>[]
|
||||
pass:[/**] @property privileges The index level privileges that owners of the role have on the specified indices. */
|
||||
privileges: <<SecurityIndexPrivilege>>[]
|
||||
pass:[/**] @property query A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. */
|
||||
@ -279,6 +296,31 @@ interface SecurityRealmInfo {
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityRemoteClusterPrivilege]]
|
||||
=== SecurityRemoteClusterPrivilege
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type SecurityRemoteClusterPrivilege = 'monitor_enrich' | 'monitor_stats'
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityRemoteClusterPrivileges]]
|
||||
=== SecurityRemoteClusterPrivileges
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface SecurityRemoteClusterPrivileges {
|
||||
pass:[/**] @property clusters A list of cluster aliases to which the permissions in this entry apply. */
|
||||
clusters: <<Names>>
|
||||
pass:[/**] @property privileges The cluster level privileges that owners of the role have on the remote cluster. */
|
||||
privileges: <<SecurityRemoteClusterPrivilege>>[]
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityRemoteIndicesPrivileges]]
|
||||
=== SecurityRemoteIndicesPrivileges
|
||||
@ -291,7 +333,7 @@ interface SecurityRemoteIndicesPrivileges {
|
||||
pass:[/**] @property field_security The document fields that the owners of the role have read access to. */
|
||||
field_security?: <<SecurityFieldSecurity>>
|
||||
pass:[/**] @property names A list of indices (or index name patterns) to which the permissions in this entry apply. */
|
||||
names: <<Indices>>
|
||||
names: <<IndexName>> | <<IndexName>>[]
|
||||
pass:[/**] @property privileges The index level privileges that owners of the role have on the specified indices. */
|
||||
privileges: <<SecurityIndexPrivilege>>[]
|
||||
pass:[/**] @property query A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. */
|
||||
@ -310,11 +352,35 @@ interface SecurityRemoteIndicesPrivileges {
|
||||
----
|
||||
interface SecurityReplicationAccess {
|
||||
pass:[/**] @property names A list of indices (or index name patterns) to which the permissions in this entry apply. */
|
||||
names: <<IndexName>>[]
|
||||
names: <<IndexName>> | <<IndexName>>[]
|
||||
pass:[/**] @property allow_restricted_indices This needs to be set to true if the patterns in the names field should cover system indices. */
|
||||
allow_restricted_indices?: boolean
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityRestriction]]
|
||||
=== SecurityRestriction
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface SecurityRestriction {
|
||||
workflows: <<SecurityRestrictionWorkflow>>[]
|
||||
}
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityRestrictionWorkflow]]
|
||||
=== SecurityRestrictionWorkflow
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type SecurityRestrictionWorkflow = 'search_application_query' | string
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[SecurityRoleDescriptor]]
|
||||
=== SecurityRoleDescriptor
|
||||
@ -328,6 +394,10 @@ interface SecurityRoleDescriptor {
|
||||
indices?: <<SecurityIndicesPrivileges>>[]
|
||||
pass:[/**] @property index A list of indices permissions entries. */
|
||||
index?: <<SecurityIndicesPrivileges>>[]
|
||||
pass:[/**] @property remote_indices A list of indices permissions for remote clusters. */
|
||||
remote_indices?: <<SecurityRemoteIndicesPrivileges>>[]
|
||||
pass:[/**] @property remote_cluster A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions. */
|
||||
remote_cluster?: <<SecurityRemoteClusterPrivileges>>[]
|
||||
pass:[/**] @property global An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges. */
|
||||
global?: <<SecurityGlobalPrivilege>>[] | <<SecurityGlobalPrivilege>>
|
||||
pass:[/**] @property applications A list of application privilege entries */
|
||||
@ -338,6 +408,8 @@ interface SecurityRoleDescriptor {
|
||||
run_as?: string[]
|
||||
pass:[/**] @property description Optional description of the role descriptor */
|
||||
description?: string
|
||||
pass:[/**] @property restriction Restriction for when the role descriptor is allowed to be effective. */
|
||||
restriction?: <<SecurityRestriction>>
|
||||
transient_metadata?: Record<string, any>
|
||||
}
|
||||
----
|
||||
@ -356,6 +428,10 @@ interface SecurityRoleDescriptorRead {
|
||||
indices: <<SecurityIndicesPrivileges>>[]
|
||||
pass:[/**] @property index A list of indices permissions entries. */
|
||||
index: <<SecurityIndicesPrivileges>>[]
|
||||
pass:[/**] @property remote_indices A list of indices permissions for remote clusters. */
|
||||
remote_indices?: <<SecurityRemoteIndicesPrivileges>>[]
|
||||
pass:[/**] @property remote_cluster A list of cluster permissions for remote clusters. Note - this is limited a subset of the cluster permissions. */
|
||||
remote_cluster?: <<SecurityRemoteClusterPrivileges>>[]
|
||||
pass:[/**] @property global An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware. Support for global privileges is currently limited to the management of application privileges. */
|
||||
global?: <<SecurityGlobalPrivilege>>[] | <<SecurityGlobalPrivilege>>
|
||||
pass:[/**] @property applications A list of application privilege entries */
|
||||
@ -366,6 +442,8 @@ interface SecurityRoleDescriptorRead {
|
||||
run_as?: string[]
|
||||
pass:[/**] @property description Optional description of the role descriptor */
|
||||
description?: string
|
||||
pass:[/**] @property restriction Restriction for when the role descriptor is allowed to be effective. */
|
||||
restriction?: <<SecurityRestriction>>
|
||||
transient_metadata?: Record<string, any>
|
||||
}
|
||||
----
|
||||
@ -467,7 +545,7 @@ interface SecuritySearchAccess {
|
||||
pass:[/**] @property field_security The document fields that the owners of the role have read access to. */
|
||||
field_security?: <<SecurityFieldSecurity>>
|
||||
pass:[/**] @property names A list of indices (or index name patterns) to which the permissions in this entry apply. */
|
||||
names: <<IndexName>>[]
|
||||
names: <<IndexName>> | <<IndexName>>[]
|
||||
pass:[/**] @property query A search query that defines the documents the owners of the role have access to. A document within the specified indices must match this query for it to be accessible by the owners of the role. */
|
||||
query?: <<SecurityIndicesPrivilegesQuery>>
|
||||
pass:[/**] @property allow_restricted_indices Set to `true` if using wildcard or regular expressions for patterns that cover restricted indices. Implicitly, restricted indices have limited privileges that can cause pattern tests to fail. If restricted indices are explicitly included in the `names` list, Elasticsearch checks privileges against these indices regardless of the value set for `allow_restricted_indices`. */
|
||||
@ -514,7 +592,7 @@ interface SecurityUserIndicesPrivileges {
|
||||
pass:[/**] @property field_security The document fields that the owners of the role have read access to. */
|
||||
field_security?: <<SecurityFieldSecurity>>[]
|
||||
pass:[/**] @property names A list of indices (or index name patterns) to which the permissions in this entry apply. */
|
||||
names: <<Indices>>
|
||||
names: <<IndexName>> | <<IndexName>>[]
|
||||
pass:[/**] @property privileges The index level privileges that owners of the role have on the specified indices. */
|
||||
privileges: <<SecurityIndexPrivilege>>[]
|
||||
pass:[/**] @property query Search queries that define the documents the user has access to. A document within the specified indices must match these queries for it to be accessible by the owners of the role. */
|
||||
|
||||
@ -927,6 +927,7 @@ type WatcherResponseContentType = 'json' | 'yaml' | 'text'
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface WatcherScheduleContainer {
|
||||
timezone?: string
|
||||
cron?: <<WatcherCronExpression>>
|
||||
daily?: <<WatcherDailySchedule>>
|
||||
hourly?: <<WatcherHourlySchedule>>
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.sql.clearCursor]]
|
||||
== `client.sql.clearCursor()`
|
||||
|
||||
Clears the SQL cursor
|
||||
Clear an SQL search cursor.
|
||||
|
||||
{ref}/clear-sql-cursor-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -77,7 +77,7 @@ interface SqlClearCursorResponse {
|
||||
[[client.sql.deleteAsync]]
|
||||
== `client.sql.deleteAsync()`
|
||||
|
||||
Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
|
||||
Delete an async SQL search. Delete an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it.
|
||||
|
||||
{ref}/delete-async-sql-search-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -114,7 +114,7 @@ type SqlDeleteAsyncResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.sql.getAsync]]
|
||||
== `client.sql.getAsync()`
|
||||
|
||||
Returns the current status and available results for an async SQL search or stored synchronous SQL search
|
||||
Get async SQL search results. Get the current status and available results for an async SQL search or stored synchronous SQL search.
|
||||
|
||||
{ref}/get-async-sql-search-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -162,7 +162,7 @@ interface SqlGetAsyncResponse {
|
||||
[[client.sql.getAsyncStatus]]
|
||||
== `client.sql.getAsyncStatus()`
|
||||
|
||||
Returns the current status of an async SQL search or a stored synchronous SQL search
|
||||
Get the async SQL search status. Get the current status of an async SQL search or a stored synchronous SQL search.
|
||||
|
||||
{ref}/get-async-sql-search-status-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -206,7 +206,7 @@ interface SqlGetAsyncStatusResponse {
|
||||
[[client.sql.query]]
|
||||
== `client.sql.query()`
|
||||
|
||||
Executes a SQL request
|
||||
Get SQL search results. Run an SQL request.
|
||||
|
||||
{ref}/sql-search-api.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -266,7 +266,7 @@ interface SqlQueryResponse {
|
||||
[[client.sql.translate]]
|
||||
== `client.sql.translate()`
|
||||
|
||||
Translates SQL into Elasticsearch queries
|
||||
Translate SQL into Elasticsearch queries. Translate an SQL search into a search API request containing Query DSL.
|
||||
|
||||
{ref}/sql-translate-api.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
@ -38,7 +38,7 @@
|
||||
[[client.synonyms.deleteSynonym]]
|
||||
== `client.synonyms.deleteSynonym()`
|
||||
|
||||
Deletes a synonym set
|
||||
Delete a synonym set.
|
||||
|
||||
{ref}/delete-synonyms-set.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -75,7 +75,7 @@ type SynonymsDeleteSynonymResponse = <<AcknowledgedResponseBase>>
|
||||
[[client.synonyms.deleteSynonymRule]]
|
||||
== `client.synonyms.deleteSynonymRule()`
|
||||
|
||||
Deletes a synonym rule in a synonym set
|
||||
Delete a synonym rule. Delete a synonym rule from a synonym set.
|
||||
|
||||
{ref}/delete-synonym-rule.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -113,7 +113,7 @@ type SynonymsDeleteSynonymRuleResponse = <<SynonymsSynonymsUpdateResult>>
|
||||
[[client.synonyms.getSynonym]]
|
||||
== `client.synonyms.getSynonym()`
|
||||
|
||||
Retrieves a synonym set
|
||||
Get a synonym set.
|
||||
|
||||
{ref}/get-synonyms-set.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -155,7 +155,7 @@ interface SynonymsGetSynonymResponse {
|
||||
[[client.synonyms.getSynonymRule]]
|
||||
== `client.synonyms.getSynonymRule()`
|
||||
|
||||
Retrieves a synonym rule from a synonym set
|
||||
Get a synonym rule. Get a synonym rule from a synonym set.
|
||||
|
||||
{ref}/get-synonym-rule.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -193,7 +193,7 @@ type SynonymsGetSynonymRuleResponse = <<SynonymsSynonymRuleRead>>
|
||||
[[client.synonyms.getSynonymsSets]]
|
||||
== `client.synonyms.getSynonymsSets()`
|
||||
|
||||
Retrieves a summary of all defined synonym sets
|
||||
Get all synonym sets. Get a summary of all defined synonym sets.
|
||||
|
||||
{ref}/list-synonyms-sets.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -234,7 +234,7 @@ interface SynonymsGetSynonymsSetsResponse {
|
||||
[[client.synonyms.putSynonym]]
|
||||
== `client.synonyms.putSynonym()`
|
||||
|
||||
Creates or updates a synonym set.
|
||||
Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000 synonym rules per set. If you need to manage more synonym rules, you can create multiple synonym sets.
|
||||
|
||||
{ref}/put-synonyms-set.html[{es} documentation]
|
||||
[discrete]
|
||||
@ -275,7 +275,7 @@ interface SynonymsPutSynonymResponse {
|
||||
[[client.synonyms.putSynonymRule]]
|
||||
== `client.synonyms.putSynonymRule()`
|
||||
|
||||
Creates or updates a synonym rule in a synonym set
|
||||
Create or update a synonym rule. Create or update a synonym rule in a synonym set.
|
||||
|
||||
{ref}/put-synonym-rule.html[{es} documentation]
|
||||
[discrete]
|
||||
|
||||
Reference in New Issue
Block a user