Compare commits

...

28 Commits

Author SHA1 Message Date
6683fa3648 WIP generating API reference docs with @microsoft/api-extractor 2024-12-13 14:39:40 -06:00
36d61ed442 Updates to generated docs 2024-12-05 14:47:50 -06:00
86a573691a Update links to reference docs from other files 2024-12-05 14:47:49 -06:00
6c3e2b5a8a Rename reference page 2024-12-05 14:47:49 -06:00
f04303f105 Drop missing import 2024-12-05 14:47:49 -06:00
eef143073c More docs changes 2024-12-05 14:47:47 -06:00
1fde515fcf Improvements to get docs to build 2024-12-05 14:47:29 -06:00
bd5c3d98fa More docs fixes 2024-12-05 14:47:29 -06:00
c3e7619621 Restructure reference docs directory 2024-12-05 14:47:26 -06:00
647dac8069 Remove broken URLs to other docs 2024-12-05 14:46:53 -06:00
8d619c938d More link fixes 2024-12-05 14:46:53 -06:00
f99496e2aa Fix more bad links 2024-12-05 14:46:53 -06:00
356fe2d385 Fix stray invalid type links 2024-12-05 14:46:53 -06:00
018b1537cc Fix more duplicate reference names 2024-12-05 14:46:52 -06:00
2a2e2f0016 Fix duplicate includes 2024-12-05 14:46:52 -06:00
e0f845f06f Change request/response section IDs 2024-12-05 14:46:52 -06:00
6c8d6e71cd Fixes to shared types 2024-12-05 14:46:52 -06:00
70a3ef44bb More type definitions, with fixed links (hopefully) 2024-12-05 14:46:52 -06:00
7a997b3405 Fix number type links 2024-12-05 14:46:52 -06:00
d9938f7973 Generate heading IDs 2024-12-05 14:46:52 -06:00
b463776ac4 Fix links to API requests 2024-12-05 14:46:51 -06:00
15a43f3747 Still testing 2024-12-05 14:46:51 -06:00
be8fc5ae83 Testing to see if docs gen CI is actually working 2024-12-05 14:46:51 -06:00
e0372eea89 More iteration on generated docs 2024-12-05 14:46:51 -06:00
4afd72b173 List API functions 2024-12-05 14:46:51 -06:00
ab21735b57 Use section headers for shared types 2024-12-05 14:46:51 -06:00
6151aab208 Fix section headers on generated types 2024-12-05 14:46:51 -06:00
8210607de0 Test run of new docs 2024-12-05 14:46:46 -06:00
177 changed files with 56468 additions and 12112 deletions

39
api-extractor.json Normal file
View File

@ -0,0 +1,39 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/client.d.ts",
"bundledPackages": [
"@elastic/*"
],
"apiReport": {
"enabled": false
},
"docModel": {
"enabled": true,
"apiJsonFilePath": "<projectFolder>/api-extractor/<unscopedPackageName>.api.json",
"includeForgottenExports": true
},
"dtsRollup": {
"enabled": false
},
"tsdocMetadata": {
"enabled": true,
"tsdocMetadataFilePath": "<projectFolder>/api-extractor/tsdoc-metadata.json"
},
"messages": {
"compilerMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"extractorMessageReporting": {
"default": {
"logLevel": "warning"
}
},
"tsdocMessageReporting": {
"default": {
"logLevel": "warning"
}
}
}
}

View File

@ -85,7 +85,7 @@ _Default:_ `3`
_Default:_ `30000`
|`pingTimeout`
|`number` - Max ping request timeout in milliseconds for each request. +
|`number` - Max number of milliseconds a `ClusterConnectionPool` will wait when pinging nodes before marking them dead. +
_Default:_ `3000`
|`sniffInterval`
@ -105,17 +105,13 @@ _Default:_ `'_nodes/_all/http'`
_Default:_ `false`
|`resurrectStrategy`
|`string` - Configure the node resurrection strategy. +
|`string` - Strategy for resurrecting dead nodes when using `ClusterConnectionPool`. 'ping' will issue a test request to a node and resurrect it if it responds. 'optimistic' marks a node as alive without testing it. 'none' will never attempt to revive a dead connection. +
_Options:_ `'ping'`, `'optimistic'`, `'none'` +
_Default:_ `'ping'`
|`suggestCompression`
|`boolean` - Adds `accept-encoding` header to every request. +
_Default:_ `false`
|`compression`
|`string, boolean` - Enables gzip request body compression. +
_Options:_ `'gzip'`, `false` +
_Options:_ `true`, `false` +
_Default:_ `false`
|`tls`

View File

@ -118,8 +118,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.15/release-notes-8.15.
===== OpenTelemetry zero-code instrumentation support
For those that use an observability service that supports OpenTelemetry spans, the client will now automatically generate traces for each Elasticsearch request it makes.
See {jsclient}/observability.html#_opentelemetry[the docs]
for more information.
See <<o11y-otel,the docs>> for more information.
[discrete]
=== 8.14.1
@ -329,7 +328,7 @@ https://www.elastic.co/guide/en/elasticsearch/reference/8.9/release-notes-8.9.0.
[discrete]
===== Allow document to be overwritten in `onDocument` iteratee of bulk helper https://github.com/elastic/elasticsearch-js/pull/1732[#1732]
In the {jsclient}/client-helpers.html#bulk-helper[bulk helper], documents could not be modified before being sent to Elasticsearch. It is now possible to {jsclient}/client-helpers.html#_modifying_a_document_before_operation[modify a document] before sending it.
In the <<bulk-helper,bulk helper>>, documents could not be modified before being sent to Elasticsearch. It is now possible to <<bulk-modify-doc,modify a document>> before sending it.
[discrete]
==== Fixes

View File

@ -1,10 +1,10 @@
[[bulk_examples]]
=== Bulk
With the {jsclient}/api-reference.html#_bulk[`bulk` API], you can perform multiple index/delete operations in a
With the <<client.bulk,`bulk` API>>, you can perform multiple index/delete operations in a
single API call. The `bulk` API significantly increases indexing speed.
NOTE: You can also use the {jsclient}/client-helpers.html[bulk helper].
NOTE: You can also use the <<bulk-helper,bulk helper>>.
[source,js]
----

View File

@ -1,25 +1,25 @@
[[scroll_examples]]
=== Scroll
While a search request returns a single “page” of results, the scroll API can be
used to retrieve large numbers of results (or even all results) from a single
search request, in much the same way as you would use a cursor on a traditional
While a search request returns a single “page” of results, the scroll API can be
used to retrieve large numbers of results (or even all results) from a single
search request, in much the same way as you would use a cursor on a traditional
database.
Scrolling is not intended for real time user requests, but rather for processing
large amounts of data, for example in order to reindex the contents of one index
Scrolling is not intended for real time user requests, but rather for processing
large amounts of data, for example in order to reindex the contents of one index
into a new index with a different configuration.
NOTE: The results that are returned from a scroll request reflect the state of
the index at the time that the initial search request was made, like a snapshot
in time. Subsequent changes to documents (index, update or delete) will only
NOTE: The results that are returned from a scroll request reflect the state of
the index at the time that the initial search request was made, like a snapshot
in time. Subsequent changes to documents (index, update or delete) will only
affect later search requests.
In order to use scrolling, the initial search request should specify the scroll
parameter in the query string, which tells {es} how long it should keep the
In order to use scrolling, the initial search request should specify the scroll
parameter in the query string, which tells {es} how long it should keep the
“search context” alive.
NOTE: Did you know that we provide an helper for sending scroll requests? You can find it {jsclient}/client-helpers.html[here].
NOTE: Did you know that we provide an helper for sending scroll requests? You can find it <<scroll-search-helper,here>>.
[source,js]
----
@ -113,7 +113,7 @@ async function run () {
run().catch(console.log)
----
Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using
Another cool usage of the `scroll` API can be done with Node.js ≥ 10, by using
async iteration!
[source,js]

View File

@ -338,6 +338,7 @@ console.log(result)
----
[discrete]
[[bulk-modify-doc]]
==== Modifying a document before operation
~Added~ ~in~ ~`v8.8.2`~

View File

@ -1,8 +1,5 @@
= Elasticsearch JavaScript Client
include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[]
include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
include::introduction.asciidoc[]
include::getting-started.asciidoc[]
include::changelog.asciidoc[]
@ -17,8 +14,7 @@ include::integrations.asciidoc[]
include::observability.asciidoc[]
include::transport.asciidoc[]
include::typescript.asciidoc[]
include::reference.asciidoc[]
include::reference/main.asciidoc[]
include::examples/index.asciidoc[]
include::helpers.asciidoc[]
include::redirects.asciidoc[]
include::timeout-best-practices.asciidoc[]

View File

@ -16,6 +16,7 @@ features.
All of these observability features are documented below.
[discrete]
[[o11y-otel]]
==== OpenTelemetry
The client supports OpenTelemetry's https://opentelemetry.io/docs/zero-code/js/[zero-code

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,250 @@
[[reference-async_search]]
== client.asyncSearch
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.asyncSearch.delete]]
== `client.asyncSearch.delete()`
Delete an async search. If the asynchronous search is still running, it is cancelled. Otherwise, the saved search results are deleted. If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege.
{ref}/async-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AsyncSearchDeleteRequest, options?: TransportRequestOptions) => Promise<AsyncSearchDeleteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AsyncSearchDeleteRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchDeleteResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.asyncSearch.get]]
== `client.asyncSearch.get()`
Get async search results. Retrieve the results of a previously submitted asynchronous search request. If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.
{ref}/async-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AsyncSearchGetRequest, options?: TransportRequestOptions) => Promise<AsyncSearchGetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AsyncSearchGetRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
typed_keys?: boolean
wait_for_completion_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
----
[discrete]
[[client.asyncSearch.status]]
== `client.asyncSearch.status()`
Get the async search status. Get the status of a previously submitted async search request given its identifier, without retrieving search results. If the Elasticsearch security features are enabled, use of this API is restricted to the `monitoring_user` role.
{ref}/async-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AsyncSearchStatusRequest, options?: TransportRequestOptions) => Promise<AsyncSearchStatusResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AsyncSearchStatusRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
----
[discrete]
[[client.asyncSearch.submit]]
== `client.asyncSearch.submit()`
Run an async search. When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting.
{ref}/async-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AsyncSearchSubmitRequest, options?: TransportRequestOptions) => Promise<AsyncSearchSubmitResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AsyncSearchSubmitRequest extends <<RequestBase>> {
index?: <<Indices>>
wait_for_completion_timeout?: <<Duration>>
keep_on_completion?: boolean
allow_no_indices?: boolean
allow_partial_search_results?: boolean
analyzer?: string
analyze_wildcard?: boolean
batched_reduce_size?: <<long>>
ccs_minimize_roundtrips?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: <<long>>
preference?: string
request_cache?: boolean
routing?: <<Routing>>
search_type?: <<SearchType>>
suggest_field?: <<Field>>
suggest_mode?: <<SuggestMode>>
suggest_size?: <<long>>
suggest_text?: string
typed_keys?: boolean
rest_total_hits_as_int?: boolean
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
q?: string
aggregations?: Record<string, <<AggregationsAggregationContainer>>>
pass:[/**] @alias aggregations */
aggs?: Record<string, <<AggregationsAggregationContainer>>>
collapse?: <<SearchFieldCollapse>>
explain?: boolean
ext?: Record<string, any>
from?: <<integer>>
highlight?: <<SearchHighlight>>
track_total_hits?: <<SearchTrackHits>>
indices_boost?: Record<<<IndexName>>, <<double>>>[]
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
knn?: <<KnnSearch>> | <<KnnSearch>>[]
min_score?: <<double>>
post_filter?: <<QueryDslQueryContainer>>
profile?: boolean
query?: <<QueryDslQueryContainer>>
rescore?: <<SearchRescore>> | <<SearchRescore>>[]
script_fields?: Record<string, <<ScriptField>>>
search_after?: <<SortResults>>
size?: <<integer>>
slice?: <<SlicedScroll>>
sort?: <<Sort>>
_source?: <<SearchSourceConfig>>
fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
suggest?: <<SearchSuggester>>
terminate_after?: <<long>>
timeout?: string
track_scores?: boolean
version?: boolean
seq_no_primary_term?: boolean
stored_fields?: <<Fields>>
pit?: <<SearchPointInTimeReference>>
runtime_mappings?: <<MappingRuntimeFields>>
stats?: string[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
----

View File

@ -0,0 +1,192 @@
[[reference-autoscaling]]
== client.autoscaling
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.autoscaling.deleteAutoscalingPolicy]]
== `client.autoscaling.deleteAutoscalingPolicy()`
Delete an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
{ref}/autoscaling-delete-autoscaling-policy.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AutoscalingDeleteAutoscalingPolicyRequest, options?: TransportRequestOptions) => Promise<AutoscalingDeleteAutoscalingPolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.autoscaling.getAutoscalingCapacity]]
== `client.autoscaling.getAutoscalingCapacity()`
Get the autoscaling capacity. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported. This API gets the current autoscaling capacity based on the configured autoscaling policy. It will return information to size the cluster appropriately to the current workload. The `required_capacity` is calculated as the maximum of the `required_capacity` result of all individual deciders that are enabled for the policy. The operator should verify that the `current_nodes` match the operators knowledge of the cluster to avoid making autoscaling decisions based on stale or incomplete information. The response contains decider-specific information you can use to diagnose how and why autoscaling determined a certain capacity was required. This information is provided for diagnosis only. Do not use this information to make autoscaling decisions.
{ref}/autoscaling-get-autoscaling-capacity.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptions) => Promise<AutoscalingGetAutoscalingCapacityResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
master_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface AutoscalingGetAutoscalingCapacityResponse {
policies: Record<string, AutoscalingGetAutoscalingCapacityAutoscalingDeciders>
}
----
[discrete]
[[client.autoscaling.getAutoscalingPolicy]]
== `client.autoscaling.getAutoscalingPolicy()`
Get an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
{ref}/autoscaling-get-autoscaling-capacity.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AutoscalingGetAutoscalingPolicyRequest, options?: TransportRequestOptions) => Promise<AutoscalingGetAutoscalingPolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AutoscalingGetAutoscalingPolicyResponse = <<AutoscalingAutoscalingPolicy>>
----
[discrete]
[[client.autoscaling.putAutoscalingPolicy]]
== `client.autoscaling.putAutoscalingPolicy()`
Create or update an autoscaling policy. NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.
{ref}/autoscaling-put-autoscaling-policy.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: AutoscalingPutAutoscalingPolicyRequest, options?: TransportRequestOptions) => Promise<AutoscalingPutAutoscalingPolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
policy?: <<AutoscalingAutoscalingPolicy>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AutoscalingPutAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
----

View File

@ -0,0 +1,88 @@
[[reference-bulk]]
== client.bulk
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.bulk]]
== `client.bulk()`
Bulk index or delete documents. Performs multiple indexing or delete operations in a single API call. This reduces overhead and can greatly increase indexing speed.
{ref}/docs-bulk.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: BulkRequest, options?: TransportRequestOptions) => Promise<BulkResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
index?: <<IndexName>>
pipeline?: string
refresh?: <<Refresh>>
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
require_alias?: boolean
operations?: (<<BulkOperationContainer>> | <<BulkUpdateAction>><TDocument, TPartialDocument> | TDocument)[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface BulkResponse {
errors: boolean
items: Partial<Record<<<BulkOperationType>>, <<BulkResponseItem>>>>[]
took: <<long>>
ingest_took?: <<long>>
}
----

1047
docs/reference/cat.asciidoc Normal file

File diff suppressed because it is too large Load Diff

574
docs/reference/ccr.asciidoc Normal file
View File

@ -0,0 +1,574 @@
[[reference-ccr]]
== client.ccr
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.deleteAutoFollowPattern]]
== `client.ccr.deleteAutoFollowPattern()`
Deletes auto-follow patterns.
{ref}/ccr-delete-auto-follow-pattern.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrDeleteAutoFollowPatternRequest, options?: TransportRequestOptions) => Promise<CcrDeleteAutoFollowPatternResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrDeleteAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrDeleteAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ccr.follow]]
== `client.ccr.follow()`
Creates a new follower index configured to follow the referenced leader index.
{ref}/ccr-put-follow.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrFollowRequest, options?: TransportRequestOptions) => Promise<CcrFollowResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
wait_for_active_shards?: <<WaitForActiveShards>>
data_stream_name?: string
leader_index: <<IndexName>>
max_outstanding_read_requests?: <<long>>
max_outstanding_write_requests?: <<integer>>
max_read_request_operation_count?: <<integer>>
max_read_request_size?: <<ByteSize>>
max_retry_delay?: <<Duration>>
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
settings?: <<IndicesIndexSettings>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrFollowResponse {
follow_index_created: boolean
follow_index_shards_acked: boolean
index_following_started: boolean
}
----
[discrete]
[[client.ccr.followInfo]]
== `client.ccr.followInfo()`
Retrieves information about all follower indices, including parameters and status for each follower index
{ref}/ccr-get-follow-info.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrFollowInfoRequest, options?: TransportRequestOptions) => Promise<CcrFollowInfoResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrFollowInfoRequest extends <<RequestBase>> {
index: <<Indices>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrFollowInfoResponse {
follower_indices: CcrFollowInfoFollowerIndex[]
}
----
[discrete]
[[client.ccr.followStats]]
== `client.ccr.followStats()`
Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices.
{ref}/ccr-get-follow-stats.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrFollowStatsRequest, options?: TransportRequestOptions) => Promise<CcrFollowStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrFollowStatsRequest extends <<RequestBase>> {
index: <<Indices>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrFollowStatsResponse {
indices: <<CcrFollowIndexStats>>[]
}
----
[discrete]
[[client.ccr.forgetFollower]]
== `client.ccr.forgetFollower()`
Removes the follower retention leases from the leader.
{ref}/ccr-post-forget-follower.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrForgetFollowerRequest, options?: TransportRequestOptions) => Promise<CcrForgetFollowerResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrForgetFollowerRequest extends <<RequestBase>> {
index: <<IndexName>>
follower_cluster?: string
follower_index?: <<IndexName>>
follower_index_uuid?: <<Uuid>>
leader_remote_cluster?: string
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrForgetFollowerResponse {
_shards: <<ShardStatistics>>
}
----
[discrete]
[[client.ccr.getAutoFollowPattern]]
== `client.ccr.getAutoFollowPattern()`
Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection.
{ref}/ccr-get-auto-follow-pattern.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrGetAutoFollowPatternRequest, options?: TransportRequestOptions) => Promise<CcrGetAutoFollowPatternResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrGetAutoFollowPatternRequest extends <<RequestBase>> {
name?: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrGetAutoFollowPatternResponse {
patterns: CcrGetAutoFollowPatternAutoFollowPattern[]
}
----
[discrete]
[[client.ccr.pauseAutoFollowPattern]]
== `client.ccr.pauseAutoFollowPattern()`
Pauses an auto-follow pattern
{ref}/ccr-pause-auto-follow-pattern.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrPauseAutoFollowPatternRequest, options?: TransportRequestOptions) => Promise<CcrPauseAutoFollowPatternResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrPauseAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrPauseAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ccr.pauseFollow]]
== `client.ccr.pauseFollow()`
Pauses a follower index. The follower index will not fetch any additional operations from the leader index.
{ref}/ccr-post-pause-follow.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrPauseFollowRequest, options?: TransportRequestOptions) => Promise<CcrPauseFollowResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrPauseFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrPauseFollowResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ccr.putAutoFollowPattern]]
== `client.ccr.putAutoFollowPattern()`
Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices.
{ref}/ccr-put-auto-follow-pattern.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrPutAutoFollowPatternRequest, options?: TransportRequestOptions) => Promise<CcrPutAutoFollowPatternResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrPutAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
remote_cluster: string
follow_index_pattern?: <<IndexPattern>>
leader_index_patterns?: <<IndexPatterns>>
leader_index_exclusion_patterns?: <<IndexPatterns>>
max_outstanding_read_requests?: <<integer>>
settings?: Record<string, any>
max_outstanding_write_requests?: <<integer>>
read_poll_timeout?: <<Duration>>
max_read_request_operation_count?: <<integer>>
max_read_request_size?: <<ByteSize>>
max_retry_delay?: <<Duration>>
max_write_buffer_count?: <<integer>>
max_write_buffer_size?: <<ByteSize>>
max_write_request_operation_count?: <<integer>>
max_write_request_size?: <<ByteSize>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrPutAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ccr.resumeAutoFollowPattern]]
== `client.ccr.resumeAutoFollowPattern()`
Resumes an auto-follow pattern that has been paused
{ref}/ccr-resume-auto-follow-pattern.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrResumeAutoFollowPatternRequest, options?: TransportRequestOptions) => Promise<CcrResumeAutoFollowPatternResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrResumeAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrResumeAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ccr.resumeFollow]]
== `client.ccr.resumeFollow()`
Resumes a follower index that has been paused
{ref}/ccr-post-resume-follow.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrResumeFollowRequest, options?: TransportRequestOptions) => Promise<CcrResumeFollowResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrResumeFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
max_outstanding_read_requests?: <<long>>
max_outstanding_write_requests?: <<long>>
max_read_request_operation_count?: <<long>>
max_read_request_size?: string
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
read_poll_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrResumeFollowResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ccr.stats]]
== `client.ccr.stats()`
Gets all stats related to cross-cluster replication.
{ref}/ccr-get-stats.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrStatsRequest, options?: TransportRequestOptions) => Promise<CcrStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrStatsRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrStatsResponse {
auto_follow_stats: CcrStatsAutoFollowStats
follow_stats: CcrStatsFollowStats
}
----
[discrete]
[[client.ccr.unfollow]]
== `client.ccr.unfollow()`
Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.
{ref}/ccr-post-unfollow.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CcrUnfollowRequest, options?: TransportRequestOptions) => Promise<CcrUnfollowResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CcrUnfollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrUnfollowResponse = <<AcknowledgedResponseBase>>
----

View File

@ -0,0 +1,76 @@
[[reference-clear_scroll]]
== client.clearScroll
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.clearScroll]]
== `client.clearScroll()`
Clear a scrolling search. Clear the search context and results for a scrolling search.
{ref}/clear-scroll-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClearScrollRequest, options?: TransportRequestOptions) => Promise<ClearScrollResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClearScrollRequest extends <<RequestBase>> {
scroll_id?: <<ScrollIds>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClearScrollResponse {
succeeded: boolean
num_freed: <<integer>>
}
----

View File

@ -0,0 +1,76 @@
[[reference-close_point_in_time]]
== client.closePointInTime
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.closePointInTime]]
== `client.closePointInTime()`
Close a point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist. A point in time is automatically closed when the `keep_alive` period has elapsed. However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.
{ref}/point-in-time-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClosePointInTimeRequest, options?: TransportRequestOptions) => Promise<ClosePointInTimeResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClosePointInTimeRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClosePointInTimeResponse {
succeeded: boolean
num_freed: <<integer>>
}
----

View File

@ -0,0 +1,731 @@
[[reference-cluster]]
== client.cluster
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.allocationExplain]]
== `client.cluster.allocationExplain()`
Provides explanations for shard allocations in the cluster.
{ref}/cluster-allocation-explain.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterAllocationExplainRequest, options?: TransportRequestOptions) => Promise<ClusterAllocationExplainResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterAllocationExplainRequest extends <<RequestBase>> {
include_disk_info?: boolean
include_yes_decisions?: boolean
current_node?: string
index?: <<IndexName>>
primary?: boolean
shard?: <<integer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterAllocationExplainResponse {
allocate_explanation?: string
allocation_delay?: <<Duration>>
allocation_delay_in_millis?: <<DurationValue>><<<UnitMillis>>>
can_allocate?: ClusterAllocationExplainDecision
can_move_to_other_node?: ClusterAllocationExplainDecision
can_rebalance_cluster?: ClusterAllocationExplainDecision
can_rebalance_cluster_decisions?: ClusterAllocationExplainAllocationDecision[]
can_rebalance_to_other_node?: ClusterAllocationExplainDecision
can_remain_decisions?: ClusterAllocationExplainAllocationDecision[]
can_remain_on_current_node?: ClusterAllocationExplainDecision
cluster_info?: ClusterAllocationExplainClusterInfo
configured_delay?: <<Duration>>
configured_delay_in_millis?: <<DurationValue>><<<UnitMillis>>>
current_node?: ClusterAllocationExplainCurrentNode
current_state: string
index: <<IndexName>>
move_explanation?: string
node_allocation_decisions?: ClusterAllocationExplainNodeAllocationExplanation[]
primary: boolean
rebalance_explanation?: string
remaining_delay?: <<Duration>>
remaining_delay_in_millis?: <<DurationValue>><<<UnitMillis>>>
shard: <<integer>>
unassigned_info?: ClusterAllocationExplainUnassignedInformation
note?: string
}
----
[discrete]
[[client.cluster.deleteComponentTemplate]]
== `client.cluster.deleteComponentTemplate()`
Delete component templates. Deletes component templates. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.
{ref}/indices-component-template.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterDeleteComponentTemplateRequest, options?: TransportRequestOptions) => Promise<ClusterDeleteComponentTemplateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterDeleteComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterDeleteComponentTemplateResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.cluster.deleteVotingConfigExclusions]]
== `client.cluster.deleteVotingConfigExclusions()`
Clears cluster voting config exclusions.
{ref}/voting-config-exclusions.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterDeleteVotingConfigExclusionsRequest, options?: TransportRequestOptions) => Promise<ClusterDeleteVotingConfigExclusionsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterDeleteVotingConfigExclusionsRequest extends <<RequestBase>> {
wait_for_removal?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterDeleteVotingConfigExclusionsResponse = boolean
----
[discrete]
[[client.cluster.existsComponentTemplate]]
== `client.cluster.existsComponentTemplate()`
Check component templates. Returns information about whether a particular component template exists.
{ref}/indices-component-template.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterExistsComponentTemplateRequest, options?: TransportRequestOptions) => Promise<ClusterExistsComponentTemplateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterExistsComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
local?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterExistsComponentTemplateResponse = boolean
----
[discrete]
[[client.cluster.getComponentTemplate]]
== `client.cluster.getComponentTemplate()`
Get component templates. Retrieves information about component templates.
{ref}/indices-component-template.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterGetComponentTemplateRequest, options?: TransportRequestOptions) => Promise<ClusterGetComponentTemplateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
name?: <<Name>>
flat_settings?: boolean
include_defaults?: boolean
local?: boolean
master_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterGetComponentTemplateResponse {
component_templates: <<ClusterComponentTemplate>>[]
}
----
[discrete]
[[client.cluster.getSettings]]
== `client.cluster.getSettings()`
Returns cluster-wide settings. By default, it returns only settings that have been explicitly defined.
{ref}/cluster-get-settings.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterGetSettingsRequest, options?: TransportRequestOptions) => Promise<ClusterGetSettingsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterGetSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
include_defaults?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterGetSettingsResponse {
persistent: Record<string, any>
transient: Record<string, any>
defaults?: Record<string, any>
}
----
[discrete]
[[client.cluster.health]]
== `client.cluster.health()`
The cluster health API returns a simple status on the health of the cluster. You can also use the API to get the health status of only specified data streams and indices. For data streams, the API retrieves the health status of the streams backing indices. The cluster health status is: green, yellow or red. On the shard level, a red status indicates that the specific shard is not allocated in the cluster, yellow means that the primary shard is allocated but replicas are not, and green means that all shards are allocated. The index level status is controlled by the worst shard status. The cluster status is controlled by the worst index status.
{ref}/cluster-health.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterHealthRequest, options?: TransportRequestOptions) => Promise<ClusterHealthResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterHealthRequest extends <<RequestBase>> {
index?: <<Indices>>
expand_wildcards?: <<ExpandWildcards>>
level?: <<Level>>
local?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
wait_for_events?: <<WaitForEvents>>
wait_for_nodes?: string | <<integer>>
wait_for_no_initializing_shards?: boolean
wait_for_no_relocating_shards?: boolean
wait_for_status?: <<HealthStatus>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterHealthResponse = ClusterHealthHealthResponseBody
----
[discrete]
[[client.cluster.info]]
== `client.cluster.info()`
Get cluster info. Returns basic information about the cluster.
{ref}/cluster-info.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterInfoRequest, options?: TransportRequestOptions) => Promise<ClusterInfoResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterInfoRequest extends <<RequestBase>> {
target: <<ClusterInfoTargets>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterInfoResponse {
cluster_name: <<Name>>
http?: <<NodesHttp>>
ingest?: <<NodesIngest>>
thread_pool?: Record<string, <<NodesThreadCount>>>
script?: <<NodesScripting>>
}
----
[discrete]
[[client.cluster.pendingTasks]]
== `client.cluster.pendingTasks()`
Returns cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet been executed. NOTE: This API returns a list of any pending updates to the cluster state. These are distinct from the tasks reported by the Task Management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.
{ref}/cluster-pending.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterPendingTasksRequest, options?: TransportRequestOptions) => Promise<ClusterPendingTasksResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterPendingTasksRequest extends <<RequestBase>> {
local?: boolean
master_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterPendingTasksResponse {
tasks: ClusterPendingTasksPendingTask[]
}
----
[discrete]
[[client.cluster.postVotingConfigExclusions]]
== `client.cluster.postVotingConfigExclusions()`
Updates the cluster voting config exclusions by node ids or node names.
{ref}/voting-config-exclusions.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterPostVotingConfigExclusionsRequest, options?: TransportRequestOptions) => Promise<ClusterPostVotingConfigExclusionsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterPostVotingConfigExclusionsRequest extends <<RequestBase>> {
node_names?: <<Names>>
node_ids?: <<Ids>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterPostVotingConfigExclusionsResponse = boolean
----
[discrete]
[[client.cluster.putComponentTemplate]]
== `client.cluster.putComponentTemplate()`
Create or update a component template. Creates or updates a component template. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. An index template can be composed of multiple component templates. To use a component template, specify it in an index templates `composed_of` list. Component templates are only applied to new data streams and indices as part of a matching index template. Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. Component templates are only used during index creation. For data streams, this includes data stream creation and the creation of a streams backing indices. Changes to component templates do not affect existing indices, including a streams backing indices. You can use C-style `/* *\/` block comments in component templates. You can include comments anywhere in the request body except before the opening curly bracket.
{ref}/indices-component-template.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterPutComponentTemplateRequest, options?: TransportRequestOptions) => Promise<ClusterPutComponentTemplateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterPutComponentTemplateRequest extends <<RequestBase>> {
name: <<Name>>
create?: boolean
master_timeout?: <<Duration>>
template: <<IndicesIndexState>>
version?: <<VersionNumber>>
_meta?: <<Metadata>>
deprecated?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterPutComponentTemplateResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.cluster.putSettings]]
== `client.cluster.putSettings()`
Updates the cluster settings.
{ref}/cluster-update-settings.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterPutSettingsRequest, options?: TransportRequestOptions) => Promise<ClusterPutSettingsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterPutSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
persistent?: Record<string, any>
transient?: Record<string, any>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterPutSettingsResponse {
acknowledged: boolean
persistent: Record<string, any>
transient: Record<string, any>
}
----
[discrete]
[[client.cluster.remoteInfo]]
== `client.cluster.remoteInfo()`
The cluster remote info API allows you to retrieve all of the configured remote cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias.
{ref}/cluster-remote-info.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterRemoteInfoRequest, options?: TransportRequestOptions) => Promise<ClusterRemoteInfoResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterRemoteInfoRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterRemoteInfoResponse = Record<string, ClusterRemoteInfoClusterRemoteInfo>
----
[discrete]
[[client.cluster.reroute]]
== `client.cluster.reroute()`
Allows to manually change the allocation of individual shards in the cluster.
{ref}/cluster-reroute.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterRerouteRequest, options?: TransportRequestOptions) => Promise<ClusterRerouteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterRerouteRequest extends <<RequestBase>> {
dry_run?: boolean
explain?: boolean
metric?: <<Metrics>>
retry_failed?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
commands?: ClusterRerouteCommand[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterRerouteResponse {
acknowledged: boolean
explanations?: ClusterRerouteRerouteExplanation[]
state?: any
}
----
[discrete]
[[client.cluster.state]]
== `client.cluster.state()`
Returns a comprehensive information about the state of the cluster.
{ref}/cluster-state.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterStateRequest, options?: TransportRequestOptions) => Promise<ClusterStateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterStateRequest extends <<RequestBase>> {
metric?: <<Metrics>>
index?: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
flat_settings?: boolean
ignore_unavailable?: boolean
local?: boolean
master_timeout?: <<Duration>>
wait_for_metadata_version?: <<VersionNumber>>
wait_for_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterStateResponse = any
----
[discrete]
[[client.cluster.stats]]
== `client.cluster.stats()`
Returns cluster statistics. It returns basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).
{ref}/cluster-stats.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ClusterStatsRequest, options?: TransportRequestOptions) => Promise<ClusterStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ClusterStatsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
include_remotes?: boolean
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterStatsResponse = ClusterStatsStatsResponseBase
----

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,91 @@
[[reference-count]]
== client.count
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.count]]
== `client.count()`
Count search results. Get the number of documents matching a query.
{ref}/search-count.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CountRequest, options?: TransportRequestOptions) => Promise<CountResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CountRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
min_score?: <<double>>
preference?: string
routing?: <<Routing>>
terminate_after?: <<long>>
q?: string
query?: <<QueryDslQueryContainer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CountResponse {
count: <<long>>
_shards: <<ShardStatistics>>
}
----

View File

@ -0,0 +1,82 @@
[[reference-create]]
== client.create
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.create]]
== `client.create()`
Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
{ref}/docs-index_.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: CreateRequest, options?: TransportRequestOptions) => Promise<CreateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface CreateRequest<TDocument = unknown> extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
pipeline?: string
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
document?: TDocument
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CreateResponse = <<WriteResponseBase>>
----

View File

@ -0,0 +1,153 @@
[[reference-dangling_indices]]
== client.danglingIndices
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.danglingIndices.deleteDanglingIndex]]
== `client.danglingIndices.deleteDanglingIndex()`
Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
{ref}/modules-gateway-dangling-indices.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: DanglingIndicesDeleteDanglingIndexRequest, options?: TransportRequestOptions) => Promise<DanglingIndicesDeleteDanglingIndexResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface DanglingIndicesDeleteDanglingIndexRequest extends <<RequestBase>> {
index_uuid: <<Uuid>>
accept_data_loss: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type DanglingIndicesDeleteDanglingIndexResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.danglingIndices.importDanglingIndex]]
== `client.danglingIndices.importDanglingIndex()`
Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
{ref}/modules-gateway-dangling-indices.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: DanglingIndicesImportDanglingIndexRequest, options?: TransportRequestOptions) => Promise<DanglingIndicesImportDanglingIndexResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface DanglingIndicesImportDanglingIndexRequest extends <<RequestBase>> {
index_uuid: <<Uuid>>
accept_data_loss: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type DanglingIndicesImportDanglingIndexResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.danglingIndices.listDanglingIndices]]
== `client.danglingIndices.listDanglingIndices()`
Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete.
{ref}/modules-gateway-dangling-indices.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: DanglingIndicesListDanglingIndicesRequest, options?: TransportRequestOptions) => Promise<DanglingIndicesListDanglingIndicesResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface DanglingIndicesListDanglingIndicesRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface DanglingIndicesListDanglingIndicesResponse {
dangling_indices: DanglingIndicesListDanglingIndicesDanglingIndex[]
}
----

View File

@ -0,0 +1,82 @@
[[reference-delete]]
== client.delete
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.delete]]
== `client.delete()`
Delete a document. Removes a JSON document from the specified index.
{ref}/docs-delete.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: DeleteRequest, options?: TransportRequestOptions) => Promise<DeleteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface DeleteRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
if_primary_term?: <<long>>
if_seq_no?: <<SequenceNumber>>
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type DeleteResponse = <<WriteResponseBase>>
----

View File

@ -0,0 +1,121 @@
[[reference-delete_by_query]]
== client.deleteByQuery
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.deleteByQuery]]
== `client.deleteByQuery()`
Delete documents. Deletes documents that match the specified query.
{ref}/docs-delete-by-query.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: DeleteByQueryRequest, options?: TransportRequestOptions) => Promise<DeleteByQueryResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface DeleteByQueryRequest extends <<RequestBase>> {
index: <<Indices>>
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
conflicts?: <<Conflicts>>
default_operator?: <<QueryDslOperator>>
df?: string
expand_wildcards?: <<ExpandWildcards>>
from?: <<long>>
ignore_unavailable?: boolean
lenient?: boolean
preference?: string
refresh?: boolean
request_cache?: boolean
requests_per_second?: <<float>>
routing?: <<Routing>>
q?: string
scroll?: <<Duration>>
scroll_size?: <<long>>
search_timeout?: <<Duration>>
search_type?: <<SearchType>>
slices?: <<Slices>>
sort?: string[]
stats?: string[]
terminate_after?: <<long>>
timeout?: <<Duration>>
version?: boolean
wait_for_active_shards?: <<WaitForActiveShards>>
wait_for_completion?: boolean
max_docs?: <<long>>
query?: <<QueryDslQueryContainer>>
slice?: <<SlicedScroll>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface DeleteByQueryResponse {
batches?: <<long>>
deleted?: <<long>>
failures?: <<BulkIndexByScrollFailure>>[]
noops?: <<long>>
requests_per_second?: <<float>>
retries?: <<Retries>>
slice_id?: <<integer>>
task?: <<TaskId>>
throttled?: <<Duration>>
throttled_millis?: <<DurationValue>><<<UnitMillis>>>
throttled_until?: <<Duration>>
throttled_until_millis?: <<DurationValue>><<<UnitMillis>>>
timed_out?: boolean
took?: <<DurationValue>><<<UnitMillis>>>
total?: <<long>>
version_conflicts?: <<long>>
}
----

View File

@ -0,0 +1,74 @@
[[reference-delete_by_query_rethrottle]]
== client.deleteByQueryRethrottle
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.deleteByQueryRethrottle]]
== `client.deleteByQueryRethrottle()`
Throttle a delete by query operation. Change the number of requests per second for a particular delete by query operation. Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.
{ref}/docs-delete-by-query.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: DeleteByQueryRethrottleRequest, options?: TransportRequestOptions) => Promise<DeleteByQueryRethrottleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface DeleteByQueryRethrottleRequest extends <<RequestBase>> {
task_id: <<TaskId>>
requests_per_second?: <<float>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type DeleteByQueryRethrottleResponse = <<TasksTaskListResponseBase>>
----

View File

@ -0,0 +1,75 @@
[[reference-delete_script]]
== client.deleteScript
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.deleteScript]]
== `client.deleteScript()`
Delete a script or search template. Deletes a stored script or search template.
{ref}/modules-scripting.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: DeleteScriptRequest, options?: TransportRequestOptions) => Promise<DeleteScriptResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface DeleteScriptRequest extends <<RequestBase>> {
id: <<Id>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type DeleteScriptResponse = <<AcknowledgedResponseBase>>
----

View File

@ -0,0 +1,232 @@
[[reference-enrich]]
== client.enrich
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.enrich.deletePolicy]]
== `client.enrich.deletePolicy()`
Delete an enrich policy. Deletes an existing enrich policy and its enrich index.
{ref}/delete-enrich-policy-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EnrichDeletePolicyRequest, options?: TransportRequestOptions) => Promise<EnrichDeletePolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EnrichDeletePolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type EnrichDeletePolicyResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.enrich.executePolicy]]
== `client.enrich.executePolicy()`
Run an enrich policy. Create the enrich index for an existing enrich policy.
{ref}/execute-enrich-policy-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EnrichExecutePolicyRequest, options?: TransportRequestOptions) => Promise<EnrichExecutePolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EnrichExecutePolicyRequest extends <<RequestBase>> {
name: <<Name>>
wait_for_completion?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface EnrichExecutePolicyResponse {
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
task_id?: <<TaskId>>
}
----
[discrete]
[[client.enrich.getPolicy]]
== `client.enrich.getPolicy()`
Get an enrich policy. Returns information about an enrich policy.
{ref}/get-enrich-policy-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EnrichGetPolicyRequest, options?: TransportRequestOptions) => Promise<EnrichGetPolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EnrichGetPolicyRequest extends <<RequestBase>> {
name?: <<Names>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface EnrichGetPolicyResponse {
policies: <<EnrichSummary>>[]
}
----
[discrete]
[[client.enrich.putPolicy]]
== `client.enrich.putPolicy()`
Create an enrich policy. Creates an enrich policy.
{ref}/put-enrich-policy-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EnrichPutPolicyRequest, options?: TransportRequestOptions) => Promise<EnrichPutPolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EnrichPutPolicyRequest extends <<RequestBase>> {
name: <<Name>>
geo_match?: <<EnrichPolicy>>
match?: <<EnrichPolicy>>
range?: <<EnrichPolicy>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type EnrichPutPolicyResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.enrich.stats]]
== `client.enrich.stats()`
Get enrich stats. Returns enrich coordinator statistics and information about enrich policies that are currently executing.
{ref}/enrich-stats-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EnrichStatsRequest, options?: TransportRequestOptions) => Promise<EnrichStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EnrichStatsRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface EnrichStatsResponse {
coordinator_stats: EnrichStatsCoordinatorStats[]
executing_policies: EnrichStatsExecutingPolicy[]
cache_stats?: EnrichStatsCacheStats[]
}
----

211
docs/reference/eql.asciidoc Normal file
View File

@ -0,0 +1,211 @@
[[reference-eql]]
== client.eql
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.eql.delete]]
== `client.eql.delete()`
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]
=== Function signature
[source,ts]
----
(request: EqlDeleteRequest, options?: TransportRequestOptions) => Promise<EqlDeleteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EqlDeleteRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type EqlDeleteResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.eql.get]]
== `client.eql.get()`
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]
=== Function signature
[source,ts]
----
(request: EqlGetRequest, options?: TransportRequestOptions) => Promise<EqlGetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EqlGetRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
wait_for_completion_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type EqlGetResponse<TEvent = unknown> = <<EqlEqlSearchResponseBase>><TEvent>
----
[discrete]
[[client.eql.getStatus]]
== `client.eql.getStatus()`
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]
=== Function signature
[source,ts]
----
(request: EqlGetStatusRequest, options?: TransportRequestOptions) => Promise<EqlGetStatusResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EqlGetStatusRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface EqlGetStatusResponse {
id: <<Id>>
is_partial: boolean
is_running: boolean
start_time_in_millis?: <<EpochTime>><<<UnitMillis>>>
expiration_time_in_millis?: <<EpochTime>><<<UnitMillis>>>
completion_status?: <<integer>>
}
----
[discrete]
[[client.eql.search]]
== `client.eql.search()`
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]
=== Function signature
[source,ts]
----
(request: EqlSearchRequest, options?: TransportRequestOptions) => Promise<EqlSearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EqlSearchRequest extends <<RequestBase>> {
index: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
query: string
case_sensitive?: boolean
event_category_field?: <<Field>>
tiebreaker_field?: <<Field>>
timestamp_field?: <<Field>>
fetch_size?: <<uint>>
filter?: <<QueryDslQueryContainer>> | <<QueryDslQueryContainer>>[]
keep_alive?: <<Duration>>
keep_on_completion?: boolean
wait_for_completion_timeout?: <<Duration>>
size?: <<uint>>
fields?: <<QueryDslFieldAndFormat>> | <<Field>> | (<<QueryDslFieldAndFormat>> | <<Field>>)[]
result_position?: EqlSearchResultPosition
runtime_mappings?: <<MappingRuntimeFields>>
max_samples_per_key?: <<integer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type EqlSearchResponse<TEvent = unknown> = <<EqlEqlSearchResponseBase>><TEvent>
----

View File

@ -0,0 +1,112 @@
[[reference-esql]]
== client.esql
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.esql.asyncQuery]]
== `client.esql.asyncQuery()`
Executes an ESQL request asynchronously
{ref}/esql-async-query-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EsqlAsyncQueryRequest, options?: TransportRequestOptions) => Promise<EsqlAsyncQueryResponse>
----
[discrete]
[[client.esql.asyncQueryGet]]
== `client.esql.asyncQueryGet()`
Retrieves the results of a previously submitted async query request given its ID.
{ref}/esql-async-query-get-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EsqlAsyncQueryGetRequest, options?: TransportRequestOptions) => Promise<EsqlAsyncQueryGetResponse>
----
[discrete]
[[client.esql.query]]
== `client.esql.query()`
Run an ES|QL query. Get search results for an ES|QL (Elasticsearch query language) query.
{ref}/esql-rest.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: EsqlQueryRequest, options?: TransportRequestOptions) => Promise<EsqlQueryResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface EsqlQueryRequest extends <<RequestBase>> {
format?: EsqlQueryEsqlFormat
delimiter?: string
drop_null_columns?: boolean
columnar?: boolean
filter?: <<QueryDslQueryContainer>>
locale?: string
params?: <<FieldValue>>[]
profile?: boolean
query: string
tables?: Record<string, Record<string, <<EsqlTableValuesContainer>>>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type EsqlQueryResponse = <<EsqlColumns>>
----

View File

@ -0,0 +1,84 @@
[[reference-exists]]
== client.exists
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.exists]]
== `client.exists()`
Check a document. Checks if a specified document exists.
{ref}/docs-get.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ExistsRequest, options?: TransportRequestOptions) => Promise<ExistsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ExistsRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ExistsResponse = boolean
----

View File

@ -0,0 +1,83 @@
[[reference-exists_source]]
== client.existsSource
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.existsSource]]
== `client.existsSource()`
Check for a document source. Checks if a document's `_source` is stored.
{ref}/docs-get.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ExistsSourceRequest, options?: TransportRequestOptions) => Promise<ExistsSourceResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ExistsSourceRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ExistsSourceResponse = boolean
----

View File

@ -0,0 +1,93 @@
[[reference-explain]]
== client.explain
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.explain]]
== `client.explain()`
Explain a document match result. Returns information about why a specific document matches, or doesnt match, a query.
{ref}/search-explain.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ExplainRequest, options?: TransportRequestOptions) => Promise<ExplainResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ExplainRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
analyzer?: string
analyze_wildcard?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
lenient?: boolean
preference?: string
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
q?: string
query?: <<QueryDslQueryContainer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ExplainResponse<TDocument = unknown> {
_index: <<IndexName>>
_id: <<Id>>
matched: boolean
explanation?: <<ExplainExplanationDetail>>
get?: <<InlineGet>><TDocument>
}
----

View File

@ -0,0 +1,110 @@
[[reference-features]]
== client.features
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.features.getFeatures]]
== `client.features.getFeatures()`
Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot
{ref}/get-features-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: FeaturesGetFeaturesRequest, options?: TransportRequestOptions) => Promise<FeaturesGetFeaturesResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface FeaturesGetFeaturesRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface FeaturesGetFeaturesResponse {
features: <<FeaturesFeature>>[]
}
----
[discrete]
[[client.features.resetFeatures]]
== `client.features.resetFeatures()`
Resets the internal state of features, usually by deleting system indices
{ref}/modules-snapshots.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: FeaturesResetFeaturesRequest, options?: TransportRequestOptions) => Promise<FeaturesResetFeaturesResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface FeaturesResetFeaturesRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface FeaturesResetFeaturesResponse {
features: <<FeaturesFeature>>[]
}
----

View File

@ -0,0 +1,86 @@
[[reference-field_caps]]
== client.fieldCaps
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.fieldCaps]]
== `client.fieldCaps()`
Get the field capabilities. Get information about the capabilities of fields among multiple indices. For data streams, the API returns field capabilities among the streams backing indices. It returns runtime fields like any other field. For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family.
{ref}/search-field-caps.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: FieldCapsRequest, options?: TransportRequestOptions) => Promise<FieldCapsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface FieldCapsRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
include_unmapped?: boolean
filters?: string
types?: string[]
include_empty_fields?: boolean
fields?: <<Fields>>
index_filter?: <<QueryDslQueryContainer>>
runtime_mappings?: <<MappingRuntimeFields>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface FieldCapsResponse {
indices: <<Indices>>
fields: Record<<<Field>>, Record<string, <<FieldCapsFieldCapability>>>>
}
----

View File

@ -0,0 +1,243 @@
[[reference-fleet]]
== client.fleet
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.fleet.globalCheckpoints]]
== `client.fleet.globalCheckpoints()`
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]
=== Function signature
[source,ts]
----
(request: FleetGlobalCheckpointsRequest, options?: TransportRequestOptions) => Promise<FleetGlobalCheckpointsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface FleetGlobalCheckpointsRequest extends <<RequestBase>> {
index: <<IndexName>> | <<IndexAlias>>
wait_for_advance?: boolean
wait_for_index?: boolean
checkpoints?: <<FleetCheckpoint>>[]
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface FleetGlobalCheckpointsResponse {
global_checkpoints: <<FleetCheckpoint>>[]
timed_out: boolean
}
----
[discrete]
[[client.fleet.msearch]]
== `client.fleet.msearch()`
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
[source,ts]
----
(request: FleetMsearchRequest, options?: TransportRequestOptions) => Promise<FleetMsearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface FleetMsearchRequest extends <<RequestBase>> {
index?: <<IndexName>> | <<IndexAlias>>
allow_no_indices?: boolean
ccs_minimize_roundtrips?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
max_concurrent_searches?: <<long>>
max_concurrent_shard_requests?: <<long>>
pre_filter_shard_size?: <<long>>
search_type?: <<SearchType>>
rest_total_hits_as_int?: boolean
typed_keys?: boolean
wait_for_checkpoints?: <<FleetCheckpoint>>[]
allow_partial_search_results?: boolean
searches?: <<MsearchRequestItem>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface FleetMsearchResponse<TDocument = unknown> {
docs: <<MsearchResponseItem>><TDocument>[]
}
----
[discrete]
[[client.fleet.search]]
== `client.fleet.search()`
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
[source,ts]
----
(request: FleetSearchRequest, options?: TransportRequestOptions) => Promise<FleetSearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface FleetSearchRequest extends <<RequestBase>> {
index: <<IndexName>> | <<IndexAlias>>
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
batched_reduce_size?: <<long>>
ccs_minimize_roundtrips?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
max_concurrent_shard_requests?: <<long>>
preference?: string
pre_filter_shard_size?: <<long>>
request_cache?: boolean
routing?: <<Routing>>
scroll?: <<Duration>>
search_type?: <<SearchType>>
suggest_field?: <<Field>>
suggest_mode?: <<SuggestMode>>
suggest_size?: <<long>>
suggest_text?: string
typed_keys?: boolean
rest_total_hits_as_int?: boolean
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
q?: string
wait_for_checkpoints?: <<FleetCheckpoint>>[]
allow_partial_search_results?: boolean
aggregations?: Record<string, <<AggregationsAggregationContainer>>>
pass:[/**] @alias aggregations */
aggs?: Record<string, <<AggregationsAggregationContainer>>>
collapse?: <<SearchFieldCollapse>>
explain?: boolean
ext?: Record<string, any>
from?: <<integer>>
highlight?: <<SearchHighlight>>
track_total_hits?: <<SearchTrackHits>>
indices_boost?: Record<<<IndexName>>, <<double>>>[]
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
min_score?: <<double>>
post_filter?: <<QueryDslQueryContainer>>
profile?: boolean
query?: <<QueryDslQueryContainer>>
rescore?: <<SearchRescore>> | <<SearchRescore>>[]
script_fields?: Record<string, <<ScriptField>>>
search_after?: <<SortResults>>
size?: <<integer>>
slice?: <<SlicedScroll>>
sort?: <<Sort>>
_source?: <<SearchSourceConfig>>
fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
suggest?: <<SearchSuggester>>
terminate_after?: <<long>>
timeout?: string
track_scores?: boolean
version?: boolean
seq_no_primary_term?: boolean
stored_fields?: <<Fields>>
pit?: <<SearchPointInTimeReference>>
runtime_mappings?: <<MappingRuntimeFields>>
stats?: string[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface FleetSearchResponse<TDocument = unknown> {
took: <<long>>
timed_out: boolean
_shards: <<ShardStatistics>>
hits: <<SearchHitsMetadata>><TDocument>
aggregations?: Record<<<AggregateName>>, <<AggregationsAggregate>>>
_clusters?: <<ClusterStatistics>>
fields?: Record<string, any>
max_score?: <<double>>
num_reduce_phases?: <<long>>
profile?: <<SearchProfile>>
pit_id?: <<Id>>
_scroll_id?: <<ScrollId>>
suggest?: Record<<<SuggestionName>>, <<SearchSuggest>><TDocument>[]>
terminated_early?: boolean
}
----

View File

@ -0,0 +1,85 @@
[[reference-get]]
== client.get
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.get]]
== `client.get()`
Get a document by its ID. Retrieves the document with the specified ID from an index.
{ref}/docs-get.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: GetRequest, options?: TransportRequestOptions) => Promise<GetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface GetRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type GetResponse<TDocument = unknown> = <<GetGetResult>><TDocument>
----

View File

@ -0,0 +1,78 @@
[[reference-get_script]]
== client.getScript
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.getScript]]
== `client.getScript()`
Get a script or search template. Retrieves a stored script or search template.
{ref}/modules-scripting.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: GetScriptRequest, options?: TransportRequestOptions) => Promise<GetScriptResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface GetScriptRequest extends <<RequestBase>> {
id: <<Id>>
master_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface GetScriptResponse {
_id: <<Id>>
found: boolean
script?: <<StoredScript>>
}
----

View File

@ -0,0 +1,73 @@
[[reference-get_script_context]]
== client.getScriptContext
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.getScriptContext]]
== `client.getScriptContext()`
Get script contexts. Get a list of supported script contexts and their methods.
{painless}/painless-contexts.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: GetScriptContextRequest, options?: TransportRequestOptions) => Promise<GetScriptContextResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface GetScriptContextRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface GetScriptContextResponse {
contexts: <<GetScriptContextContext>>[]
}
----

View File

@ -0,0 +1,74 @@
[[reference-get_script_languages]]
== client.getScriptLanguages
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.getScriptLanguages]]
== `client.getScriptLanguages()`
Get script languages. Get a list of available script types, languages, and contexts.
{ref}/modules-scripting.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: GetScriptLanguagesRequest, options?: TransportRequestOptions) => Promise<GetScriptLanguagesResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface GetScriptLanguagesRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface GetScriptLanguagesResponse {
language_contexts: <<GetScriptLanguagesLanguageContext>>[]
types_allowed: string[]
}
----

View File

@ -0,0 +1,84 @@
[[reference-get_source]]
== client.getSource
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.getSource]]
== `client.getSource()`
Get a document's source. Returns the source of a document.
{ref}/docs-get.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: GetSourceRequest, options?: TransportRequestOptions) => Promise<GetSourceResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface GetSourceRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type GetSourceResponse<TDocument = unknown> = TDocument
----

View File

@ -0,0 +1,85 @@
[[reference-graph]]
== client.graph
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.graph.explore]]
== `client.graph.explore()`
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]
=== Function signature
[source,ts]
----
(request: GraphExploreRequest, options?: TransportRequestOptions) => Promise<GraphExploreResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface GraphExploreRequest extends <<RequestBase>> {
index: <<Indices>>
routing?: <<Routing>>
timeout?: <<Duration>>
connections?: <<GraphHop>>
controls?: <<GraphExploreControls>>
query?: <<QueryDslQueryContainer>>
vertices?: <<GraphVertexDefinition>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface GraphExploreResponse {
connections: <<GraphConnection>>[]
failures: <<ShardFailure>>[]
timed_out: boolean
took: <<long>>
vertices: <<GraphVertex>>[]
}
----

View File

@ -0,0 +1,80 @@
[[reference-health_report]]
== client.healthReport
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.healthReport]]
== `client.healthReport()`
Returns the health of the cluster.
{ref}/health-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: HealthReportRequest, options?: TransportRequestOptions) => Promise<HealthReportResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface HealthReportRequest extends <<RequestBase>> {
feature?: string | string[]
timeout?: <<Duration>>
verbose?: boolean
size?: <<integer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface HealthReportResponse {
cluster_name: string
indicators: <<HealthReportIndicators>>
status?: <<HealthReportIndicatorHealthStatus>>
}
----

473
docs/reference/ilm.asciidoc Normal file
View File

@ -0,0 +1,473 @@
[[reference-ilm]]
== client.ilm
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ilm.deleteLifecycle]]
== `client.ilm.deleteLifecycle()`
Deletes the specified lifecycle policy definition. You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.
{ref}/ilm-delete-lifecycle.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmDeleteLifecycleRequest, options?: TransportRequestOptions) => Promise<IlmDeleteLifecycleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmDeleteLifecycleRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IlmDeleteLifecycleResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ilm.explainLifecycle]]
== `client.ilm.explainLifecycle()`
Retrieves information about the indexs current lifecycle state, such as the currently executing phase, action, and step. Shows when the index entered each one, the definition of the running phase, and information about any failures.
{ref}/ilm-explain-lifecycle.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmExplainLifecycleRequest, options?: TransportRequestOptions) => Promise<IlmExplainLifecycleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmExplainLifecycleRequest extends <<RequestBase>> {
index: <<IndexName>>
only_errors?: boolean
only_managed?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IlmExplainLifecycleResponse {
indices: Record<<<IndexName>>, IlmExplainLifecycleLifecycleExplain>
}
----
[discrete]
[[client.ilm.getLifecycle]]
== `client.ilm.getLifecycle()`
Retrieves a lifecycle policy.
{ref}/ilm-get-lifecycle.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmGetLifecycleRequest, options?: TransportRequestOptions) => Promise<IlmGetLifecycleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmGetLifecycleRequest extends <<RequestBase>> {
name?: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IlmGetLifecycleResponse = Record<string, IlmGetLifecycleLifecycle>
----
[discrete]
[[client.ilm.getStatus]]
== `client.ilm.getStatus()`
Retrieves the current index lifecycle management (ILM) status.
{ref}/ilm-get-status.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmGetStatusRequest, options?: TransportRequestOptions) => Promise<IlmGetStatusResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmGetStatusRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IlmGetStatusResponse {
operation_mode: <<LifecycleOperationMode>>
}
----
[discrete]
[[client.ilm.migrateToDataTiers]]
== `client.ilm.migrateToDataTiers()`
Switches the indices, ILM policies, and legacy, composable and component templates from using custom node attributes and attribute-based allocation filters to using data tiers, and optionally deletes one legacy index template.+ Using node roles enables ILM to automatically move the indices between data tiers.
{ref}/ilm-migrate-to-data-tiers.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmMigrateToDataTiersRequest, options?: TransportRequestOptions) => Promise<IlmMigrateToDataTiersResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmMigrateToDataTiersRequest extends <<RequestBase>> {
dry_run?: boolean
legacy_template_to_delete?: string
node_attribute?: string
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IlmMigrateToDataTiersResponse {
dry_run: boolean
removed_legacy_template: string
migrated_ilm_policies: string[]
migrated_indices: <<Indices>>
migrated_legacy_templates: string[]
migrated_composable_templates: string[]
migrated_component_templates: string[]
}
----
[discrete]
[[client.ilm.moveToStep]]
== `client.ilm.moveToStep()`
Manually moves an index into the specified step and executes that step.
{ref}/ilm-move-to-step.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmMoveToStepRequest, options?: TransportRequestOptions) => Promise<IlmMoveToStepResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmMoveToStepRequest extends <<RequestBase>> {
index: <<IndexName>>
current_step: IlmMoveToStepStepKey
next_step: IlmMoveToStepStepKey
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IlmMoveToStepResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ilm.putLifecycle]]
== `client.ilm.putLifecycle()`
Creates a lifecycle policy. If the specified policy exists, the policy is replaced and the policy version is incremented.
{ref}/ilm-put-lifecycle.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmPutLifecycleRequest, options?: TransportRequestOptions) => Promise<IlmPutLifecycleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmPutLifecycleRequest extends <<RequestBase>> {
name: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
policy?: <<IlmPolicy>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IlmPutLifecycleResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ilm.removePolicy]]
== `client.ilm.removePolicy()`
Removes the assigned lifecycle policy and stops managing the specified index
{ref}/ilm-remove-policy.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmRemovePolicyRequest, options?: TransportRequestOptions) => Promise<IlmRemovePolicyResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmRemovePolicyRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IlmRemovePolicyResponse {
failed_indexes: <<IndexName>>[]
has_failures: boolean
}
----
[discrete]
[[client.ilm.retry]]
== `client.ilm.retry()`
Retries executing the policy for an index that is in the ERROR step.
{ref}/ilm-retry-policy.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmRetryRequest, options?: TransportRequestOptions) => Promise<IlmRetryResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmRetryRequest extends <<RequestBase>> {
index: <<IndexName>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IlmRetryResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ilm.start]]
== `client.ilm.start()`
Start the index lifecycle management (ILM) plugin.
{ref}/ilm-start.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmStartRequest, options?: TransportRequestOptions) => Promise<IlmStartResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmStartRequest extends <<RequestBase>> {
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IlmStartResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ilm.stop]]
== `client.ilm.stop()`
Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin
{ref}/ilm-stop.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IlmStopRequest, options?: TransportRequestOptions) => Promise<IlmStopResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IlmStopRequest extends <<RequestBase>> {
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IlmStopResponse = <<AcknowledgedResponseBase>>
----

View File

@ -0,0 +1,86 @@
[[reference-index]]
== client.index
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.index]]
== `client.index()`
Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
{ref}/docs-index_.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IndexRequest, options?: TransportRequestOptions) => Promise<IndexResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IndexRequest<TDocument = unknown> extends <<RequestBase>> {
id?: <<Id>>
index: <<IndexName>>
if_primary_term?: <<long>>
if_seq_no?: <<SequenceNumber>>
op_type?: <<OpType>>
pipeline?: string
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
require_alias?: boolean
document?: TDocument
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IndexResponse = <<WriteResponseBase>>
----

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,210 @@
[[reference-inference]]
== client.inference
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.inference.delete]]
== `client.inference.delete()`
Delete an inference endpoint
{ref}/delete-inference-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: InferenceDeleteRequest, options?: TransportRequestOptions) => Promise<InferenceDeleteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface InferenceDeleteRequest extends <<RequestBase>> {
task_type?: <<InferenceTaskType>>
inference_id: <<Id>>
dry_run?: boolean
force?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type InferenceDeleteResponse = <<InferenceDeleteInferenceEndpointResult>>
----
[discrete]
[[client.inference.get]]
== `client.inference.get()`
Get an inference endpoint
{ref}/get-inference-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: InferenceGetRequest, options?: TransportRequestOptions) => Promise<InferenceGetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface InferenceGetRequest extends <<RequestBase>> {
task_type?: <<InferenceTaskType>>
inference_id?: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface InferenceGetResponse {
endpoints: <<InferenceInferenceEndpointInfo>>[]
}
----
[discrete]
[[client.inference.inference]]
== `client.inference.inference()`
Perform inference on the service
{ref}/post-inference-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: InferenceInferenceRequest, options?: TransportRequestOptions) => Promise<InferenceInferenceResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface InferenceInferenceRequest extends <<RequestBase>> {
task_type?: <<InferenceTaskType>>
inference_id: <<Id>>
timeout?: <<Duration>>
query?: string
input: string | string[]
task_settings?: <<InferenceTaskSettings>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type InferenceInferenceResponse = <<InferenceInferenceResult>>
----
[discrete]
[[client.inference.put]]
== `client.inference.put()`
Create an inference endpoint
{ref}/put-inference-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: InferencePutRequest, options?: TransportRequestOptions) => Promise<InferencePutResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface InferencePutRequest extends <<RequestBase>> {
task_type?: <<InferenceTaskType>>
inference_id: <<Id>>
inference_config?: <<InferenceInferenceEndpoint>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type InferencePutResponse = <<InferenceInferenceEndpointInfo>>
----
[discrete]
[[client.inference.streamInference]]
== `client.inference.streamInference()`
Perform streaming inference
[discrete]
=== Function signature
[source,ts]
----
(request: InferenceStreamInferenceRequest, options?: TransportRequestOptions) => Promise<InferenceStreamInferenceResponse>
----

View File

@ -0,0 +1,77 @@
[[reference-info]]
== client.info
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.info]]
== `client.info()`
Get cluster info. Returns basic information about the cluster.
{ref}/index.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: InfoRequest, options?: TransportRequestOptions) => Promise<InfoResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface InfoRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface InfoResponse {
cluster_name: <<Name>>
cluster_uuid: <<Uuid>>
name: <<Name>>
tagline: string
version: <<ElasticsearchVersionInfo>>
}
----

View File

@ -0,0 +1,442 @@
[[reference-ingest]]
== client.ingest
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ingest.deleteGeoipDatabase]]
== `client.ingest.deleteGeoipDatabase()`
Delete GeoIP database configurations. Delete one or more IP geolocation database configurations.
{ref}/delete-geoip-database-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IngestDeleteGeoipDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestDeleteGeoipDatabaseResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestDeleteGeoipDatabaseRequest extends <<RequestBase>> {
id: <<Ids>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
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()`
Delete pipelines. Delete one or more ingest pipelines.
{ref}/delete-pipeline-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IngestDeletePipelineRequest, options?: TransportRequestOptions) => Promise<IngestDeletePipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestDeletePipelineRequest extends <<RequestBase>> {
id: <<Id>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IngestDeletePipelineResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ingest.geoIpStats]]
== `client.ingest.geoIpStats()`
Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used with the GeoIP processor.
{ref}/geoip-processor.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IngestGeoIpStatsRequest, options?: TransportRequestOptions) => Promise<IngestGeoIpStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestGeoIpStatsRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IngestGeoIpStatsResponse {
stats: IngestGeoIpStatsGeoIpDownloadStatistics
nodes: Record<<<Id>>, IngestGeoIpStatsGeoIpNodeDatabases>
}
----
[discrete]
[[client.ingest.getGeoipDatabase]]
== `client.ingest.getGeoipDatabase()`
Get GeoIP database configurations. Get information about one or more IP geolocation database configurations.
{ref}/get-geoip-database-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IngestGetGeoipDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestGetGeoipDatabaseResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestGetGeoipDatabaseRequest extends <<RequestBase>> {
id?: <<Ids>>
master_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IngestGetGeoipDatabaseResponse {
databases: IngestGetGeoipDatabaseDatabaseConfigurationMetadata[]
}
----
[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()`
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]
=== Function signature
[source,ts]
----
(request: IngestGetPipelineRequest, options?: TransportRequestOptions) => Promise<IngestGetPipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestGetPipelineRequest extends <<RequestBase>> {
id?: <<Id>>
master_timeout?: <<Duration>>
summary?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IngestGetPipelineResponse = Record<string, <<IngestPipeline>>>
----
[discrete]
[[client.ingest.processorGrok]]
== `client.ingest.processorGrok()`
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]
=== Function signature
[source,ts]
----
(request: IngestProcessorGrokRequest, options?: TransportRequestOptions) => Promise<IngestProcessorGrokResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestProcessorGrokRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IngestProcessorGrokResponse {
patterns: Record<string, string>
}
----
[discrete]
[[client.ingest.putGeoipDatabase]]
== `client.ingest.putGeoipDatabase()`
Create or update GeoIP database configurations. Create or update IP geolocation database configurations.
{ref}/put-geoip-database-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IngestPutGeoipDatabaseRequest, options?: TransportRequestOptions) => Promise<IngestPutGeoipDatabaseResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestPutGeoipDatabaseRequest extends <<RequestBase>> {
id: <<Id>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
name: <<Name>>
maxmind: <<IngestMaxmind>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
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()`
Create or update a pipeline. Changes made using this API take effect immediately.
{ref}/ingest.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: IngestPutPipelineRequest, options?: TransportRequestOptions) => Promise<IngestPutPipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestPutPipelineRequest extends <<RequestBase>> {
id: <<Id>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
if_version?: <<VersionNumber>>
_meta?: <<Metadata>>
description?: string
on_failure?: <<IngestProcessorContainer>>[]
processors?: <<IngestProcessorContainer>>[]
version?: <<VersionNumber>>
deprecated?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type IngestPutPipelineResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.ingest.simulate]]
== `client.ingest.simulate()`
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]
=== Function signature
[source,ts]
----
(request: IngestSimulateRequest, options?: TransportRequestOptions) => Promise<IngestSimulateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface IngestSimulateRequest extends <<RequestBase>> {
id?: <<Id>>
verbose?: boolean
docs: IngestSimulateDocument[]
pipeline?: <<IngestPipeline>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface IngestSimulateResponse {
docs: IngestSimulateSimulateDocumentResult[]
}
----

View File

@ -0,0 +1,87 @@
[[reference-knn_search]]
== client.knnSearch
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.knnSearch]]
== `client.knnSearch()`
Run a knn search. NOTE: The kNN search API has been replaced by the `knn` option in the search API. Perform a k-nearest neighbor (kNN) search on a dense_vector field and return the matching documents. Given a query vector, the API finds the k closest vectors and returns those documents as search hits. Elasticsearch uses the HNSW algorithm to support efficient kNN search. Like most kNN algorithms, HNSW is an approximate method that sacrifices result accuracy for improved search speed. This means the results returned are not always the true k closest neighbors. The kNN search API supports restricting the search using a filter. The search will return the top k documents that also match the filter query.
{ref}/search-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: KnnSearchRequest, options?: TransportRequestOptions) => Promise<KnnSearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface KnnSearchRequest extends <<RequestBase>> {
index: <<Indices>>
routing?: <<Routing>>
_source?: <<SearchSourceConfig>>
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
stored_fields?: <<Fields>>
fields?: <<Fields>>
filter?: <<QueryDslQueryContainer>> | <<QueryDslQueryContainer>>[]
knn: <<KnnSearchQuery>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface KnnSearchResponse<TDocument = unknown> {
took: <<long>>
timed_out: boolean
_shards: <<ShardStatistics>>
hits: <<SearchHitsMetadata>><TDocument>
fields?: Record<string, any>
max_score?: <<double>>
}
----

View File

@ -0,0 +1,314 @@
[[reference-license]]
== client.license
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.license.delete]]
== `client.license.delete()`
Deletes licensing information for the cluster
{ref}/delete-license.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LicenseDeleteRequest, options?: TransportRequestOptions) => Promise<LicenseDeleteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LicenseDeleteRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type LicenseDeleteResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.license.get]]
== `client.license.get()`
Get license information. Returns information about your Elastic license, including its type, its status, when it was issued, and when it expires. For more information about the different types of licenses, refer to [Elastic Stack subscriptions](https://www.elastic.co/subscriptions).
{ref}/get-license.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LicenseGetRequest, options?: TransportRequestOptions) => Promise<LicenseGetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LicenseGetRequest extends <<RequestBase>> {
accept_enterprise?: boolean
local?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface LicenseGetResponse {
license: LicenseGetLicenseInformation
}
----
[discrete]
[[client.license.getBasicStatus]]
== `client.license.getBasicStatus()`
Retrieves information about the status of the basic license.
{ref}/get-basic-status.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LicenseGetBasicStatusRequest, options?: TransportRequestOptions) => Promise<LicenseGetBasicStatusResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LicenseGetBasicStatusRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface LicenseGetBasicStatusResponse {
eligible_to_start_basic: boolean
}
----
[discrete]
[[client.license.getTrialStatus]]
== `client.license.getTrialStatus()`
Retrieves information about the status of the trial license.
{ref}/get-trial-status.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LicenseGetTrialStatusRequest, options?: TransportRequestOptions) => Promise<LicenseGetTrialStatusResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LicenseGetTrialStatusRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface LicenseGetTrialStatusResponse {
eligible_to_start_trial: boolean
}
----
[discrete]
[[client.license.post]]
== `client.license.post()`
Updates the license for the cluster.
{ref}/update-license.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LicensePostRequest, options?: TransportRequestOptions) => Promise<LicensePostResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LicensePostRequest extends <<RequestBase>> {
acknowledge?: boolean
license?: <<LicenseLicense>>
licenses?: <<LicenseLicense>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface LicensePostResponse {
acknowledge?: LicensePostAcknowledgement
acknowledged: boolean
license_status: <<LicenseLicenseStatus>>
}
----
[discrete]
[[client.license.postStartBasic]]
== `client.license.postStartBasic()`
The start basic API enables you to initiate an indefinite basic license, which gives access to all the basic features. If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. You must then re-submit the API request with the acknowledge parameter set to true. To check the status of your basic license, use the following API: [Get basic status](https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html).
{ref}/start-basic.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LicensePostStartBasicRequest, options?: TransportRequestOptions) => Promise<LicensePostStartBasicResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LicensePostStartBasicRequest extends <<RequestBase>> {
acknowledge?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface LicensePostStartBasicResponse {
acknowledged: boolean
basic_was_started: boolean
error_message?: string
type?: <<LicenseLicenseType>>
acknowledge?: Record<string, string | string[]>
}
----
[discrete]
[[client.license.postStartTrial]]
== `client.license.postStartTrial()`
The start trial API enables you to start a 30-day trial, which gives access to all subscription features.
{ref}/start-trial.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LicensePostStartTrialRequest, options?: TransportRequestOptions) => Promise<LicensePostStartTrialResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LicensePostStartTrialRequest extends <<RequestBase>> {
acknowledge?: boolean
type_query_string?: string
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface LicensePostStartTrialResponse {
acknowledged: boolean
error_message?: string
trial_was_started: boolean
type?: <<LicenseLicenseType>>
}
----

View File

@ -0,0 +1,148 @@
[[reference-logstash]]
== client.logstash
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.logstash.deletePipeline]]
== `client.logstash.deletePipeline()`
Deletes a pipeline used for Logstash Central Management.
{ref}/logstash-api-delete-pipeline.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LogstashDeletePipelineRequest, options?: TransportRequestOptions) => Promise<LogstashDeletePipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LogstashDeletePipelineRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type LogstashDeletePipelineResponse = boolean
----
[discrete]
[[client.logstash.getPipeline]]
== `client.logstash.getPipeline()`
Retrieves pipelines used for Logstash Central Management.
{ref}/logstash-api-get-pipeline.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LogstashGetPipelineRequest, options?: TransportRequestOptions) => Promise<LogstashGetPipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LogstashGetPipelineRequest extends <<RequestBase>> {
id?: <<Ids>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type LogstashGetPipelineResponse = Record<<<Id>>, <<LogstashPipeline>>>
----
[discrete]
[[client.logstash.putPipeline]]
== `client.logstash.putPipeline()`
Creates or updates a pipeline used for Logstash Central Management.
{ref}/logstash-api-put-pipeline.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: LogstashPutPipelineRequest, options?: TransportRequestOptions) => Promise<LogstashPutPipelineResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface LogstashPutPipelineRequest extends <<RequestBase>> {
id: <<Id>>
pipeline?: <<LogstashPipeline>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type LogstashPutPipelineResponse = boolean
----

View File

@ -0,0 +1,209 @@
[[api-reference]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
= API Reference
* <<reference-async_search,client.asyncSearch>>
* <<reference-autoscaling,client.autoscaling>>
* <<reference-bulk,client.bulk>>
* <<reference-cat,client.cat>>
* <<reference-ccr,client.ccr>>
* <<reference-clear_scroll,client.clearScroll>>
* <<reference-close_point_in_time,client.closePointInTime>>
* <<reference-cluster,client.cluster>>
* <<reference-connector,client.connector>>
* <<reference-count,client.count>>
* <<reference-create,client.create>>
* <<reference-dangling_indices,client.danglingIndices>>
* <<reference-delete,client.delete>>
* <<reference-delete_by_query,client.deleteByQuery>>
* <<reference-delete_by_query_rethrottle,client.deleteByQueryRethrottle>>
* <<reference-delete_script,client.deleteScript>>
* <<reference-enrich,client.enrich>>
* <<reference-eql,client.eql>>
* <<reference-esql,client.esql>>
* <<reference-exists,client.exists>>
* <<reference-exists_source,client.existsSource>>
* <<reference-explain,client.explain>>
* <<reference-features,client.features>>
* <<reference-field_caps,client.fieldCaps>>
* <<reference-fleet,client.fleet>>
* <<reference-get,client.get>>
* <<reference-get_script,client.getScript>>
* <<reference-get_script_context,client.getScriptContext>>
* <<reference-get_script_languages,client.getScriptLanguages>>
* <<reference-get_source,client.getSource>>
* <<reference-graph,client.graph>>
* <<reference-health_report,client.healthReport>>
* <<reference-ilm,client.ilm>>
* <<reference-index,client.index>>
* <<reference-indices,client.indices>>
* <<reference-inference,client.inference>>
* <<reference-info,client.info>>
* <<reference-ingest,client.ingest>>
* <<reference-knn_search,client.knnSearch>>
* <<reference-license,client.license>>
* <<reference-logstash,client.logstash>>
* <<reference-mget,client.mget>>
* <<reference-migration,client.migration>>
* <<reference-ml,client.ml>>
* <<reference-monitoring,client.monitoring>>
* <<reference-msearch,client.msearch>>
* <<reference-msearch_template,client.msearchTemplate>>
* <<reference-mtermvectors,client.mtermvectors>>
* <<reference-nodes,client.nodes>>
* <<reference-open_point_in_time,client.openPointInTime>>
* <<reference-ping,client.ping>>
* <<reference-put_script,client.putScript>>
* <<reference-query_rules,client.queryRules>>
* <<reference-rank_eval,client.rankEval>>
* <<reference-reindex,client.reindex>>
* <<reference-reindex_rethrottle,client.reindexRethrottle>>
* <<reference-render_search_template,client.renderSearchTemplate>>
* <<reference-rollup,client.rollup>>
* <<reference-scripts_painless_execute,client.scriptsPainlessExecute>>
* <<reference-scroll,client.scroll>>
* <<reference-search,client.search>>
* <<reference-search_application,client.searchApplication>>
* <<reference-search_mvt,client.searchMvt>>
* <<reference-search_shards,client.searchShards>>
* <<reference-search_template,client.searchTemplate>>
* <<reference-searchable_snapshots,client.searchableSnapshots>>
* <<reference-security,client.security>>
* <<reference-shutdown,client.shutdown>>
* <<reference-simulate,client.simulate>>
* <<reference-slm,client.slm>>
* <<reference-snapshot,client.snapshot>>
* <<reference-sql,client.sql>>
* <<reference-ssl,client.ssl>>
* <<reference-synonyms,client.synonyms>>
* <<reference-tasks,client.tasks>>
* <<reference-terms_enum,client.termsEnum>>
* <<reference-termvectors,client.termvectors>>
* <<reference-text_structure,client.textStructure>>
* <<reference-transform,client.transform>>
* <<reference-update,client.update>>
* <<reference-update_by_query,client.updateByQuery>>
* <<reference-update_by_query_rethrottle,client.updateByQueryRethrottle>>
* <<reference-watcher,client.watcher>>
* <<reference-xpack,client.xpack>>
include::async_search.asciidoc[]
include::autoscaling.asciidoc[]
include::bulk.asciidoc[]
include::cat.asciidoc[]
include::ccr.asciidoc[]
include::clear_scroll.asciidoc[]
include::close_point_in_time.asciidoc[]
include::cluster.asciidoc[]
include::connector.asciidoc[]
include::count.asciidoc[]
include::create.asciidoc[]
include::dangling_indices.asciidoc[]
include::delete.asciidoc[]
include::delete_by_query.asciidoc[]
include::delete_by_query_rethrottle.asciidoc[]
include::delete_script.asciidoc[]
include::enrich.asciidoc[]
include::eql.asciidoc[]
include::esql.asciidoc[]
include::exists.asciidoc[]
include::exists_source.asciidoc[]
include::explain.asciidoc[]
include::features.asciidoc[]
include::field_caps.asciidoc[]
include::fleet.asciidoc[]
include::get.asciidoc[]
include::get_script.asciidoc[]
include::get_script_context.asciidoc[]
include::get_script_languages.asciidoc[]
include::get_source.asciidoc[]
include::graph.asciidoc[]
include::health_report.asciidoc[]
include::ilm.asciidoc[]
include::index.asciidoc[]
include::indices.asciidoc[]
include::inference.asciidoc[]
include::info.asciidoc[]
include::ingest.asciidoc[]
include::knn_search.asciidoc[]
include::license.asciidoc[]
include::logstash.asciidoc[]
include::mget.asciidoc[]
include::migration.asciidoc[]
include::ml.asciidoc[]
include::monitoring.asciidoc[]
include::msearch.asciidoc[]
include::msearch_template.asciidoc[]
include::mtermvectors.asciidoc[]
include::nodes.asciidoc[]
include::open_point_in_time.asciidoc[]
include::ping.asciidoc[]
include::put_script.asciidoc[]
include::query_rules.asciidoc[]
include::rank_eval.asciidoc[]
include::reindex.asciidoc[]
include::reindex_rethrottle.asciidoc[]
include::render_search_template.asciidoc[]
include::rollup.asciidoc[]
include::scripts_painless_execute.asciidoc[]
include::scroll.asciidoc[]
include::search.asciidoc[]
include::search_application.asciidoc[]
include::search_mvt.asciidoc[]
include::search_shards.asciidoc[]
include::search_template.asciidoc[]
include::searchable_snapshots.asciidoc[]
include::security.asciidoc[]
include::shutdown.asciidoc[]
include::simulate.asciidoc[]
include::slm.asciidoc[]
include::snapshot.asciidoc[]
include::sql.asciidoc[]
include::ssl.asciidoc[]
include::synonyms.asciidoc[]
include::tasks.asciidoc[]
include::terms_enum.asciidoc[]
include::termvectors.asciidoc[]
include::text_structure.asciidoc[]
include::transform.asciidoc[]
include::update.asciidoc[]
include::update_by_query.asciidoc[]
include::update_by_query_rethrottle.asciidoc[]
include::watcher.asciidoc[]
include::xpack.asciidoc[]
include::shared-types/index.asciidoc[]

View File

@ -0,0 +1,86 @@
[[reference-mget]]
== client.mget
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.mget]]
== `client.mget()`
Get multiple documents. Get multiple JSON documents by ID from one or more indices. If you specify an index in the request URI, you only need to specify the document IDs in the request body. To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail.
{ref}/docs-multi-get.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MgetRequest, options?: TransportRequestOptions) => Promise<MgetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MgetRequest extends <<RequestBase>> {
index?: <<IndexName>>
force_synthetic_source?: boolean
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
docs?: <<MgetOperation>>[]
ids?: <<Ids>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface MgetResponse<TDocument = unknown> {
docs: <<MgetResponseItem>><TDocument>[]
}
----

View File

@ -0,0 +1,155 @@
[[reference-migration]]
== client.migration
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.migration.deprecations]]
== `client.migration.deprecations()`
Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.
{ref}/migration-api-deprecation.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MigrationDeprecationsRequest, options?: TransportRequestOptions) => Promise<MigrationDeprecationsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MigrationDeprecationsRequest extends <<RequestBase>> {
index?: <<IndexName>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface MigrationDeprecationsResponse {
cluster_settings: MigrationDeprecationsDeprecation[]
index_settings: Record<string, MigrationDeprecationsDeprecation[]>
data_streams: Record<string, MigrationDeprecationsDeprecation[]>
node_settings: MigrationDeprecationsDeprecation[]
ml_settings: MigrationDeprecationsDeprecation[]
}
----
[discrete]
[[client.migration.getFeatureUpgradeStatus]]
== `client.migration.getFeatureUpgradeStatus()`
Find out whether system features need to be upgraded or not
{ref}/migration-api-feature-upgrade.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MigrationGetFeatureUpgradeStatusRequest, options?: TransportRequestOptions) => Promise<MigrationGetFeatureUpgradeStatusResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MigrationGetFeatureUpgradeStatusRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface MigrationGetFeatureUpgradeStatusResponse {
features: MigrationGetFeatureUpgradeStatusMigrationFeature[]
migration_status: MigrationGetFeatureUpgradeStatusMigrationStatus
}
----
[discrete]
[[client.migration.postFeatureUpgrade]]
== `client.migration.postFeatureUpgrade()`
Begin upgrades for system features
{ref}/migration-api-feature-upgrade.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MigrationPostFeatureUpgradeRequest, options?: TransportRequestOptions) => Promise<MigrationPostFeatureUpgradeResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MigrationPostFeatureUpgradeRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface MigrationPostFeatureUpgradeResponse {
accepted: boolean
features: MigrationPostFeatureUpgradeMigrationFeature[]
}
----

3200
docs/reference/ml.asciidoc Normal file

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,82 @@
[[reference-monitoring]]
== client.monitoring
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.monitoring.bulk]]
== `client.monitoring.bulk()`
Used by the monitoring features to send monitoring data.
{ref}/monitor-elasticsearch-cluster.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MonitoringBulkRequest, options?: TransportRequestOptions) => Promise<MonitoringBulkResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MonitoringBulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
type?: string
system_id: string
system_api_version: string
interval: <<Duration>>
operations?: (<<BulkOperationContainer>> | <<BulkUpdateAction>><TDocument, TPartialDocument> | TDocument)[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface MonitoringBulkResponse {
error?: <<ErrorCause>>
errors: boolean
ignored: boolean
took: <<long>>
}
----

View File

@ -0,0 +1,87 @@
[[reference-msearch]]
== client.msearch
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.msearch]]
== `client.msearch()`
Run multiple searches. The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. The structure is as follows: ``` header\n body\n header\n body\n ``` This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. IMPORTANT: The final line of data must end with a newline character `\n`. Each newline character may be preceded by a carriage return `\r`. When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`.
{ref}/search-multi-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MsearchRequest, options?: TransportRequestOptions) => Promise<MsearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MsearchRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
ccs_minimize_roundtrips?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
include_named_queries_score?: boolean
max_concurrent_searches?: <<long>>
max_concurrent_shard_requests?: <<long>>
pre_filter_shard_size?: <<long>>
rest_total_hits_as_int?: boolean
routing?: <<Routing>>
search_type?: <<SearchType>>
typed_keys?: boolean
searches?: <<MsearchRequestItem>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type MsearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<MsearchMultiSearchResult>><TDocument, TAggregations>
----

View File

@ -0,0 +1,79 @@
[[reference-msearch_template]]
== client.msearchTemplate
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.msearchTemplate]]
== `client.msearchTemplate()`
Run multiple templated searches.
{ref}/search-multi-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MsearchTemplateRequest, options?: TransportRequestOptions) => Promise<MsearchTemplateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MsearchTemplateRequest extends <<RequestBase>> {
index?: <<Indices>>
ccs_minimize_roundtrips?: boolean
max_concurrent_searches?: <<long>>
search_type?: <<SearchType>>
rest_total_hits_as_int?: boolean
typed_keys?: boolean
search_templates?: <<MsearchTemplateRequestItem>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type MsearchTemplateResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<MsearchMultiSearchResult>><TDocument, TAggregations>
----

View File

@ -0,0 +1,88 @@
[[reference-mtermvectors]]
== client.mtermvectors
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.mtermvectors]]
== `client.mtermvectors()`
Get multiple term vectors. You can specify existing documents by index and ID or provide artificial documents in the body of the request. You can specify the index in the request body or request URI. The response contains a `docs` array with all the fetched termvectors. Each element has the structure provided by the termvectors API.
{ref}/docs-multi-termvectors.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: MtermvectorsRequest, options?: TransportRequestOptions) => Promise<MtermvectorsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface MtermvectorsRequest extends <<RequestBase>> {
index?: <<IndexName>>
fields?: <<Fields>>
field_statistics?: boolean
offsets?: boolean
payloads?: boolean
positions?: boolean
preference?: string
realtime?: boolean
routing?: <<Routing>>
term_statistics?: boolean
version?: <<VersionNumber>>
version_type?: <<VersionType>>
docs?: <<MtermvectorsOperation>>[]
ids?: <<Id>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface MtermvectorsResponse {
docs: <<MtermvectorsTermVectorsResult>>[]
}
----

View File

@ -0,0 +1,324 @@
[[reference-nodes]]
== client.nodes
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.nodes.clearRepositoriesMeteringArchive]]
== `client.nodes.clearRepositoriesMeteringArchive()`
You can use this API to clear the archived repositories metering information in the cluster.
{ref}/clear-repositories-metering-archive-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: NodesClearRepositoriesMeteringArchiveRequest, options?: TransportRequestOptions) => Promise<NodesClearRepositoriesMeteringArchiveResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface NodesClearRepositoriesMeteringArchiveRequest extends <<RequestBase>> {
node_id: <<NodeIds>>
max_archive_version: <<long>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type NodesClearRepositoriesMeteringArchiveResponse = NodesClearRepositoriesMeteringArchiveResponseBase
----
[discrete]
[[client.nodes.getRepositoriesMeteringInfo]]
== `client.nodes.getRepositoriesMeteringInfo()`
You can use the cluster repositories metering API to retrieve repositories metering information in a cluster. This API exposes monotonically non-decreasing counters and its expected that clients would durably store the information needed to compute aggregations over a period of time. Additionally, the information exposed by this API is volatile, meaning that it wont be present after node restarts.
{ref}/get-repositories-metering-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: NodesGetRepositoriesMeteringInfoRequest, options?: TransportRequestOptions) => Promise<NodesGetRepositoriesMeteringInfoResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface NodesGetRepositoriesMeteringInfoRequest extends <<RequestBase>> {
node_id: <<NodeIds>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type NodesGetRepositoriesMeteringInfoResponse = NodesGetRepositoriesMeteringInfoResponseBase
----
[discrete]
[[client.nodes.hotThreads]]
== `client.nodes.hotThreads()`
This API yields a breakdown of the hot threads on each selected node in the cluster. The output is plain text with a breakdown of each nodes top hot threads.
{ref}/cluster-nodes-hot-threads.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: NodesHotThreadsRequest, options?: TransportRequestOptions) => Promise<NodesHotThreadsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface NodesHotThreadsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
ignore_idle_threads?: boolean
interval?: <<Duration>>
snapshots?: <<long>>
master_timeout?: <<Duration>>
threads?: <<long>>
timeout?: <<Duration>>
type?: <<ThreadType>>
sort?: <<ThreadType>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface NodesHotThreadsResponse {}
----
[discrete]
[[client.nodes.info]]
== `client.nodes.info()`
Returns cluster nodes information.
{ref}/cluster-nodes-info.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: NodesInfoRequest, options?: TransportRequestOptions) => Promise<NodesInfoResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface NodesInfoRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
metric?: <<Metrics>>
flat_settings?: boolean
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type NodesInfoResponse = NodesInfoResponseBase
----
[discrete]
[[client.nodes.reloadSecureSettings]]
== `client.nodes.reloadSecureSettings()`
Reloads the keystore on nodes in the cluster.
{ref}/secure-settings.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: NodesReloadSecureSettingsRequest, options?: TransportRequestOptions) => Promise<NodesReloadSecureSettingsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface NodesReloadSecureSettingsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
timeout?: <<Duration>>
secure_settings_password?: <<Password>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type NodesReloadSecureSettingsResponse = NodesReloadSecureSettingsResponseBase
----
[discrete]
[[client.nodes.stats]]
== `client.nodes.stats()`
Returns cluster nodes statistics.
{ref}/cluster-nodes-stats.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: NodesStatsRequest, options?: TransportRequestOptions) => Promise<NodesStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface NodesStatsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
metric?: <<Metrics>>
index_metric?: <<Metrics>>
completion_fields?: <<Fields>>
fielddata_fields?: <<Fields>>
fields?: <<Fields>>
groups?: boolean
include_segment_file_sizes?: boolean
level?: <<Level>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
types?: string[]
include_unloaded_segments?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type NodesStatsResponse = NodesStatsResponseBase
----
[discrete]
[[client.nodes.usage]]
== `client.nodes.usage()`
Returns information on the usage of features.
{ref}/cluster-nodes-usage.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: NodesUsageRequest, options?: TransportRequestOptions) => Promise<NodesUsageResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface NodesUsageRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
metric?: <<Metrics>>
timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type NodesUsageResponse = NodesUsageResponseBase
----

View File

@ -0,0 +1,83 @@
[[reference-open_point_in_time]]
== client.openPointInTime
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.openPointInTime]]
== `client.openPointInTime()`
Open a point in time. A search request by default runs against the most recent visible data of the target indices, which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the state of the data as it existed when initiated. In some cases, its preferred to perform multiple search requests using the same point in time. For example, if refreshes happen between `search_after` requests, then the results of those requests might not be consistent as changes happening between searches are only visible to the more recent point in time. A point in time must be opened explicitly before being used in search requests. The `keep_alive` parameter tells Elasticsearch how long it should persist.
{ref}/point-in-time-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: OpenPointInTimeRequest, options?: TransportRequestOptions) => Promise<OpenPointInTimeResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface OpenPointInTimeRequest extends <<RequestBase>> {
index: <<Indices>>
keep_alive: <<Duration>>
ignore_unavailable?: boolean
preference?: string
routing?: <<Routing>>
expand_wildcards?: <<ExpandWildcards>>
allow_partial_search_results?: boolean
index_filter?: <<QueryDslQueryContainer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface OpenPointInTimeResponse {
_shards: <<ShardStatistics>>
id: <<Id>>
}
----

View File

@ -0,0 +1,71 @@
[[reference-ping]]
== client.ping
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ping]]
== `client.ping()`
Ping the cluster. Returns whether the cluster is running.
{ref}/index.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: PingRequest, options?: TransportRequestOptions) => Promise<PingResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface PingRequest extends <<RequestBase>> {}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type PingResponse = boolean
----

View File

@ -0,0 +1,77 @@
[[reference-put_script]]
== client.putScript
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.putScript]]
== `client.putScript()`
Create or update a script or search template. Creates or updates a stored script or search template.
{ref}/modules-scripting.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: PutScriptRequest, options?: TransportRequestOptions) => Promise<PutScriptResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface PutScriptRequest extends <<RequestBase>> {
id: <<Id>>
context?: <<Name>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
script: <<StoredScript>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type PutScriptResponse = <<AcknowledgedResponseBase>>
----

View File

@ -0,0 +1,352 @@
[[reference-query_rules]]
== client.queryRules
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.queryRules.deleteRule]]
== `client.queryRules.deleteRule()`
Delete a query rule. Delete a query rule within a query ruleset.
{ref}/delete-query-rule.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: QueryRulesDeleteRuleRequest, options?: TransportRequestOptions) => Promise<QueryRulesDeleteRuleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesDeleteRuleRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
rule_id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type QueryRulesDeleteRuleResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.queryRules.deleteRuleset]]
== `client.queryRules.deleteRuleset()`
Delete a query ruleset.
{ref}/delete-query-ruleset.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: QueryRulesDeleteRulesetRequest, options?: TransportRequestOptions) => Promise<QueryRulesDeleteRulesetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesDeleteRulesetRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type QueryRulesDeleteRulesetResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.queryRules.getRule]]
== `client.queryRules.getRule()`
Get a query rule. Get details about a query rule within a query ruleset.
{ref}/get-query-rule.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: QueryRulesGetRuleRequest, options?: TransportRequestOptions) => Promise<QueryRulesGetRuleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesGetRuleRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
rule_id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type QueryRulesGetRuleResponse = <<QueryRulesQueryRule>>
----
[discrete]
[[client.queryRules.getRuleset]]
== `client.queryRules.getRuleset()`
Get a query ruleset. Get details about a query ruleset.
{ref}/get-query-ruleset.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: QueryRulesGetRulesetRequest, options?: TransportRequestOptions) => Promise<QueryRulesGetRulesetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesGetRulesetRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type QueryRulesGetRulesetResponse = <<QueryRulesQueryRuleset>>
----
[discrete]
[[client.queryRules.listRulesets]]
== `client.queryRules.listRulesets()`
Get all query rulesets. Get summarized information about the query rulesets.
{ref}/list-query-rulesets.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: QueryRulesListRulesetsRequest, options?: TransportRequestOptions) => Promise<QueryRulesListRulesetsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesListRulesetsRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface QueryRulesListRulesetsResponse {
count: <<long>>
results: QueryRulesListRulesetsQueryRulesetListItem[]
}
----
[discrete]
[[client.queryRules.putRule]]
== `client.queryRules.putRule()`
Create or update a query rule. Create or update a query rule within a query ruleset.
{ref}/put-query-rule.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: QueryRulesPutRuleRequest, options?: TransportRequestOptions) => Promise<QueryRulesPutRuleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesPutRuleRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
rule_id: <<Id>>
type: <<QueryRulesQueryRuleType>>
criteria: <<QueryRulesQueryRuleCriteria>> | <<QueryRulesQueryRuleCriteria>>[]
actions: <<QueryRulesQueryRuleActions>>
priority?: <<integer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface QueryRulesPutRuleResponse {
result: <<Result>>
}
----
[discrete]
[[client.queryRules.putRuleset]]
== `client.queryRules.putRuleset()`
Create or update a query ruleset.
{ref}/put-query-ruleset.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: QueryRulesPutRulesetRequest, options?: TransportRequestOptions) => Promise<QueryRulesPutRulesetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesPutRulesetRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
rules: <<QueryRulesQueryRule>> | <<QueryRulesQueryRule>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface QueryRulesPutRulesetResponse {
result: <<Result>>
}
----
[discrete]
[[client.queryRules.test]]
== `client.queryRules.test()`
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]
=== Function signature
[source,ts]
----
(request: QueryRulesTestRequest, options?: TransportRequestOptions) => Promise<QueryRulesTestResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface QueryRulesTestRequest extends <<RequestBase>> {
ruleset_id: <<Id>>
match_criteria: Record<string, any>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface QueryRulesTestResponse {
total_matched_rules: <<integer>>
matched_rules: QueryRulesTestQueryRulesetMatchedRule[]
}
----

View File

@ -0,0 +1,83 @@
[[reference-rank_eval]]
== client.rankEval
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.rankEval]]
== `client.rankEval()`
Evaluate ranked search results. Evaluate the quality of ranked search results over a set of typical search queries.
{ref}/search-rank-eval.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RankEvalRequest, options?: TransportRequestOptions) => Promise<RankEvalResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RankEvalRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
search_type?: string
requests: <<RankEvalRankEvalRequestItem>>[]
metric?: <<RankEvalRankEvalMetric>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface RankEvalResponse {
metric_score: <<double>>
details: Record<<<Id>>, <<RankEvalRankEvalMetricDetail>>>
failures: Record<string, any>
}
----

View File

@ -0,0 +1,103 @@
[[reference-reindex]]
== client.reindex
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.reindex]]
== `client.reindex()`
Reindex documents. Copies documents from a source to a destination. The source can be any existing index, alias, or data stream. The destination must differ from the source. For example, you cannot reindex a data stream into itself.
{ref}/docs-reindex.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ReindexRequest, options?: TransportRequestOptions) => Promise<ReindexResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ReindexRequest extends <<RequestBase>> {
refresh?: boolean
requests_per_second?: <<float>>
scroll?: <<Duration>>
slices?: <<Slices>>
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
wait_for_completion?: boolean
require_alias?: boolean
conflicts?: <<Conflicts>>
dest: <<ReindexDestination>>
max_docs?: <<long>>
script?: <<Script>> | string
size?: <<long>>
source: <<ReindexSource>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ReindexResponse {
batches?: <<long>>
created?: <<long>>
deleted?: <<long>>
failures?: <<BulkIndexByScrollFailure>>[]
noops?: <<long>>
retries?: <<Retries>>
requests_per_second?: <<float>>
slice_id?: <<integer>>
task?: <<TaskId>>
throttled_millis?: <<EpochTime>><<<UnitMillis>>>
throttled_until_millis?: <<EpochTime>><<<UnitMillis>>>
timed_out?: boolean
took?: <<DurationValue>><<<UnitMillis>>>
total?: <<long>>
updated?: <<long>>
version_conflicts?: <<long>>
}
----

View File

@ -0,0 +1,76 @@
[[reference-reindex_rethrottle]]
== client.reindexRethrottle
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.reindexRethrottle]]
== `client.reindexRethrottle()`
Throttle a reindex operation. Change the number of requests per second for a particular reindex operation.
{ref}/docs-reindex.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ReindexRethrottleRequest, options?: TransportRequestOptions) => Promise<ReindexRethrottleResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ReindexRethrottleRequest extends <<RequestBase>> {
task_id: <<Id>>
requests_per_second?: <<float>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ReindexRethrottleResponse {
nodes: Record<string, <<ReindexRethrottleReindexNode>>>
}
----

View File

@ -0,0 +1,78 @@
[[reference-render_search_template]]
== client.renderSearchTemplate
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.renderSearchTemplate]]
== `client.renderSearchTemplate()`
Render a search template. Render a search template as a search request body.
{ref}/render-search-template-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RenderSearchTemplateRequest, options?: TransportRequestOptions) => Promise<RenderSearchTemplateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RenderSearchTemplateRequest extends <<RequestBase>> {
id?: <<Id>>
file?: string
params?: Record<string, any>
source?: string
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface RenderSearchTemplateResponse {
template_output: Record<string, any>
}
----

View File

@ -0,0 +1,365 @@
[[reference-rollup]]
== client.rollup
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.rollup.deleteJob]]
== `client.rollup.deleteJob()`
Deletes an existing rollup job.
{ref}/rollup-delete-job.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupDeleteJobRequest, options?: TransportRequestOptions) => Promise<RollupDeleteJobResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupDeleteJobRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface RollupDeleteJobResponse {
acknowledged: boolean
task_failures?: <<TaskFailure>>[]
}
----
[discrete]
[[client.rollup.getJobs]]
== `client.rollup.getJobs()`
Retrieves the configuration, stats, and status of rollup jobs.
{ref}/rollup-get-job.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupGetJobsRequest, options?: TransportRequestOptions) => Promise<RollupGetJobsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupGetJobsRequest extends <<RequestBase>> {
id?: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface RollupGetJobsResponse {
jobs: RollupGetJobsRollupJob[]
}
----
[discrete]
[[client.rollup.getRollupCaps]]
== `client.rollup.getRollupCaps()`
Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern.
{ref}/rollup-get-rollup-caps.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupGetRollupCapsRequest, options?: TransportRequestOptions) => Promise<RollupGetRollupCapsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupGetRollupCapsRequest extends <<RequestBase>> {
id?: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type RollupGetRollupCapsResponse = Record<<<IndexName>>, RollupGetRollupCapsRollupCapabilities>
----
[discrete]
[[client.rollup.getRollupIndexCaps]]
== `client.rollup.getRollupIndexCaps()`
Returns the rollup capabilities of all jobs inside of a rollup index (for example, the index where rollup data is stored).
{ref}/rollup-get-rollup-index-caps.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupGetRollupIndexCapsRequest, options?: TransportRequestOptions) => Promise<RollupGetRollupIndexCapsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupGetRollupIndexCapsRequest extends <<RequestBase>> {
index: <<Ids>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type RollupGetRollupIndexCapsResponse = Record<<<IndexName>>, RollupGetRollupIndexCapsIndexCapabilities>
----
[discrete]
[[client.rollup.putJob]]
== `client.rollup.putJob()`
Creates a rollup job.
{ref}/rollup-put-job.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupPutJobRequest, options?: TransportRequestOptions) => Promise<RollupPutJobResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupPutJobRequest extends <<RequestBase>> {
id: <<Id>>
cron: string
groups: <<RollupGroupings>>
index_pattern: string
metrics?: <<RollupFieldMetric>>[]
page_size: <<integer>>
rollup_index: <<IndexName>>
timeout?: <<Duration>>
headers?: <<HttpHeaders>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type RollupPutJobResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.rollup.rollupSearch]]
== `client.rollup.rollupSearch()`
Enables searching rolled-up data using the standard Query DSL.
{ref}/rollup-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupRollupSearchRequest, options?: TransportRequestOptions) => Promise<RollupRollupSearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupRollupSearchRequest extends <<RequestBase>> {
index: <<Indices>>
rest_total_hits_as_int?: boolean
typed_keys?: boolean
aggregations?: Record<string, <<AggregationsAggregationContainer>>>
pass:[/**] @alias aggregations */
aggs?: Record<string, <<AggregationsAggregationContainer>>>
query?: <<QueryDslQueryContainer>>
size?: <<integer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface RollupRollupSearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> {
took: <<long>>
timed_out: boolean
terminated_early?: boolean
_shards: <<ShardStatistics>>
hits: <<SearchHitsMetadata>><TDocument>
aggregations?: TAggregations
}
----
[discrete]
[[client.rollup.startJob]]
== `client.rollup.startJob()`
Starts an existing, stopped rollup job.
{ref}/rollup-start-job.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupStartJobRequest, options?: TransportRequestOptions) => Promise<RollupStartJobResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupStartJobRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface RollupStartJobResponse {
started: boolean
}
----
[discrete]
[[client.rollup.stopJob]]
== `client.rollup.stopJob()`
Stops an existing, started rollup job.
{ref}/rollup-stop-job.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: RollupStopJobRequest, options?: TransportRequestOptions) => Promise<RollupStopJobResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface RollupStopJobRequest extends <<RequestBase>> {
id: <<Id>>
timeout?: <<Duration>>
wait_for_completion?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface RollupStopJobResponse {
stopped: boolean
}
----

View File

@ -0,0 +1,77 @@
[[reference-scripts_painless_execute]]
== client.scriptsPainlessExecute
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.scriptsPainlessExecute]]
== `client.scriptsPainlessExecute()`
Run a script. Runs a script and returns a result.
{painless}/painless-execute-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ScriptsPainlessExecuteRequest, options?: TransportRequestOptions) => Promise<ScriptsPainlessExecuteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ScriptsPainlessExecuteRequest extends <<RequestBase>> {
context?: string
context_setup?: <<ScriptsPainlessExecutePainlessContextSetup>>
script?: <<Script>> | string
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ScriptsPainlessExecuteResponse<TResult = unknown> {
result: TResult
}
----

View File

@ -0,0 +1,75 @@
[[reference-scroll]]
== client.scroll
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.scroll]]
== `client.scroll()`
Run a scrolling search. IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT). The scroll API gets large sets of results from a single scrolling search request. To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. The search response returns a scroll ID in the `_scroll_id` response body parameter. You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.
{ref}/search-request-body.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: ScrollRequest, options?: TransportRequestOptions) => Promise<ScrollResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface ScrollRequest extends <<RequestBase>> {
scroll_id?: <<ScrollId>>
rest_total_hits_as_int?: boolean
scroll?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ScrollResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<SearchResponseBody>><TDocument, TAggregations>
----

View File

@ -0,0 +1,139 @@
[[reference-search]]
== client.search
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.search]]
== `client.search()`
Run a search. Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.
{ref}/search-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchRequest, options?: TransportRequestOptions) => Promise<SearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
allow_partial_search_results?: boolean
analyzer?: string
analyze_wildcard?: boolean
batched_reduce_size?: <<long>>
ccs_minimize_roundtrips?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
include_named_queries_score?: boolean
lenient?: boolean
max_concurrent_shard_requests?: <<long>>
preference?: string
pre_filter_shard_size?: <<long>>
request_cache?: boolean
routing?: <<Routing>>
scroll?: <<Duration>>
search_type?: <<SearchType>>
suggest_field?: <<Field>>
suggest_mode?: <<SuggestMode>>
suggest_size?: <<long>>
suggest_text?: string
typed_keys?: boolean
rest_total_hits_as_int?: boolean
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
q?: string
force_synthetic_source?: boolean
aggregations?: Record<string, <<AggregationsAggregationContainer>>>
pass:[/**] @alias aggregations */
aggs?: Record<string, <<AggregationsAggregationContainer>>>
collapse?: <<SearchFieldCollapse>>
explain?: boolean
ext?: Record<string, any>
from?: <<integer>>
highlight?: <<SearchHighlight>>
track_total_hits?: <<SearchTrackHits>>
indices_boost?: Record<<<IndexName>>, <<double>>>[]
docvalue_fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
knn?: <<KnnSearch>> | <<KnnSearch>>[]
rank?: <<RankContainer>>
min_score?: <<double>>
post_filter?: <<QueryDslQueryContainer>>
profile?: boolean
query?: <<QueryDslQueryContainer>>
rescore?: <<SearchRescore>> | <<SearchRescore>>[]
retriever?: <<RetrieverContainer>>
script_fields?: Record<string, <<ScriptField>>>
search_after?: <<SortResults>>
size?: <<integer>>
slice?: <<SlicedScroll>>
sort?: <<Sort>>
_source?: <<SearchSourceConfig>>
fields?: (<<QueryDslFieldAndFormat>> | <<Field>>)[]
suggest?: <<SearchSuggester>>
terminate_after?: <<long>>
timeout?: string
track_scores?: boolean
version?: boolean
seq_no_primary_term?: boolean
stored_fields?: <<Fields>>
pit?: <<SearchPointInTimeReference>>
runtime_mappings?: <<MappingRuntimeFields>>
stats?: string[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<SearchResponseBody>><TDocument, TAggregations>
----

View File

@ -0,0 +1,373 @@
[[reference-search_application]]
== client.searchApplication
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.searchApplication.delete]]
== `client.searchApplication.delete()`
Delete a search application. Remove a search application and its associated alias. Indices attached to the search application are not removed.
{ref}/delete-search-application.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationDeleteRequest, options?: TransportRequestOptions) => Promise<SearchApplicationDeleteResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationDeleteRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchApplicationDeleteResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.searchApplication.deleteBehavioralAnalytics]]
== `client.searchApplication.deleteBehavioralAnalytics()`
Delete a behavioral analytics collection. The associated data stream is also deleted.
{ref}/delete-analytics-collection.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationDeleteBehavioralAnalyticsRequest, options?: TransportRequestOptions) => Promise<SearchApplicationDeleteBehavioralAnalyticsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationDeleteBehavioralAnalyticsRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchApplicationDeleteBehavioralAnalyticsResponse = <<AcknowledgedResponseBase>>
----
[discrete]
[[client.searchApplication.get]]
== `client.searchApplication.get()`
Get search application details.
{ref}/get-search-application.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationGetRequest, options?: TransportRequestOptions) => Promise<SearchApplicationGetResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationGetRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchApplicationGetResponse = <<SearchApplicationSearchApplication>>
----
[discrete]
[[client.searchApplication.getBehavioralAnalytics]]
== `client.searchApplication.getBehavioralAnalytics()`
Get behavioral analytics collections.
{ref}/list-analytics-collection.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationGetBehavioralAnalyticsRequest, options?: TransportRequestOptions) => Promise<SearchApplicationGetBehavioralAnalyticsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationGetBehavioralAnalyticsRequest extends <<RequestBase>> {
name?: <<Name>>[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchApplicationGetBehavioralAnalyticsResponse = Record<<<Name>>, <<SearchApplicationAnalyticsCollection>>>
----
[discrete]
[[client.searchApplication.list]]
== `client.searchApplication.list()`
Returns the existing search applications.
{ref}/list-search-applications.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationListRequest, options?: TransportRequestOptions) => Promise<SearchApplicationListResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationListRequest extends <<RequestBase>> {
q?: string
from?: <<integer>>
size?: <<integer>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface SearchApplicationListResponse {
count: <<long>>
results: <<SearchApplicationSearchApplication>>[]
}
----
[discrete]
[[client.searchApplication.postBehavioralAnalyticsEvent]]
== `client.searchApplication.postBehavioralAnalyticsEvent()`
Creates a behavioral analytics event for existing collection.
http://todo.com/tbd[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationPostBehavioralAnalyticsEventRequest, options?: TransportRequestOptions) => Promise<SearchApplicationPostBehavioralAnalyticsEventResponse>
----
[discrete]
[[client.searchApplication.put]]
== `client.searchApplication.put()`
Create or update a search application.
{ref}/put-search-application.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationPutRequest, options?: TransportRequestOptions) => Promise<SearchApplicationPutResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationPutRequest extends <<RequestBase>> {
name: <<Name>>
create?: boolean
search_application?: <<SearchApplicationSearchApplicationParameters>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface SearchApplicationPutResponse {
result: <<Result>>
}
----
[discrete]
[[client.searchApplication.putBehavioralAnalytics]]
== `client.searchApplication.putBehavioralAnalytics()`
Create a behavioral analytics collection.
{ref}/put-analytics-collection.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationPutBehavioralAnalyticsRequest, options?: TransportRequestOptions) => Promise<SearchApplicationPutBehavioralAnalyticsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationPutBehavioralAnalyticsRequest extends <<RequestBase>> {
name: <<Name>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchApplicationPutBehavioralAnalyticsResponse = SearchApplicationPutBehavioralAnalyticsAnalyticsAcknowledgeResponseBase
----
[discrete]
[[client.searchApplication.renderQuery]]
== `client.searchApplication.renderQuery()`
Renders a query for given search application search parameters
{ref}/search-application-render-query.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationRenderQueryRequest, options?: TransportRequestOptions) => Promise<SearchApplicationRenderQueryResponse>
----
[discrete]
[[client.searchApplication.search]]
== `client.searchApplication.search()`
Run a search application search. Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. Unspecified template parameters are assigned their default values if applicable.
{ref}/search-application-search.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchApplicationSearchRequest, options?: TransportRequestOptions) => Promise<SearchApplicationSearchResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchApplicationSearchRequest extends <<RequestBase>> {
name: <<Name>>
typed_keys?: boolean
params?: Record<string, any>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchApplicationSearchResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<SearchResponseBody>><TDocument, TAggregations>
----

View File

@ -0,0 +1,91 @@
[[reference-search_mvt]]
== client.searchMvt
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.searchMvt]]
== `client.searchMvt()`
Search a vector tile. Search a vector tile for geospatial values.
{ref}/search-vector-tile-api.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchMvtRequest, options?: TransportRequestOptions) => Promise<SearchMvtResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchMvtRequest extends <<RequestBase>> {
index: <<Indices>>
field: <<Field>>
zoom: <<SearchMvtZoomLevel>>
x: <<SearchMvtCoordinate>>
y: <<SearchMvtCoordinate>>
aggs?: Record<string, <<AggregationsAggregationContainer>>>
buffer?: <<integer>>
exact_bounds?: boolean
extent?: <<integer>>
fields?: <<Fields>>
grid_agg?: <<SearchMvtGridAggregationType>>
grid_precision?: <<integer>>
grid_type?: <<SearchMvtGridType>>
query?: <<QueryDslQueryContainer>>
runtime_mappings?: <<MappingRuntimeFields>>
size?: <<integer>>
sort?: <<Sort>>
track_total_hits?: <<SearchTrackHits>>
with_labels?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchMvtResponse = <<MapboxVectorTiles>>
----

View File

@ -0,0 +1,83 @@
[[reference-search_shards]]
== client.searchShards
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.searchShards]]
== `client.searchShards()`
Get the search shards. Get the indices and shards that a search request would be run against. This information can be useful for working out issues or planning optimizations with routing and shard preferences. When filtered aliases are used, the filter is returned as part of the indices section.
{ref}/search-shards.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchShardsRequest, options?: TransportRequestOptions) => Promise<SearchShardsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchShardsRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_unavailable?: boolean
local?: boolean
preference?: string
routing?: <<Routing>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface SearchShardsResponse {
nodes: Record<<<NodeId>>, <<SearchShardsSearchShardsNodeAttributes>>>
shards: <<NodeShard>>[][]
indices: Record<<<IndexName>>, <<SearchShardsShardStoreIndex>>>
}
----

View File

@ -0,0 +1,104 @@
[[reference-search_template]]
== client.searchTemplate
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.searchTemplate]]
== `client.searchTemplate()`
Run a search with a search template.
{ref}/search-template.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchTemplateRequest, options?: TransportRequestOptions) => Promise<SearchTemplateResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchTemplateRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
ccs_minimize_roundtrips?: boolean
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
preference?: string
routing?: <<Routing>>
scroll?: <<Duration>>
search_type?: <<SearchType>>
rest_total_hits_as_int?: boolean
typed_keys?: boolean
explain?: boolean
id?: <<Id>>
params?: Record<string, any>
profile?: boolean
source?: string
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface SearchTemplateResponse<TDocument = unknown> {
took: <<long>>
timed_out: boolean
_shards: <<ShardStatistics>>
hits: <<SearchHitsMetadata>><TDocument>
aggregations?: Record<<<AggregateName>>, <<AggregationsAggregate>>>
_clusters?: <<ClusterStatistics>>
fields?: Record<string, any>
max_score?: <<double>>
num_reduce_phases?: <<long>>
profile?: <<SearchProfile>>
pit_id?: <<Id>>
_scroll_id?: <<ScrollId>>
suggest?: Record<<<SuggestionName>>, <<SearchSuggest>><TDocument>[]>
terminated_early?: boolean
}
----

View File

@ -0,0 +1,206 @@
[[reference-searchable_snapshots]]
== client.searchableSnapshots
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.searchableSnapshots.cacheStats]]
== `client.searchableSnapshots.cacheStats()`
Retrieve node-level cache statistics about searchable snapshots.
{ref}/searchable-snapshots-apis.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchableSnapshotsCacheStatsRequest, options?: TransportRequestOptions) => Promise<SearchableSnapshotsCacheStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchableSnapshotsCacheStatsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
master_timeout?: <<Duration>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface SearchableSnapshotsCacheStatsResponse {
nodes: Record<string, SearchableSnapshotsCacheStatsNode>
}
----
[discrete]
[[client.searchableSnapshots.clearCache]]
== `client.searchableSnapshots.clearCache()`
Clear the cache of searchable snapshots.
{ref}/searchable-snapshots-apis.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchableSnapshotsClearCacheRequest, options?: TransportRequestOptions) => Promise<SearchableSnapshotsClearCacheResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchableSnapshotsClearCacheRequest extends <<RequestBase>> {
index?: <<Indices>>
expand_wildcards?: <<ExpandWildcards>>
allow_no_indices?: boolean
ignore_unavailable?: boolean
pretty?: boolean
human?: boolean
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
type SearchableSnapshotsClearCacheResponse = any
----
[discrete]
[[client.searchableSnapshots.mount]]
== `client.searchableSnapshots.mount()`
Mount a snapshot as a searchable index.
{ref}/searchable-snapshots-api-mount-snapshot.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchableSnapshotsMountRequest, options?: TransportRequestOptions) => Promise<SearchableSnapshotsMountResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchableSnapshotsMountRequest extends <<RequestBase>> {
repository: <<Name>>
snapshot: <<Name>>
master_timeout?: <<Duration>>
wait_for_completion?: boolean
storage?: string
index: <<IndexName>>
renamed_index?: <<IndexName>>
index_settings?: Record<string, any>
ignore_index_settings?: string[]
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface SearchableSnapshotsMountResponse {
snapshot: SearchableSnapshotsMountMountedSnapshot
}
----
[discrete]
[[client.searchableSnapshots.stats]]
== `client.searchableSnapshots.stats()`
Retrieve shard-level statistics about searchable snapshots.
{ref}/searchable-snapshots-apis.html[{es} documentation]
[discrete]
=== Function signature
[source,ts]
----
(request: SearchableSnapshotsStatsRequest, options?: TransportRequestOptions) => Promise<SearchableSnapshotsStatsResponse>
----
[discrete]
=== Request
[source,ts,subs=+macros]
----
interface SearchableSnapshotsStatsRequest extends <<RequestBase>> {
index?: <<Indices>>
level?: <<SearchableSnapshotsStatsLevel>>
}
----
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface SearchableSnapshotsStatsResponse {
stats: any
total: any
}
----

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,101 @@
[[reference-shared-types-async-search-types]]
=== `AsyncSearch` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[AsyncSearchAsyncSearch]]
=== AsyncSearchAsyncSearch
[source,ts,subs=+macros]
----
interface AsyncSearchAsyncSearch<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> {
pass:[/**] @property aggregations Partial aggregations results, coming from the shards that have already completed the execution of the query. */
aggregations?: TAggregations
_clusters?: <<ClusterStatistics>>
fields?: Record<string, any>
hits: <<SearchHitsMetadata>><TDocument>
max_score?: <<double>>
pass:[/**] @property num_reduce_phases Indicates how many reductions of the results have been performed. If this number increases compared to the last retrieved results for a get asynch search request, you can expect additional results included in the search response. */
num_reduce_phases?: <<long>>
profile?: <<SearchProfile>>
pit_id?: <<Id>>
_scroll_id?: <<ScrollId>>
pass:[/**] @property _shards Indicates how many shards have run the query. Note that in order for shard results to be included in the search response, they need to be reduced first. */
_shards: <<ShardStatistics>>
suggest?: Record<<<SuggestionName>>, <<SearchSuggest>><TDocument>[]>
terminated_early?: boolean
timed_out: boolean
took: <<long>>
}
----
[discrete]
[[AsyncSearchAsyncSearchDocumentResponseBase]]
=== AsyncSearchAsyncSearchDocumentResponseBase
[source,ts,subs=+macros]
----
interface AsyncSearchAsyncSearchDocumentResponseBase<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> extends <<AsyncSearchAsyncSearchResponseBase>> {
response: <<AsyncSearchAsyncSearch>><TDocument, TAggregations>
}
----
[discrete]
[[AsyncSearchAsyncSearchResponseBase]]
=== AsyncSearchAsyncSearchResponseBase
[source,ts,subs=+macros]
----
interface AsyncSearchAsyncSearchResponseBase {
id?: <<Id>>
pass:[/**] @property is_partial When the query is no longer running, this property indicates whether the search failed or was successfully completed on all shards. While the query is running, `is_partial` is always set to `true`. */
is_partial: boolean
pass:[/**] @property is_running Indicates whether the search is still running or has completed. NOTE: If the search failed after some shards returned their results or the node that is coordinating the async search dies, results may be partial even though `is_running` is `false`. */
is_running: boolean
pass:[/**] @property expiration_time Indicates when the async search will expire. */
expiration_time?: <<DateTime>>
expiration_time_in_millis: <<EpochTime>><<<UnitMillis>>>
start_time?: <<DateTime>>
start_time_in_millis: <<EpochTime>><<<UnitMillis>>>
pass:[/**] @property completion_time Indicates when the async search completed. Only present when the search has completed. */
completion_time?: <<DateTime>>
completion_time_in_millis?: <<EpochTime>><<<UnitMillis>>>
}
----

View File

@ -0,0 +1,51 @@
[[reference-shared-types-autoscaling-types]]
=== `Autoscaling` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[AutoscalingAutoscalingPolicy]]
=== AutoscalingAutoscalingPolicy
[source,ts,subs=+macros]
----
interface AutoscalingAutoscalingPolicy {
roles: string[]
pass:[/**] @property deciders Decider settings. */
deciders: Record<string, any>
}
----

View File

@ -0,0 +1,147 @@
[[reference-shared-types-cat-types]]
=== `Cat` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[CatCatAnomalyDetectorColumn]]
=== CatCatAnomalyDetectorColumn
[source,ts,subs=+macros]
----
type CatCatAnomalyDetectorColumn = 'assignment_explanation' | 'ae' | 'buckets.count' | 'bc' | 'bucketsCount' | 'buckets.time.exp_avg' | 'btea' | 'bucketsTimeExpAvg' | 'buckets.time.exp_avg_hour' | 'bteah' | 'bucketsTimeExpAvgHour' | 'buckets.time.max' | 'btmax' | 'bucketsTimeMax' | 'buckets.time.min' | 'btmin' | 'bucketsTimeMin' | 'buckets.time.total' | 'btt' | 'bucketsTimeTotal' | 'data.buckets' | 'db' | 'dataBuckets' | 'data.earliest_record' | 'der' | 'dataEarliestRecord' | 'data.empty_buckets' | 'deb' | 'dataEmptyBuckets' | 'data.input_bytes' | 'dib' | 'dataInputBytes' | 'data.input_fields' | 'dif' | 'dataInputFields' | 'data.input_records' | 'dir' | 'dataInputRecords' | 'data.invalid_dates' | 'did' | 'dataInvalidDates' | 'data.last' | 'dl' | 'dataLast' | 'data.last_empty_bucket' | 'dleb' | 'dataLastEmptyBucket' | 'data.last_sparse_bucket' | 'dlsb' | 'dataLastSparseBucket' | 'data.latest_record' | 'dlr' | 'dataLatestRecord' | 'data.missing_fields' | 'dmf' | 'dataMissingFields' | 'data.out_of_order_timestamps' | 'doot' | 'dataOutOfOrderTimestamps' | 'data.processed_fields' | 'dpf' | 'dataProcessedFields' | 'data.processed_records' | 'dpr' | 'dataProcessedRecords' | 'data.sparse_buckets' | 'dsb' | 'dataSparseBuckets' | 'forecasts.memory.avg' | 'fmavg' | 'forecastsMemoryAvg' | 'forecasts.memory.max' | 'fmmax' | 'forecastsMemoryMax' | 'forecasts.memory.min' | 'fmmin' | 'forecastsMemoryMin' | 'forecasts.memory.total' | 'fmt' | 'forecastsMemoryTotal' | 'forecasts.records.avg' | 'fravg' | 'forecastsRecordsAvg' | 'forecasts.records.max' | 'frmax' | 'forecastsRecordsMax' | 'forecasts.records.min' | 'frmin' | 'forecastsRecordsMin' | 'forecasts.records.total' | 'frt' | 'forecastsRecordsTotal' | 'forecasts.time.avg' | 'ftavg' | 'forecastsTimeAvg' | 'forecasts.time.max' | 'ftmax' | 'forecastsTimeMax' | 'forecasts.time.min' | 'ftmin' | 'forecastsTimeMin' | 'forecasts.time.total' | 'ftt' | 'forecastsTimeTotal' | 'forecasts.total' | 'ft' | 'forecastsTotal' | 'id' | 'model.bucket_allocation_failures' | 'mbaf' | 'modelBucketAllocationFailures' | 'model.by_fields' | 'mbf' | 'modelByFields' | 'model.bytes' | 'mb' | 'modelBytes' | 'model.bytes_exceeded' | 'mbe' | 'modelBytesExceeded' | 'model.categorization_status' | 'mcs' | 'modelCategorizationStatus' | 'model.categorized_doc_count' | 'mcdc' | 'modelCategorizedDocCount' | 'model.dead_category_count' | 'mdcc' | 'modelDeadCategoryCount' | 'model.failed_category_count' | 'mdcc' | 'modelFailedCategoryCount' | 'model.frequent_category_count' | 'mfcc' | 'modelFrequentCategoryCount' | 'model.log_time' | 'mlt' | 'modelLogTime' | 'model.memory_limit' | 'mml' | 'modelMemoryLimit' | 'model.memory_status' | 'mms' | 'modelMemoryStatus' | 'model.over_fields' | 'mof' | 'modelOverFields' | 'model.partition_fields' | 'mpf' | 'modelPartitionFields' | 'model.rare_category_count' | 'mrcc' | 'modelRareCategoryCount' | 'model.timestamp' | 'mt' | 'modelTimestamp' | 'model.total_category_count' | 'mtcc' | 'modelTotalCategoryCount' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'opened_time' | 'ot' | 'state' | 's'
----
[discrete]
[[CatCatAnonalyDetectorColumns]]
=== CatCatAnonalyDetectorColumns
[source,ts,subs=+macros]
----
type CatCatAnonalyDetectorColumns = <<CatCatAnomalyDetectorColumn>> | <<CatCatAnomalyDetectorColumn>>[]
----
[discrete]
[[CatCatDatafeedColumn]]
=== CatCatDatafeedColumn
[source,ts,subs=+macros]
----
type CatCatDatafeedColumn = 'ae' | 'assignment_explanation' | 'bc' | 'buckets.count' | 'bucketsCount' | 'id' | 'na' | 'node.address' | 'nodeAddress' | 'ne' | 'node.ephemeral_id' | 'nodeEphemeralId' | 'ni' | 'node.id' | 'nodeId' | 'nn' | 'node.name' | 'nodeName' | 'sba' | 'search.bucket_avg' | 'searchBucketAvg' | 'sc' | 'search.count' | 'searchCount' | 'seah' | 'search.exp_avg_hour' | 'searchExpAvgHour' | 'st' | 'search.time' | 'searchTime' | 's' | 'state'
----
[discrete]
[[CatCatDatafeedColumns]]
=== CatCatDatafeedColumns
[source,ts,subs=+macros]
----
type CatCatDatafeedColumns = <<CatCatDatafeedColumn>> | <<CatCatDatafeedColumn>>[]
----
[discrete]
[[CatCatDfaColumn]]
=== CatCatDfaColumn
[source,ts,subs=+macros]
----
type CatCatDfaColumn = 'assignment_explanation' | 'ae' | 'create_time' | 'ct' | 'createTime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'failure_reason' | 'fr' | 'failureReason' | 'id' | 'model_memory_limit' | 'mml' | 'modelMemoryLimit' | 'node.address' | 'na' | 'nodeAddress' | 'node.ephemeral_id' | 'ne' | 'nodeEphemeralId' | 'node.id' | 'ni' | 'nodeId' | 'node.name' | 'nn' | 'nodeName' | 'progress' | 'p' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'type' | 't' | 'version' | 'v'
----
[discrete]
[[CatCatDfaColumns]]
=== CatCatDfaColumns
[source,ts,subs=+macros]
----
type CatCatDfaColumns = <<CatCatDfaColumn>> | <<CatCatDfaColumn>>[]
----
[discrete]
[[CatCatRequestBase]]
=== CatCatRequestBase
[source,ts,subs=+macros]
----
interface CatCatRequestBase extends <<RequestBase>>, <<SpecUtilsCommonCatQueryParameters>> {}
----
[discrete]
[[CatCatTrainedModelsColumn]]
=== CatCatTrainedModelsColumn
[source,ts,subs=+macros]
----
type CatCatTrainedModelsColumn = 'create_time' | 'ct' | 'created_by' | 'c' | 'createdBy' | 'data_frame_analytics_id' | 'df' | 'dataFrameAnalytics' | 'dfid' | 'description' | 'd' | 'heap_size' | 'hs' | 'modelHeapSize' | 'id' | 'ingest.count' | 'ic' | 'ingestCount' | 'ingest.current' | 'icurr' | 'ingestCurrent' | 'ingest.failed' | 'if' | 'ingestFailed' | 'ingest.pipelines' | 'ip' | 'ingestPipelines' | 'ingest.time' | 'it' | 'ingestTime' | 'license' | 'l' | 'operations' | 'o' | 'modelOperations' | 'version' | 'v'
----
[discrete]
[[CatCatTrainedModelsColumns]]
=== CatCatTrainedModelsColumns
[source,ts,subs=+macros]
----
type CatCatTrainedModelsColumns = <<CatCatTrainedModelsColumn>> | <<CatCatTrainedModelsColumn>>[]
----
[discrete]
[[CatCatTransformColumn]]
=== CatCatTransformColumn
[source,ts,subs=+macros]
----
type CatCatTransformColumn = 'changes_last_detection_time' | 'cldt' | 'checkpoint' | 'cp' | 'checkpoint_duration_time_exp_avg' | 'cdtea' | 'checkpointTimeExpAvg' | 'checkpoint_progress' | 'c' | 'checkpointProgress' | 'create_time' | 'ct' | 'createTime' | 'delete_time' | 'dtime' | 'description' | 'd' | 'dest_index' | 'di' | 'destIndex' | 'documents_deleted' | 'docd' | 'documents_indexed' | 'doci' | 'docs_per_second' | 'dps' | 'documents_processed' | 'docp' | 'frequency' | 'f' | 'id' | 'index_failure' | 'if' | 'index_time' | 'itime' | 'index_total' | 'it' | 'indexed_documents_exp_avg' | 'idea' | 'last_search_time' | 'lst' | 'lastSearchTime' | 'max_page_search_size' | 'mpsz' | 'pages_processed' | 'pp' | 'pipeline' | 'p' | 'processed_documents_exp_avg' | 'pdea' | 'processing_time' | 'pt' | 'reason' | 'r' | 'search_failure' | 'sf' | 'search_time' | 'stime' | 'search_total' | 'st' | 'source_index' | 'si' | 'sourceIndex' | 'state' | 's' | 'transform_type' | 'tt' | 'trigger_count' | 'tc' | 'version' | 'v'
----
[discrete]
[[CatCatTransformColumns]]
=== CatCatTransformColumns
[source,ts,subs=+macros]
----
type CatCatTransformColumns = <<CatCatTransformColumn>> | <<CatCatTransformColumn>>[]
----

View File

@ -0,0 +1,108 @@
[[reference-shared-types-ccr-types]]
=== `Ccr` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[CcrFollowIndexStats]]
=== CcrFollowIndexStats
[source,ts,subs=+macros]
----
interface CcrFollowIndexStats {
index: <<IndexName>>
shards: <<CcrShardStats>>[]
}
----
[discrete]
[[CcrReadException]]
=== CcrReadException
[source,ts,subs=+macros]
----
interface CcrReadException {
exception: <<ErrorCause>>
from_seq_no: <<SequenceNumber>>
retries: <<integer>>
}
----
[discrete]
[[CcrShardStats]]
=== CcrShardStats
[source,ts,subs=+macros]
----
interface CcrShardStats {
bytes_read: <<long>>
failed_read_requests: <<long>>
failed_write_requests: <<long>>
fatal_exception?: <<ErrorCause>>
follower_aliases_version: <<VersionNumber>>
follower_global_checkpoint: <<long>>
follower_index: string
follower_mapping_version: <<VersionNumber>>
follower_max_seq_no: <<SequenceNumber>>
follower_settings_version: <<VersionNumber>>
last_requested_seq_no: <<SequenceNumber>>
leader_global_checkpoint: <<long>>
leader_index: string
leader_max_seq_no: <<SequenceNumber>>
operations_read: <<long>>
operations_written: <<long>>
outstanding_read_requests: <<integer>>
outstanding_write_requests: <<integer>>
read_exceptions: <<CcrReadException>>[]
remote_cluster: string
shard_id: <<integer>>
successful_read_requests: <<long>>
successful_write_requests: <<long>>
time_since_last_read?: <<Duration>>
time_since_last_read_millis: <<DurationValue>><<<UnitMillis>>>
total_read_remote_exec_time?: <<Duration>>
total_read_remote_exec_time_millis: <<DurationValue>><<<UnitMillis>>>
total_read_time?: <<Duration>>
total_read_time_millis: <<DurationValue>><<<UnitMillis>>>
total_write_time?: <<Duration>>
total_write_time_millis: <<DurationValue>><<<UnitMillis>>>
write_buffer_operation_count: <<long>>
write_buffer_size_in_bytes: <<ByteSize>>
}
----

View File

@ -0,0 +1,81 @@
[[reference-shared-types-cluster-types]]
=== `Cluster` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[ClusterComponentTemplate]]
=== ClusterComponentTemplate
[source,ts,subs=+macros]
----
interface ClusterComponentTemplate {
name: <<Name>>
component_template: <<ClusterComponentTemplateNode>>
}
----
[discrete]
[[ClusterComponentTemplateNode]]
=== ClusterComponentTemplateNode
[source,ts,subs=+macros]
----
interface ClusterComponentTemplateNode {
template: <<ClusterComponentTemplateSummary>>
version?: <<VersionNumber>>
_meta?: <<Metadata>>
}
----
[discrete]
[[ClusterComponentTemplateSummary]]
=== ClusterComponentTemplateSummary
[source,ts,subs=+macros]
----
interface ClusterComponentTemplateSummary {
_meta?: <<Metadata>>
version?: <<VersionNumber>>
settings?: Record<<<IndexName>>, <<IndicesIndexSettings>>>
mappings?: <<MappingTypeMapping>>
aliases?: Record<string, <<IndicesAliasDefinition>>>
lifecycle?: <<IndicesDataStreamLifecycleWithRollover>>
}
----

View File

@ -0,0 +1,565 @@
[[reference-shared-types-connector-types]]
=== `Connector` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[ConnectorConnector]]
=== ConnectorConnector
[source,ts,subs=+macros]
----
interface ConnectorConnector {
api_key_id?: string
api_key_secret_id?: string
configuration: <<ConnectorConnectorConfiguration>>
custom_scheduling: <<ConnectorConnectorCustomScheduling>>
description?: string
error?: string | null
features?: <<ConnectorConnectorFeatures>>
filtering: <<ConnectorFilteringConfig>>[]
id?: <<Id>>
index_name?: <<IndexName>> | null
is_native: boolean
language?: string
last_access_control_sync_error?: string
last_access_control_sync_scheduled_at?: <<DateTime>>
last_access_control_sync_status?: <<ConnectorSyncStatus>>
last_deleted_document_count?: <<long>>
last_incremental_sync_scheduled_at?: <<DateTime>>
last_indexed_document_count?: <<long>>
last_seen?: <<DateTime>>
last_sync_error?: string
last_sync_scheduled_at?: <<DateTime>>
last_sync_status?: <<ConnectorSyncStatus>>
last_synced?: <<DateTime>>
name?: string
pipeline?: <<ConnectorIngestPipelineParams>>
scheduling: <<ConnectorSchedulingConfiguration>>
service_type?: string
status: <<ConnectorConnectorStatus>>
sync_cursor?: any
sync_now: boolean
}
----
[discrete]
[[ConnectorConnectorConfigProperties]]
=== ConnectorConnectorConfigProperties
[source,ts,subs=+macros]
----
interface ConnectorConnectorConfigProperties {
category?: string
default_value: <<ScalarValue>>
depends_on: <<ConnectorDependency>>[]
display: <<ConnectorDisplayType>>
label: string
options: <<ConnectorSelectOption>>[]
order?: <<integer>>
placeholder?: string
required: boolean
sensitive: boolean
tooltip?: string | null
type?: <<ConnectorConnectorFieldType>>
ui_restrictions?: string[]
validations?: <<ConnectorValidation>>[]
value: any
}
----
[discrete]
[[ConnectorConnectorConfiguration]]
=== ConnectorConnectorConfiguration
[source,ts,subs=+macros]
----
type ConnectorConnectorConfiguration = Record<string, <<ConnectorConnectorConfigProperties>>>
----
[discrete]
[[ConnectorConnectorCustomScheduling]]
=== ConnectorConnectorCustomScheduling
[source,ts,subs=+macros]
----
type ConnectorConnectorCustomScheduling = Record<string, <<ConnectorCustomScheduling>>>
----
[discrete]
[[ConnectorConnectorFeatures]]
=== ConnectorConnectorFeatures
[source,ts,subs=+macros]
----
interface ConnectorConnectorFeatures {
document_level_security?: <<ConnectorFeatureEnabled>>
incremental_sync?: <<ConnectorFeatureEnabled>>
native_connector_api_keys?: <<ConnectorFeatureEnabled>>
sync_rules?: <<ConnectorSyncRulesFeature>>
}
----
[discrete]
[[ConnectorConnectorFieldType]]
=== ConnectorConnectorFieldType
[source,ts,subs=+macros]
----
type ConnectorConnectorFieldType = 'str' | 'int' | 'list' | 'bool'
----
[discrete]
[[ConnectorConnectorScheduling]]
=== ConnectorConnectorScheduling
[source,ts,subs=+macros]
----
interface ConnectorConnectorScheduling {
enabled: boolean
pass:[/**] @property interval The interval is expressed using the crontab syntax */
interval: string
}
----
[discrete]
[[ConnectorConnectorStatus]]
=== ConnectorConnectorStatus
[source,ts,subs=+macros]
----
type ConnectorConnectorStatus = 'created' | 'needs_configuration' | 'configured' | 'connected' | 'error'
----
[discrete]
[[ConnectorConnectorSyncJob]]
=== ConnectorConnectorSyncJob
[source,ts,subs=+macros]
----
interface ConnectorConnectorSyncJob {
cancelation_requested_at?: <<DateTime>>
canceled_at?: <<DateTime>>
completed_at?: <<DateTime>>
connector: <<ConnectorSyncJobConnectorReference>>
created_at: <<DateTime>>
deleted_document_count: <<long>>
error?: string
id: <<Id>>
indexed_document_count: <<long>>
indexed_document_volume: <<long>>
job_type: <<ConnectorSyncJobType>>
last_seen?: <<DateTime>>
metadata: Record<string, any>
started_at?: <<DateTime>>
status: <<ConnectorSyncStatus>>
total_document_count: <<long>>
trigger_method: <<ConnectorSyncJobTriggerMethod>>
worker_hostname?: string
}
----
[discrete]
[[ConnectorCustomScheduling]]
=== ConnectorCustomScheduling
[source,ts,subs=+macros]
----
interface ConnectorCustomScheduling {
configuration_overrides: <<ConnectorCustomSchedulingConfigurationOverrides>>
enabled: boolean
interval: string
last_synced?: <<DateTime>>
name: string
}
----
[discrete]
[[ConnectorCustomSchedulingConfigurationOverrides]]
=== ConnectorCustomSchedulingConfigurationOverrides
[source,ts,subs=+macros]
----
interface ConnectorCustomSchedulingConfigurationOverrides {
max_crawl_depth?: <<integer>>
sitemap_discovery_disabled?: boolean
domain_allowlist?: string[]
sitemap_urls?: string[]
seed_urls?: string[]
}
----
[discrete]
[[ConnectorDependency]]
=== ConnectorDependency
[source,ts,subs=+macros]
----
interface ConnectorDependency {
field: string
value: <<ScalarValue>>
}
----
[discrete]
[[ConnectorDisplayType]]
=== ConnectorDisplayType
[source,ts,subs=+macros]
----
type ConnectorDisplayType = 'textbox' | 'textarea' | 'numeric' | 'toggle' | 'dropdown'
----
[discrete]
[[ConnectorFeatureEnabled]]
=== ConnectorFeatureEnabled
[source,ts,subs=+macros]
----
interface ConnectorFeatureEnabled {
enabled: boolean
}
----
[discrete]
[[ConnectorFilteringAdvancedSnippet]]
=== ConnectorFilteringAdvancedSnippet
[source,ts,subs=+macros]
----
interface ConnectorFilteringAdvancedSnippet {
created_at?: <<DateTime>>
updated_at?: <<DateTime>>
value: any
}
----
[discrete]
[[ConnectorFilteringConfig]]
=== ConnectorFilteringConfig
[source,ts,subs=+macros]
----
interface ConnectorFilteringConfig {
active: <<ConnectorFilteringRules>>
domain?: string
draft: <<ConnectorFilteringRules>>
}
----
[discrete]
[[ConnectorFilteringPolicy]]
=== ConnectorFilteringPolicy
[source,ts,subs=+macros]
----
type ConnectorFilteringPolicy = 'exclude' | 'include'
----
[discrete]
[[ConnectorFilteringRule]]
=== ConnectorFilteringRule
[source,ts,subs=+macros]
----
interface ConnectorFilteringRule {
created_at?: <<DateTime>>
field: <<Field>>
id: <<Id>>
order: <<integer>>
policy: <<ConnectorFilteringPolicy>>
rule: <<ConnectorFilteringRuleRule>>
updated_at?: <<DateTime>>
value: string
}
----
[discrete]
[[ConnectorFilteringRuleRule]]
=== ConnectorFilteringRuleRule
[source,ts,subs=+macros]
----
type ConnectorFilteringRuleRule = 'contains' | 'ends_with' | 'equals' | 'regex' | 'starts_with' | '>' | '<'
----
[discrete]
[[ConnectorFilteringRules]]
=== ConnectorFilteringRules
[source,ts,subs=+macros]
----
interface ConnectorFilteringRules {
advanced_snippet: <<ConnectorFilteringAdvancedSnippet>>
rules: <<ConnectorFilteringRule>>[]
validation: <<ConnectorFilteringRulesValidation>>
}
----
[discrete]
[[ConnectorFilteringRulesValidation]]
=== ConnectorFilteringRulesValidation
[source,ts,subs=+macros]
----
interface ConnectorFilteringRulesValidation {
errors: <<ConnectorFilteringValidation>>[]
state: <<ConnectorFilteringValidationState>>
}
----
[discrete]
[[ConnectorFilteringValidation]]
=== ConnectorFilteringValidation
[source,ts,subs=+macros]
----
interface ConnectorFilteringValidation {
ids: <<Id>>[]
messages: string[]
}
----
[discrete]
[[ConnectorFilteringValidationState]]
=== ConnectorFilteringValidationState
[source,ts,subs=+macros]
----
type ConnectorFilteringValidationState = 'edited' | 'invalid' | 'valid'
----
[discrete]
[[ConnectorGreaterThanValidation]]
=== ConnectorGreaterThanValidation
[source,ts,subs=+macros]
----
interface ConnectorGreaterThanValidation {
type: 'greater_than'
constraint: <<double>>
}
----
[discrete]
[[ConnectorIncludedInValidation]]
=== ConnectorIncludedInValidation
[source,ts,subs=+macros]
----
interface ConnectorIncludedInValidation {
type: 'included_in'
constraint: <<ScalarValue>>[]
}
----
[discrete]
[[ConnectorIngestPipelineParams]]
=== ConnectorIngestPipelineParams
[source,ts,subs=+macros]
----
interface ConnectorIngestPipelineParams {
extract_binary_content: boolean
name: string
reduce_whitespace: boolean
run_ml_inference: boolean
}
----
[discrete]
[[ConnectorLessThanValidation]]
=== ConnectorLessThanValidation
[source,ts,subs=+macros]
----
interface ConnectorLessThanValidation {
type: 'less_than'
constraint: <<double>>
}
----
[discrete]
[[ConnectorListTypeValidation]]
=== ConnectorListTypeValidation
[source,ts,subs=+macros]
----
interface ConnectorListTypeValidation {
type: 'list_type'
constraint: string
}
----
[discrete]
[[ConnectorRegexValidation]]
=== ConnectorRegexValidation
[source,ts,subs=+macros]
----
interface ConnectorRegexValidation {
type: 'regex'
constraint: string
}
----
[discrete]
[[ConnectorSchedulingConfiguration]]
=== ConnectorSchedulingConfiguration
[source,ts,subs=+macros]
----
interface ConnectorSchedulingConfiguration {
access_control?: <<ConnectorConnectorScheduling>>
full?: <<ConnectorConnectorScheduling>>
incremental?: <<ConnectorConnectorScheduling>>
}
----
[discrete]
[[ConnectorSelectOption]]
=== ConnectorSelectOption
[source,ts,subs=+macros]
----
interface ConnectorSelectOption {
label: string
value: <<ScalarValue>>
}
----
[discrete]
[[ConnectorSyncJobConnectorReference]]
=== ConnectorSyncJobConnectorReference
[source,ts,subs=+macros]
----
interface ConnectorSyncJobConnectorReference {
configuration: <<ConnectorConnectorConfiguration>>
filtering: <<ConnectorFilteringRules>>
id: <<Id>>
index_name: string
language?: string
pipeline?: <<ConnectorIngestPipelineParams>>
service_type: string
sync_cursor?: any
}
----
[discrete]
[[ConnectorSyncJobTriggerMethod]]
=== ConnectorSyncJobTriggerMethod
[source,ts,subs=+macros]
----
type ConnectorSyncJobTriggerMethod = 'on_demand' | 'scheduled'
----
[discrete]
[[ConnectorSyncJobType]]
=== ConnectorSyncJobType
[source,ts,subs=+macros]
----
type ConnectorSyncJobType = 'full' | 'incremental' | 'access_control'
----
[discrete]
[[ConnectorSyncRulesFeature]]
=== ConnectorSyncRulesFeature
[source,ts,subs=+macros]
----
interface ConnectorSyncRulesFeature {
advanced?: <<ConnectorFeatureEnabled>>
basic?: <<ConnectorFeatureEnabled>>
}
----
[discrete]
[[ConnectorSyncStatus]]
=== ConnectorSyncStatus
[source,ts,subs=+macros]
----
type ConnectorSyncStatus = 'canceling' | 'canceled' | 'completed' | 'error' | 'in_progress' | 'pending' | 'suspended'
----
[discrete]
[[ConnectorValidation]]
=== ConnectorValidation
[source,ts,subs=+macros]
----
type ConnectorValidation = <<ConnectorLessThanValidation>> | <<ConnectorGreaterThanValidation>> | <<ConnectorListTypeValidation>> | <<ConnectorIncludedInValidation>> | <<ConnectorRegexValidation>>
----

View File

@ -0,0 +1,76 @@
[[reference-shared-types-enrich-types]]
=== `Enrich` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[EnrichPolicy]]
=== EnrichPolicy
[source,ts,subs=+macros]
----
interface EnrichPolicy {
enrich_fields: <<Fields>>
indices: <<Indices>>
match_field: <<Field>>
query?: <<QueryDslQueryContainer>>
name?: <<Name>>
elasticsearch_version?: string
}
----
[discrete]
[[EnrichPolicyType]]
=== EnrichPolicyType
[source,ts,subs=+macros]
----
type EnrichPolicyType = 'geo_match' | 'match' | 'range'
----
[discrete]
[[EnrichSummary]]
=== EnrichSummary
[source,ts,subs=+macros]
----
interface EnrichSummary {
config: Partial<Record<<<EnrichPolicyType>>, <<EnrichPolicy>>>>
}
----

View File

@ -0,0 +1,112 @@
[[reference-shared-types-eql-types]]
=== `Eql` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[EqlEqlHits]]
=== EqlEqlHits
[source,ts,subs=+macros]
----
interface EqlEqlHits<TEvent = unknown> {
pass:[/**] @property total <<Metadata>> about the number of matching events or sequences. */
total?: <<SearchTotalHits>>
pass:[/**] @property events Contains events matching the query. Each object represents a matching event. */
events?: <<EqlHitsEvent>><TEvent>[]
pass:[/**] @property sequences Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence. */
sequences?: <<EqlHitsSequence>><TEvent>[]
}
----
[discrete]
[[EqlEqlSearchResponseBase]]
=== EqlEqlSearchResponseBase
[source,ts,subs=+macros]
----
interface EqlEqlSearchResponseBase<TEvent = unknown> {
pass:[/**] @property id Identifier for the search. */
id?: <<Id>>
pass:[/**] @property is_partial If true, the response does not contain complete search results. */
is_partial?: boolean
pass:[/**] @property is_running If true, the search request is still executing. */
is_running?: boolean
pass:[/**] @property took Milliseconds it took Elasticsearch to execute the request. */
took?: <<DurationValue>><<<UnitMillis>>>
pass:[/**] @property timed_out If true, the request timed out before completion. */
timed_out?: boolean
pass:[/**] @property hits Contains matching events and sequences. Also contains related metadata. */
hits: <<EqlEqlHits>><TEvent>
}
----
[discrete]
[[EqlHitsEvent]]
=== EqlHitsEvent
[source,ts,subs=+macros]
----
interface EqlHitsEvent<TEvent = unknown> {
pass:[/**] @property _index <<Name>> of the index containing the event. */
_index: <<IndexName>>
pass:[/**] @property _id Unique identifier for the event. This ID is only unique within the index. */
_id: <<Id>>
pass:[/**] @property _source Original JSON body passed for the event at index time. */
_source: TEvent
pass:[/**] @property missing Set to `true` for events in a timespan-constrained sequence that do not meet a given condition. */
missing?: boolean
fields?: Record<<<Field>>, any[]>
}
----
[discrete]
[[EqlHitsSequence]]
=== EqlHitsSequence
[source,ts,subs=+macros]
----
interface EqlHitsSequence<TEvent = unknown> {
pass:[/**] @property events Contains events matching the query. Each object represents a matching event. */
events: <<EqlHitsEvent>><TEvent>[]
pass:[/**] @property join_keys Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax. */
join_keys?: any[]
}
----

View File

@ -0,0 +1,92 @@
[[reference-shared-types-esql-types]]
=== `Esql` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[EsqlTableValuesContainer]]
=== EsqlTableValuesContainer
[source,ts,subs=+macros]
----
interface EsqlTableValuesContainer {
<<integer>>?: <<EsqlTableValuesIntegerValue>>[]
keyword?: <<EsqlTableValuesKeywordValue>>[]
<<long>>?: <<EsqlTableValuesLongValue>>[]
<<double>>?: <<EsqlTableValuesLongDouble>>[]
}
----
[discrete]
[[EsqlTableValuesIntegerValue]]
=== EsqlTableValuesIntegerValue
[source,ts,subs=+macros]
----
type EsqlTableValuesIntegerValue = <<integer>> | <<integer>>[]
----
[discrete]
[[EsqlTableValuesKeywordValue]]
=== EsqlTableValuesKeywordValue
[source,ts,subs=+macros]
----
type EsqlTableValuesKeywordValue = string | string[]
----
[discrete]
[[EsqlTableValuesLongDouble]]
=== EsqlTableValuesLongDouble
[source,ts,subs=+macros]
----
type EsqlTableValuesLongDouble = <<double>> | <<double>>[]
----
[discrete]
[[EsqlTableValuesLongValue]]
=== EsqlTableValuesLongValue
[source,ts,subs=+macros]
----
type EsqlTableValuesLongValue = <<long>> | <<long>>[]
----

View File

@ -0,0 +1,50 @@
[[reference-shared-types-features-types]]
=== `Features` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[FeaturesFeature]]
=== FeaturesFeature
[source,ts,subs=+macros]
----
interface FeaturesFeature {
name: string
description: string
}
----

View File

@ -0,0 +1,47 @@
[[reference-shared-types-fleet-types]]
=== `Fleet` types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[FleetCheckpoint]]
=== FleetCheckpoint
[source,ts,subs=+macros]
----
type FleetCheckpoint = <<long>>
----

View File

@ -0,0 +1,241 @@
[[reference-shared-types-global-bulk]]
=== `Bulk` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[BulkCreateOperation]]
==== BulkCreateOperation
[source,ts,subs=+macros]
----
interface BulkCreateOperation extends <<BulkWriteOperation>> {}
----
[discrete]
[[BulkDeleteOperation]]
==== BulkDeleteOperation
[source,ts,subs=+macros]
----
interface BulkDeleteOperation extends <<BulkOperationBase>> {}
----
[discrete]
[[BulkIndexOperation]]
==== BulkIndexOperation
[source,ts,subs=+macros]
----
interface BulkIndexOperation extends <<BulkWriteOperation>> {}
----
[discrete]
[[BulkOperationBase]]
==== BulkOperationBase
[source,ts,subs=+macros]
----
interface BulkOperationBase {
pass:[/**] @property _id The document ID. */
_id?: <<Id>>
pass:[/**] @property _index <<Name>> of the index or index alias to perform the action on. */
_index?: <<IndexName>>
pass:[/**] @property routing Custom value used to route operations to a specific shard. */
routing?: <<Routing>>
if_primary_term?: <<long>>
if_seq_no?: <<SequenceNumber>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
}
----
[discrete]
[[BulkOperationContainer]]
==== BulkOperationContainer
[source,ts,subs=+macros]
----
interface BulkOperationContainer {
pass:[/**] @property index Indexes the specified document. If the document exists, replaces the document and increments the version. The following line must contain the source data to be indexed. */
index?: <<BulkIndexOperation>>
pass:[/**] @property create Indexes the specified document if it does not already exist. The following line must contain the source data to be indexed. */
create?: <<BulkCreateOperation>>
pass:[/**] @property update Performs a partial document update. The following line must contain the partial document and update options. */
update?: <<BulkUpdateOperation>>
pass:[/**] @property delete Removes the specified document from the index. */
delete?: <<BulkDeleteOperation>>
}
----
[discrete]
[[BulkOperationType]]
==== BulkOperationType
[source,ts,subs=+macros]
----
type BulkOperationType = 'index' | 'create' | 'update' | 'delete'
----
[discrete]
[[BulkRequest]]
==== BulkRequest
[source,ts,subs=+macros]
----
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
index?: <<IndexName>>
pipeline?: string
refresh?: <<Refresh>>
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
timeout?: <<Duration>>
wait_for_active_shards?: <<WaitForActiveShards>>
require_alias?: boolean
operations?: (<<BulkOperationContainer>> | <<BulkUpdateAction>><TDocument, TPartialDocument> | TDocument)[]
}
----
[discrete]
[[BulkResponse]]
==== BulkResponse
[source,ts,subs=+macros]
----
interface BulkResponse {
errors: boolean
items: Partial<Record<<<BulkOperationType>>, <<BulkResponseItem>>>>[]
took: <<long>>
ingest_took?: <<long>>
}
----
[discrete]
[[BulkResponseItem]]
==== BulkResponseItem
[source,ts,subs=+macros]
----
interface BulkResponseItem {
pass:[/**] @property _id The document ID associated with the operation. */
_id?: string | null
pass:[/**] @property _index <<Name>> of the index associated with the operation. If the operation targeted a data stream, this is the backing index into which the document was written. */
_index: string
pass:[/**] @property status HTTP status code returned for the operation. */
status: <<integer>>
pass:[/**] @property error Contains additional information about the failed operation. The parameter is only returned for failed operations. */
error?: <<ErrorCause>>
pass:[/**] @property _primary_term The primary term assigned to the document for the operation. */
_primary_term?: <<long>>
pass:[/**] @property result <<Result>> of the operation. Successful values are `created`, `deleted`, and `updated`. */
result?: string
pass:[/**] @property _seq_no The sequence number assigned to the document for the operation. Sequence numbers are used to ensure an older version of a document doesnt overwrite a newer version. */
_seq_no?: <<SequenceNumber>>
pass:[/**] @property _shards Contains shard information for the operation. */
_shards?: <<ShardStatistics>>
pass:[/**] @property _version The document version associated with the operation. The document version is incremented each time the document is updated. */
_version?: <<VersionNumber>>
forced_refresh?: boolean
get?: <<InlineGet>><Record<string, any>>
}
----
[discrete]
[[BulkUpdateAction]]
==== BulkUpdateAction
[source,ts,subs=+macros]
----
interface BulkUpdateAction<TDocument = unknown, TPartialDocument = unknown> {
pass:[/**] @property detect_noop Set to false to disable setting 'result' in the response to 'noop' if no change to the document occurred. */
detect_noop?: boolean
pass:[/**] @property doc A partial update to an existing document. */
doc?: TPartialDocument
pass:[/**] @property doc_as_upsert Set to true to use the contents of 'doc' as the value of 'upsert' */
doc_as_upsert?: boolean
pass:[/**] @property script <<Script>> to execute to update the document. */
script?: <<Script>> | string
pass:[/**] @property scripted_upsert Set to true to execute the script whether or not the document exists. */
scripted_upsert?: boolean
pass:[/**] @property _source Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve. */
_source?: <<SearchSourceConfig>>
pass:[/**] @property upsert If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is executed. */
upsert?: TDocument
}
----
[discrete]
[[BulkUpdateOperation]]
==== BulkUpdateOperation
[source,ts,subs=+macros]
----
interface BulkUpdateOperation extends <<BulkOperationBase>> {
pass:[/**] @property require_alias If `true`, the requests actions must target an index alias. */
require_alias?: boolean
retry_on_conflict?: <<integer>>
}
----
[discrete]
[[BulkWriteOperation]]
==== BulkWriteOperation
[source,ts,subs=+macros]
----
interface BulkWriteOperation extends <<BulkOperationBase>> {
pass:[/**] @property dynamic_templates A map from the full name of fields to the name of dynamic templates. Defaults to an empty map. If a name matches a dynamic template, then that template will be applied regardless of other match predicates defined in the template. If a field is already defined in the mapping, then this parameter wont be used. */
dynamic_templates?: Record<string, string>
pass:[/**] @property pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter. */
pipeline?: string
pass:[/**] @property require_alias If `true`, the requests actions must target an index alias. */
require_alias?: boolean
}
----

View File

@ -0,0 +1,62 @@
[[reference-shared-types-global-clear-scroll]]
=== `ClearScroll` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[ClearScrollRequest]]
==== ClearScrollRequest
[source,ts,subs=+macros]
----
interface ClearScrollRequest extends <<RequestBase>> {
scroll_id?: <<ScrollIds>>
}
----
[discrete]
[[ClearScrollResponse]]
==== ClearScrollResponse
[source,ts,subs=+macros]
----
interface ClearScrollResponse {
succeeded: boolean
num_freed: <<integer>>
}
----

View File

@ -0,0 +1,62 @@
[[reference-shared-types-global-close-point-in-time]]
=== `ClosePointInTime` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[ClosePointInTimeRequest]]
==== ClosePointInTimeRequest
[source,ts,subs=+macros]
----
interface ClosePointInTimeRequest extends <<RequestBase>> {
id: <<Id>>
}
----
[discrete]
[[ClosePointInTimeResponse]]
==== ClosePointInTimeResponse
[source,ts,subs=+macros]
----
interface ClosePointInTimeResponse {
succeeded: boolean
num_freed: <<integer>>
}
----

View File

@ -0,0 +1,77 @@
[[reference-shared-types-global-count]]
=== `Count` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[CountRequest]]
==== CountRequest
[source,ts,subs=+macros]
----
interface CountRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
expand_wildcards?: <<ExpandWildcards>>
ignore_throttled?: boolean
ignore_unavailable?: boolean
lenient?: boolean
min_score?: <<double>>
preference?: string
routing?: <<Routing>>
terminate_after?: <<long>>
q?: string
query?: <<QueryDslQueryContainer>>
}
----
[discrete]
[[CountResponse]]
==== CountResponse
[source,ts,subs=+macros]
----
interface CountResponse {
count: <<long>>
_shards: <<ShardStatistics>>
}
----

View File

@ -0,0 +1,68 @@
[[reference-shared-types-global-create]]
=== `Create` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[CreateRequest]]
==== CreateRequest
[source,ts,subs=+macros]
----
interface CreateRequest<TDocument = unknown> extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
pipeline?: string
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
document?: TDocument
}
----
[discrete]
[[CreateResponse]]
==== CreateResponse
[source,ts,subs=+macros]
----
type CreateResponse = <<WriteResponseBase>>
----

View File

@ -0,0 +1,60 @@
[[reference-shared-types-global-delete-by-query-rethrottle]]
=== `DeleteByQueryRethrottle` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[DeleteByQueryRethrottleRequest]]
==== DeleteByQueryRethrottleRequest
[source,ts,subs=+macros]
----
interface DeleteByQueryRethrottleRequest extends <<RequestBase>> {
task_id: <<TaskId>>
requests_per_second?: <<float>>
}
----
[discrete]
[[DeleteByQueryRethrottleResponse]]
==== DeleteByQueryRethrottleResponse
[source,ts,subs=+macros]
----
type DeleteByQueryRethrottleResponse = <<TasksTaskListResponseBase>>
----

View File

@ -0,0 +1,107 @@
[[reference-shared-types-global-delete-by-query]]
=== `DeleteByQuery` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[DeleteByQueryRequest]]
==== DeleteByQueryRequest
[source,ts,subs=+macros]
----
interface DeleteByQueryRequest extends <<RequestBase>> {
index: <<Indices>>
allow_no_indices?: boolean
analyzer?: string
analyze_wildcard?: boolean
conflicts?: <<Conflicts>>
default_operator?: <<QueryDslOperator>>
df?: string
expand_wildcards?: <<ExpandWildcards>>
from?: <<long>>
ignore_unavailable?: boolean
lenient?: boolean
preference?: string
refresh?: boolean
request_cache?: boolean
requests_per_second?: <<float>>
routing?: <<Routing>>
q?: string
scroll?: <<Duration>>
scroll_size?: <<long>>
search_timeout?: <<Duration>>
search_type?: <<SearchType>>
slices?: <<Slices>>
sort?: string[]
stats?: string[]
terminate_after?: <<long>>
timeout?: <<Duration>>
version?: boolean
wait_for_active_shards?: <<WaitForActiveShards>>
wait_for_completion?: boolean
max_docs?: <<long>>
query?: <<QueryDslQueryContainer>>
slice?: <<SlicedScroll>>
}
----
[discrete]
[[DeleteByQueryResponse]]
==== DeleteByQueryResponse
[source,ts,subs=+macros]
----
interface DeleteByQueryResponse {
batches?: <<long>>
deleted?: <<long>>
failures?: <<BulkIndexByScrollFailure>>[]
noops?: <<long>>
requests_per_second?: <<float>>
retries?: <<Retries>>
slice_id?: <<integer>>
task?: <<TaskId>>
throttled?: <<Duration>>
throttled_millis?: <<DurationValue>><<<UnitMillis>>>
throttled_until?: <<Duration>>
throttled_until_millis?: <<DurationValue>><<<UnitMillis>>>
timed_out?: boolean
took?: <<DurationValue>><<<UnitMillis>>>
total?: <<long>>
version_conflicts?: <<long>>
}
----

View File

@ -0,0 +1,61 @@
[[reference-shared-types-global-delete-script]]
=== `DeleteScript` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[DeleteScriptRequest]]
==== DeleteScriptRequest
[source,ts,subs=+macros]
----
interface DeleteScriptRequest extends <<RequestBase>> {
id: <<Id>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
----
[discrete]
[[DeleteScriptResponse]]
==== DeleteScriptResponse
[source,ts,subs=+macros]
----
type DeleteScriptResponse = <<AcknowledgedResponseBase>>
----

View File

@ -0,0 +1,68 @@
[[reference-shared-types-global-delete]]
=== `Delete` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[DeleteRequest]]
==== DeleteRequest
[source,ts,subs=+macros]
----
interface DeleteRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
if_primary_term?: <<long>>
if_seq_no?: <<SequenceNumber>>
refresh?: <<Refresh>>
routing?: <<Routing>>
timeout?: <<Duration>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
wait_for_active_shards?: <<WaitForActiveShards>>
}
----
[discrete]
[[DeleteResponse]]
==== DeleteResponse
[source,ts,subs=+macros]
----
type DeleteResponse = <<WriteResponseBase>>
----

View File

@ -0,0 +1,69 @@
[[reference-shared-types-global-exists-source]]
=== `ExistsSource` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[ExistsSourceRequest]]
==== ExistsSourceRequest
[source,ts,subs=+macros]
----
interface ExistsSourceRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
}
----
[discrete]
[[ExistsSourceResponse]]
==== ExistsSourceResponse
[source,ts,subs=+macros]
----
type ExistsSourceResponse = boolean
----

View File

@ -0,0 +1,70 @@
[[reference-shared-types-global-exists]]
=== `Exists` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[ExistsRequest]]
==== ExistsRequest
[source,ts,subs=+macros]
----
interface ExistsRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
preference?: string
realtime?: boolean
refresh?: boolean
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
version?: <<VersionNumber>>
version_type?: <<VersionType>>
}
----
[discrete]
[[ExistsResponse]]
==== ExistsResponse
[source,ts,subs=+macros]
----
type ExistsResponse = boolean
----

View File

@ -0,0 +1,107 @@
[[reference-shared-types-global-explain]]
=== `Explain` request types
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[ExplainExplanation]]
==== ExplainExplanation
[source,ts,subs=+macros]
----
interface ExplainExplanation {
description: string
details: <<ExplainExplanationDetail>>[]
value: <<float>>
}
----
[discrete]
[[ExplainExplanationDetail]]
==== ExplainExplanationDetail
[source,ts,subs=+macros]
----
interface ExplainExplanationDetail {
description: string
details?: <<ExplainExplanationDetail>>[]
value: <<float>>
}
----
[discrete]
[[ExplainRequest]]
==== ExplainRequest
[source,ts,subs=+macros]
----
interface ExplainRequest extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
analyzer?: string
analyze_wildcard?: boolean
default_operator?: <<QueryDslOperator>>
df?: string
lenient?: boolean
preference?: string
routing?: <<Routing>>
_source?: <<SearchSourceConfigParam>>
_source_excludes?: <<Fields>>
_source_includes?: <<Fields>>
stored_fields?: <<Fields>>
q?: string
query?: <<QueryDslQueryContainer>>
}
----
[discrete]
[[ExplainResponse]]
==== ExplainResponse
[source,ts,subs=+macros]
----
interface ExplainResponse<TDocument = unknown> {
_index: <<IndexName>>
_id: <<Id>>
matched: boolean
explanation?: <<ExplainExplanationDetail>>
get?: <<InlineGet>><TDocument>
}
----

Some files were not shown because too many files have changed in this diff Show More