More docs changes
This commit is contained in:
Josh Mock
File diff suppressed because it is too large
Load Diff
@ -1,68 +0,0 @@
|
||||
[[reference-async_search-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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(AsyncSearchDeleteRequest, options?): Promise<AsyncSearchDeleteResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface AsyncSearchDeleteRequest extends <<RequestBase>> {
|
||||
id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AsyncSearchDeleteResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-async_search-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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(AsyncSearchGetRequest, options?): 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>
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-async_search-status]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(AsyncSearchStatusRequest, options?): Promise<AsyncSearchStatusResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface AsyncSearchStatusRequest extends <<RequestBase>> {
|
||||
id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
|
||||
|
||||
----
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
[[reference-async_search-submit]]
|
||||
[[reference-async_search]]
|
||||
== client.asyncSearch
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
@ -32,18 +33,134 @@
|
||||
</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>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.asyncSearch.submit]]
|
||||
== 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
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(AsyncSearchSubmitRequest, options?): Promise<AsyncSearchSubmitResponse>
|
||||
(request: AsyncSearchSubmitRequest, options?: TransportRequestOptions) => Promise<AsyncSearchSubmitResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
@ -123,6 +240,7 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
@ -132,3 +250,4 @@ type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<Agg
|
||||
|
||||
----
|
||||
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-autoscaling-delete_autoscaling_policy]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(AutoscalingDeleteAutoscalingPolicyRequest, options?): Promise<AutoscalingDeleteAutoscalingPolicyResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-autoscaling-get_autoscaling_policy]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(AutoscalingGetAutoscalingPolicyRequest, options?): Promise<AutoscalingGetAutoscalingPolicyResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AutoscalingGetAutoscalingPolicyResponse = <<AutoscalingAutoscalingPolicy>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-autoscaling-put_autoscaling_policy]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(AutoscalingPutAutoscalingPolicyRequest, options?): Promise<AutoscalingPutAutoscalingPolicyResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
policy?: <<AutoscalingAutoscalingPolicy>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AutoscalingPutAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
[[reference-autoscaling-get_autoscaling_capacity]]
|
||||
[[reference-autoscaling]]
|
||||
== client.autoscaling
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
@ -32,18 +33,57 @@
|
||||
</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>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.autoscaling.getAutoscalingCapacity]]
|
||||
== 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 operator’s 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
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(AutoscalingGetAutoscalingCapacityRequest, options?): Promise<AutoscalingGetAutoscalingCapacityResponse>
|
||||
(request: AutoscalingGetAutoscalingCapacityRequest, options?: TransportRequestOptions) => Promise<AutoscalingGetAutoscalingCapacityResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
@ -55,6 +95,7 @@ interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
@ -66,3 +107,79 @@ interface AutoscalingGetAutoscalingCapacityResponse {
|
||||
|
||||
----
|
||||
|
||||
|
||||
[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>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
|
||||
[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>>
|
||||
policy?: <<AutoscalingAutoscalingPolicy>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type AutoscalingPutAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
[[reference-bulk]]
|
||||
== client.bulk
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
@ -32,18 +33,20 @@
|
||||
</style>
|
||||
++++
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.bulk]]
|
||||
== 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
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(BulkRequest, options?): Promise<BulkResponse>
|
||||
(request: BulkRequest, options?: TransportRequestOptions) => Promise<BulkResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
@ -67,6 +70,7 @@ interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
@ -81,3 +85,4 @@ interface BulkResponse {
|
||||
|
||||
----
|
||||
|
||||
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-aliases]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.aliases]]
|
||||
== client.cat.aliases
|
||||
|
||||
Get aliases. Retrieves the cluster’s index aliases, including filter and routing information. The API does not return data stream aliases. CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.
|
||||
|
||||
{ref}/cat-alias.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatAliasesRequest, options?): Promise<CatAliasesResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatAliasesRequest extends <<CatCatRequestBase>> {
|
||||
name?: <<Names>>
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatAliasesResponse = CatAliasesAliasesRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-allocation]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.allocation]]
|
||||
== client.cat.allocation
|
||||
|
||||
Provides a snapshot of the number of shards allocated to each data node and their disk space. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
||||
|
||||
{ref}/cat-allocation.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatAllocationRequest, options?): Promise<CatAllocationResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatAllocationRequest extends <<CatCatRequestBase>> {
|
||||
node_id?: <<NodeIds>>
|
||||
bytes?: <<Bytes>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatAllocationResponse = CatAllocationAllocationRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-cat-component_templates]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.componentTemplates]]
|
||||
== client.cat.componentTemplates
|
||||
|
||||
Get component templates. Returns information about component templates in a cluster. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get component template API.
|
||||
|
||||
{ref}/cat-component-templates.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatComponentTemplatesRequest, options?): Promise<CatComponentTemplatesResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatComponentTemplatesRequest extends <<CatCatRequestBase>> {
|
||||
name?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-cat-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>
|
||||
++++
|
||||
|
||||
[[client.cat.count]]
|
||||
== client.cat.count
|
||||
|
||||
Get a document count. Provides quick access to a document count for a data stream, an index, or an entire cluster. The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the count API.
|
||||
|
||||
{ref}/cat-count.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatCountRequest, options?): Promise<CatCountResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatCountRequest extends <<CatCatRequestBase>> {
|
||||
index?: <<Indices>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatCountResponse = CatCountCountRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-fielddata]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.fielddata]]
|
||||
== client.cat.fielddata
|
||||
|
||||
Returns the amount of heap memory currently used by the field data cache on every data node in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes stats API.
|
||||
|
||||
{ref}/cat-fielddata.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatFielddataRequest, options?): Promise<CatFielddataResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatFielddataRequest extends <<CatCatRequestBase>> {
|
||||
fields?: <<Fields>>
|
||||
bytes?: <<Bytes>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatFielddataResponse = CatFielddataFielddataRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-health]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.health]]
|
||||
== client.cat.health
|
||||
|
||||
Returns the health status of a cluster, similar to the cluster health API. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the cluster health API. This API is often used to check malfunctioning clusters. To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: `HH:MM:SS`, which is human-readable but includes no date information; `Unix epoch time`, which is machine-sortable and includes date information. The latter format is useful for cluster recoveries that take multiple days. You can use the cat health API to verify cluster health across multiple nodes. You also can use the API to track the recovery of a large cluster over a longer period of time.
|
||||
|
||||
{ref}/cat-health.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatHealthRequest, options?): Promise<CatHealthResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatHealthRequest extends <<CatCatRequestBase>> {
|
||||
time?: <<TimeUnit>>
|
||||
ts?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatHealthResponse = CatHealthHealthRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
[[reference-cat-help]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.help]]
|
||||
== client.cat.help
|
||||
|
||||
Get CAT help. Returns help for the CAT APIs.
|
||||
|
||||
{ref}/cat.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatHelpRequest, options?): Promise<CatHelpResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatHelpRequest extends <<CatCatRequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatHelpResponse = CatHelpHelpRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
[[reference-cat-indices]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.indices]]
|
||||
== client.cat.indices
|
||||
|
||||
Get index information. Returns high-level information about indices in a cluster, including backing indices for data streams. Use this request to get the following information for each index in a cluster: - shard count - document count - deleted document count - primary store size - total store size of all shards, including shard replicas These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. To get an accurate count of Elasticsearch documents, use the cat count or count APIs. CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use an index endpoint.
|
||||
|
||||
{ref}/cat-indices.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatIndicesRequest, options?): Promise<CatIndicesResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatIndicesRequest extends <<CatCatRequestBase>> {
|
||||
index?: <<Indices>>
|
||||
bytes?: <<Bytes>>
|
||||
expand_wildcards?: <<ExpandWildcards>>
|
||||
health?: <<HealthStatus>>
|
||||
include_unloaded_segments?: boolean
|
||||
pri?: boolean
|
||||
time?: <<TimeUnit>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatIndicesResponse = CatIndicesIndicesRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
[[reference-cat-master]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.master]]
|
||||
== client.cat.master
|
||||
|
||||
Returns information about the master node, including the ID, bound IP address, and name. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-master.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatMasterRequest, options?): Promise<CatMasterResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatMasterRequest extends <<CatCatRequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatMasterResponse = CatMasterMasterRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,73 +0,0 @@
|
||||
[[reference-cat-ml_data_frame_analytics]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.mlDataFrameAnalytics]]
|
||||
== client.cat.mlDataFrameAnalytics
|
||||
|
||||
Get data frame analytics jobs. Returns configuration and usage information about data frame analytics jobs. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get data frame analytics jobs statistics API.
|
||||
|
||||
{ref}/cat-dfanalytics.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatMlDataFrameAnalyticsRequest, options?): Promise<CatMlDataFrameAnalyticsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatMlDataFrameAnalyticsRequest extends <<CatCatRequestBase>> {
|
||||
id?: <<Id>>
|
||||
allow_no_match?: boolean
|
||||
bytes?: <<Bytes>>
|
||||
h?: <<CatCatDfaColumns>>
|
||||
s?: <<CatCatDfaColumns>>
|
||||
time?: <<Duration>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,72 +0,0 @@
|
||||
[[reference-cat-ml_datafeeds]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.mlDatafeeds]]
|
||||
== client.cat.mlDatafeeds
|
||||
|
||||
Get datafeeds. Returns configuration and usage information about datafeeds. This API returns a maximum of 10,000 datafeeds. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get datafeed statistics API.
|
||||
|
||||
{ref}/cat-datafeeds.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatMlDatafeedsRequest, options?): Promise<CatMlDatafeedsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatMlDatafeedsRequest extends <<CatCatRequestBase>> {
|
||||
datafeed_id?: <<Id>>
|
||||
allow_no_match?: boolean
|
||||
h?: <<CatCatDatafeedColumns>>
|
||||
s?: <<CatCatDatafeedColumns>>
|
||||
time?: <<TimeUnit>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,73 +0,0 @@
|
||||
[[reference-cat-ml_jobs]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.mlJobs]]
|
||||
== client.cat.mlJobs
|
||||
|
||||
Get anomaly detection jobs. Returns configuration and usage information for anomaly detection jobs. This API returns a maximum of 10,000 jobs. If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get anomaly detection job statistics API.
|
||||
|
||||
{ref}/cat-anomaly-detectors.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatMlJobsRequest, options?): Promise<CatMlJobsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatMlJobsRequest extends <<CatCatRequestBase>> {
|
||||
job_id?: <<Id>>
|
||||
allow_no_match?: boolean
|
||||
bytes?: <<Bytes>>
|
||||
h?: <<CatCatAnonalyDetectorColumns>>
|
||||
s?: <<CatCatAnonalyDetectorColumns>>
|
||||
time?: <<TimeUnit>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatMlJobsResponse = CatMlJobsJobsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
[[reference-cat-ml_trained_models]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.mlTrainedModels]]
|
||||
== client.cat.mlTrainedModels
|
||||
|
||||
Get trained models. Returns configuration and usage information about inference trained models. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get trained models statistics API.
|
||||
|
||||
{ref}/cat-trained-model.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatMlTrainedModelsRequest, options?): Promise<CatMlTrainedModelsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatMlTrainedModelsRequest extends <<CatCatRequestBase>> {
|
||||
model_id?: <<Id>>
|
||||
allow_no_match?: boolean
|
||||
bytes?: <<Bytes>>
|
||||
h?: <<CatCatTrainedModelsColumns>>
|
||||
s?: <<CatCatTrainedModelsColumns>>
|
||||
from?: <<integer>>
|
||||
size?: <<integer>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
[[reference-cat-nodeattrs]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.nodeattrs]]
|
||||
== client.cat.nodeattrs
|
||||
|
||||
Returns information about custom node attributes. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-nodeattrs.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatNodeattrsRequest, options?): Promise<CatNodeattrsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatNodeattrsRequest extends <<CatCatRequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-cat-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>
|
||||
++++
|
||||
|
||||
[[client.cat.nodes]]
|
||||
== client.cat.nodes
|
||||
|
||||
Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-nodes.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatNodesRequest, options?): Promise<CatNodesResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatNodesRequest extends <<CatCatRequestBase>> {
|
||||
bytes?: <<Bytes>>
|
||||
full_id?: boolean | string
|
||||
include_unloaded_segments?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatNodesResponse = CatNodesNodesRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
[[reference-cat-pending_tasks]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.pendingTasks]]
|
||||
== client.cat.pendingTasks
|
||||
|
||||
Returns cluster-level changes that have not yet been executed. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.
|
||||
|
||||
{ref}/cat-pending-tasks.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatPendingTasksRequest, options?): Promise<CatPendingTasksResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatPendingTasksRequest extends <<CatCatRequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
[[reference-cat-plugins]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.plugins]]
|
||||
== client.cat.plugins
|
||||
|
||||
Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-plugins.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatPluginsRequest, options?): Promise<CatPluginsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatPluginsRequest extends <<CatCatRequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatPluginsResponse = CatPluginsPluginsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-cat-recovery]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.recovery]]
|
||||
== client.cat.recovery
|
||||
|
||||
Returns information about ongoing and completed shard recoveries. Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. For data streams, the API returns information about the stream’s backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.
|
||||
|
||||
{ref}/cat-recovery.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatRecoveryRequest, options?): Promise<CatRecoveryResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatRecoveryRequest extends <<CatCatRequestBase>> {
|
||||
index?: <<Indices>>
|
||||
active_only?: boolean
|
||||
bytes?: <<Bytes>>
|
||||
detailed?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatRecoveryResponse = CatRecoveryRecoveryRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
[[reference-cat-repositories]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.repositories]]
|
||||
== client.cat.repositories
|
||||
|
||||
Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.
|
||||
|
||||
{ref}/cat-repositories.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatRepositoriesRequest, options?): Promise<CatRepositoriesResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatRepositoriesRequest extends <<CatCatRequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-segments]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.segments]]
|
||||
== client.cat.segments
|
||||
|
||||
Returns low-level information about the Lucene segments in index shards. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.
|
||||
|
||||
{ref}/cat-segments.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatSegmentsRequest, options?): Promise<CatSegmentsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatSegmentsRequest extends <<CatCatRequestBase>> {
|
||||
index?: <<Indices>>
|
||||
bytes?: <<Bytes>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatSegmentsResponse = CatSegmentsSegmentsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-shards]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.shards]]
|
||||
== client.cat.shards
|
||||
|
||||
Returns information about the shards in a cluster. For data streams, the API returns information about the backing indices. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.
|
||||
|
||||
{ref}/cat-shards.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatShardsRequest, options?): Promise<CatShardsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatShardsRequest extends <<CatCatRequestBase>> {
|
||||
index?: <<Indices>>
|
||||
bytes?: <<Bytes>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatShardsResponse = CatShardsShardsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-snapshots]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.snapshots]]
|
||||
== client.cat.snapshots
|
||||
|
||||
Returns information about the snapshots stored in one or more repositories. A snapshot is a backup of an index or running Elasticsearch cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.
|
||||
|
||||
{ref}/cat-snapshots.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatSnapshotsRequest, options?): Promise<CatSnapshotsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatSnapshotsRequest extends <<CatCatRequestBase>> {
|
||||
repository?: <<Names>>
|
||||
ignore_unavailable?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-cat-tasks]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.tasks]]
|
||||
== client.cat.tasks
|
||||
|
||||
Returns information about tasks currently executing in the cluster. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
|
||||
|
||||
{ref}/tasks.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatTasksRequest, options?): Promise<CatTasksResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatTasksRequest extends <<CatCatRequestBase>> {
|
||||
actions?: string[]
|
||||
detailed?: boolean
|
||||
node_id?: string[]
|
||||
parent_task_id?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatTasksResponse = CatTasksTasksRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-cat-templates]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.templates]]
|
||||
== client.cat.templates
|
||||
|
||||
Returns information about index templates in a cluster. You can use index templates to apply index settings and field mappings to new indices at creation. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.
|
||||
|
||||
{ref}/cat-templates.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatTemplatesRequest, options?): Promise<CatTemplatesResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatTemplatesRequest extends <<CatCatRequestBase>> {
|
||||
name?: <<Name>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatTemplatesResponse = CatTemplatesTemplatesRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-cat-thread_pool]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.threadPool]]
|
||||
== client.cat.threadPool
|
||||
|
||||
Returns thread pool statistics for each node in a cluster. Returned information includes all built-in thread pools and custom thread pools. IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.
|
||||
|
||||
{ref}/cat-thread-pool.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatThreadPoolRequest, options?): Promise<CatThreadPoolResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatThreadPoolRequest extends <<CatCatRequestBase>> {
|
||||
thread_pool_patterns?: <<Names>>
|
||||
time?: <<TimeUnit>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[]
|
||||
|
||||
----
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
[[reference-cat-transforms]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cat.transforms]]
|
||||
== client.cat.transforms
|
||||
|
||||
Get transforms. Returns configuration and usage information about transforms. CAT APIs are only intended for human consumption using the Kibana console or command line. They are not intended for use by applications. For application consumption, use the get transform statistics API.
|
||||
|
||||
{ref}/cat-transforms.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CatTransformsRequest, options?): Promise<CatTransformsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CatTransformsRequest extends <<CatCatRequestBase>> {
|
||||
transform_id?: <<Id>>
|
||||
allow_no_match?: boolean
|
||||
from?: <<integer>>
|
||||
h?: <<CatCatTransformColumns>>
|
||||
s?: <<CatCatTransformColumns>>
|
||||
time?: <<TimeUnit>>
|
||||
size?: <<integer>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CatTransformsResponse = CatTransformsTransformsRecord[]
|
||||
|
||||
----
|
||||
|
||||
1034
docs/reference/cat.asciidoc
Normal file
1034
docs/reference/cat.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
@ -1,68 +0,0 @@
|
||||
[[reference-ccr-delete_auto_follow_pattern]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.ccr.deleteAutoFollowPattern]]
|
||||
== client.ccr.deleteAutoFollowPattern
|
||||
|
||||
Deletes auto-follow patterns.
|
||||
|
||||
{ref}/ccr-delete-auto-follow-pattern.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(CcrDeleteAutoFollowPatternRequest, options?): Promise<CcrDeleteAutoFollowPatternResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrDeleteAutoFollowPatternRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CcrDeleteAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,85 +0,0 @@
|
||||
[[reference-ccr-follow]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrFollowRequest, options?): Promise<CcrFollowResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrFollowRequest extends <<RequestBase>> {
|
||||
index: <<IndexName>>
|
||||
wait_for_active_shards?: <<WaitForActiveShards>>
|
||||
leader_index?: <<IndexName>>
|
||||
max_outstanding_read_requests?: <<long>>
|
||||
max_outstanding_write_requests?: <<long>>
|
||||
max_read_request_operation_count?: <<long>>
|
||||
max_read_request_size?: string
|
||||
max_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>>
|
||||
remote_cluster?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrFollowResponse {
|
||||
follow_index_created: boolean
|
||||
follow_index_shards_acked: boolean
|
||||
index_following_started: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-ccr-follow_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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrFollowInfoRequest, options?): 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[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-ccr-follow_stats]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrFollowStatsRequest, options?): Promise<CcrFollowStatsResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrFollowStatsRequest extends <<RequestBase>> {
|
||||
index: <<Indices>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrFollowStatsResponse {
|
||||
indices: <<CcrFollowIndexStats>>[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
[[reference-ccr-forget_follower]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrForgetFollowerRequest, options?): 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>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-ccr-get_auto_follow_pattern]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrGetAutoFollowPatternRequest, options?): Promise<CcrGetAutoFollowPatternResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrGetAutoFollowPatternRequest extends <<RequestBase>> {
|
||||
name?: <<Name>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrGetAutoFollowPatternResponse {
|
||||
patterns: CcrGetAutoFollowPatternAutoFollowPattern[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-ccr-pause_auto_follow_pattern]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrPauseAutoFollowPatternRequest, options?): Promise<CcrPauseAutoFollowPatternResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrPauseAutoFollowPatternRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CcrPauseAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-ccr-pause_follow]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrPauseFollowRequest, options?): Promise<CcrPauseFollowResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrPauseFollowRequest extends <<RequestBase>> {
|
||||
index: <<IndexName>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CcrPauseFollowResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,83 +0,0 @@
|
||||
[[reference-ccr-put_auto_follow_pattern]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrPutAutoFollowPatternRequest, options?): 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>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-ccr-resume_auto_follow_pattern]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrResumeAutoFollowPatternRequest, options?): Promise<CcrResumeAutoFollowPatternResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrResumeAutoFollowPatternRequest extends <<RequestBase>> {
|
||||
name: <<Name>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CcrResumeAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,78 +0,0 @@
|
||||
[[reference-ccr-resume_follow]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrResumeFollowRequest, options?): 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>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-ccr-stats]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrStatsRequest, options?): 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
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-ccr-unfollow]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(CcrUnfollowRequest, options?): Promise<CcrUnfollowResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface CcrUnfollowRequest extends <<RequestBase>> {
|
||||
index: <<IndexName>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type CcrUnfollowResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
572
docs/reference/ccr.asciidoc
Normal file
572
docs/reference/ccr.asciidoc
Normal file
@ -0,0 +1,572 @@
|
||||
[[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>>
|
||||
leader_index?: <<IndexName>>
|
||||
max_outstanding_read_requests?: <<long>>
|
||||
max_outstanding_write_requests?: <<long>>
|
||||
max_read_request_operation_count?: <<long>>
|
||||
max_read_request_size?: string
|
||||
max_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>>
|
||||
remote_cluster?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
|
||||
[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>>
|
||||
|
||||
----
|
||||
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
[[reference-clear_scroll]]
|
||||
== client.clearScroll
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
@ -32,18 +33,20 @@
|
||||
</style>
|
||||
++++
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.clearScroll]]
|
||||
== 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
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ClearScrollRequest, options?): Promise<ClearScrollResponse>
|
||||
(request: ClearScrollRequest, options?: TransportRequestOptions) => Promise<ClearScrollResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
@ -57,6 +60,7 @@ interface ClearScrollRequest extends <<RequestBase>> {
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
@ -69,3 +73,4 @@ interface ClearScrollResponse {
|
||||
|
||||
----
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
[[reference-close_point_in_time]]
|
||||
== client.closePointInTime
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
@ -32,18 +33,20 @@
|
||||
</style>
|
||||
++++
|
||||
|
||||
|
||||
[discrete]
|
||||
[[client.closePointInTime]]
|
||||
== 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
|
||||
=== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ClosePointInTimeRequest, options?): Promise<ClosePointInTimeResponse>
|
||||
(request: ClosePointInTimeRequest, options?: TransportRequestOptions) => Promise<ClosePointInTimeResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
@ -57,6 +60,7 @@ interface ClosePointInTimeRequest extends <<RequestBase>> {
|
||||
|
||||
----
|
||||
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
@ -69,3 +73,4 @@ interface ClosePointInTimeResponse {
|
||||
|
||||
----
|
||||
|
||||
|
||||
|
||||
@ -1,99 +0,0 @@
|
||||
[[reference-cluster-allocation_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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterAllocationExplainRequest, options?): 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
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-cluster-delete_component_template]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterDeleteComponentTemplateRequest, options?): 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>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-cluster-delete_voting_config_exclusions]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cluster.deleteVotingConfigExclusions]]
|
||||
== client.cluster.deleteVotingConfigExclusions
|
||||
|
||||
Clears cluster voting config exclusions.
|
||||
|
||||
{ref}/voting-config-exclusions.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ClusterDeleteVotingConfigExclusionsRequest, options?): 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
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-cluster-exists_component_template]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterExistsComponentTemplateRequest, options?): 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
|
||||
|
||||
----
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
[[reference-cluster-get_component_template]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterGetComponentTemplateRequest, options?): 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>>[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,75 +0,0 @@
|
||||
[[reference-cluster-get_settings]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterGetSettingsRequest, options?): 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>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,79 +0,0 @@
|
||||
[[reference-cluster-health]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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 stream’s 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]
|
||||
----
|
||||
(ClusterHealthRequest, options?): 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
|
||||
|
||||
----
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
[[reference-cluster-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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterInfoRequest, options?): 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>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-cluster-pending_tasks]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterPendingTasksRequest, options?): 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[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-cluster-post_voting_config_exclusions]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterPostVotingConfigExclusionsRequest, options?): 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
|
||||
|
||||
----
|
||||
|
||||
@ -1,74 +0,0 @@
|
||||
[[reference-cluster-put_component_template]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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 template’s `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 stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s 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]
|
||||
----
|
||||
(ClusterPutComponentTemplateRequest, options?): 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>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,76 +0,0 @@
|
||||
[[reference-cluster-put_settings]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.cluster.putSettings]]
|
||||
== client.cluster.putSettings
|
||||
|
||||
Updates the cluster settings.
|
||||
|
||||
{ref}/cluster-update-settings.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ClusterPutSettingsRequest, options?): 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>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,66 +0,0 @@
|
||||
[[reference-cluster-remote_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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterRemoteInfoRequest, options?): Promise<ClusterRemoteInfoResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ClusterRemoteInfoRequest extends <<RequestBase>> {}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type ClusterRemoteInfoResponse = Record<string, ClusterRemoteInfoClusterRemoteInfo>
|
||||
|
||||
----
|
||||
|
||||
@ -1,78 +0,0 @@
|
||||
[[reference-cluster-reroute]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterRerouteRequest, options?): 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
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,77 +0,0 @@
|
||||
[[reference-cluster-state]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterStateRequest, options?): 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
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-cluster-stats]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[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]
|
||||
----
|
||||
(ClusterStatsRequest, options?): 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
|
||||
|
||||
----
|
||||
|
||||
731
docs/reference/cluster.asciidoc
Normal file
731
docs/reference/cluster.asciidoc
Normal 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 stream’s 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 template’s `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 stream’s backing indices. Changes to component templates do not affect existing indices, including a stream’s 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
|
||||
|
||||
----
|
||||
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-connector-check_in]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.checkIn]]
|
||||
== client.connector.checkIn
|
||||
|
||||
Check in a connector. Update the `last_seen` field in the connector and set it to the current timestamp.
|
||||
|
||||
{ref}/check-in-connector-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorCheckInRequest, options?): Promise<ConnectorCheckInResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorCheckInRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorCheckInResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-connector-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>
|
||||
++++
|
||||
|
||||
[[client.connector.delete]]
|
||||
== client.connector.delete
|
||||
|
||||
Delete a connector. Removes a connector and associated sync jobs. This is a destructive action that is not recoverable. NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. These need to be removed manually.
|
||||
|
||||
{ref}/delete-connector-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorDeleteRequest, options?): Promise<ConnectorDeleteResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorDeleteRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
delete_sync_jobs?: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type ConnectorDeleteResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-connector-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>
|
||||
++++
|
||||
|
||||
[[client.connector.get]]
|
||||
== client.connector.get
|
||||
|
||||
Get a connector. Get the details about a connector.
|
||||
|
||||
{ref}/get-connector-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorGetRequest, options?): Promise<ConnectorGetResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorGetRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type ConnectorGetResponse = <<ConnectorConnector>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,76 +0,0 @@
|
||||
[[reference-connector-list]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.list]]
|
||||
== client.connector.list
|
||||
|
||||
Get all connectors. Get information about all connectors.
|
||||
|
||||
{ref}/list-connector-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorListRequest, options?): Promise<ConnectorListResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorListRequest extends <<RequestBase>> {
|
||||
from?: <<integer>>
|
||||
size?: <<integer>>
|
||||
index_name?: <<Indices>>
|
||||
connector_name?: <<Names>>
|
||||
service_type?: <<Names>>
|
||||
query?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorListResponse {
|
||||
count: <<long>>
|
||||
results: <<ConnectorConnector>>[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,76 +0,0 @@
|
||||
[[reference-connector-post]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.post]]
|
||||
== client.connector.post
|
||||
|
||||
Create a connector. Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. Self-managed connectors (Connector clients) are self-managed on your infrastructure.
|
||||
|
||||
{ref}/create-connector-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorPostRequest, options?): Promise<ConnectorPostResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorPostRequest extends <<RequestBase>> {
|
||||
description?: string
|
||||
index_name?: <<IndexName>>
|
||||
is_native?: boolean
|
||||
language?: string
|
||||
name?: string
|
||||
service_type?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorPostResponse {
|
||||
result: <<Result>>
|
||||
id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,77 +0,0 @@
|
||||
[[reference-connector-put]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.put]]
|
||||
== client.connector.put
|
||||
|
||||
Create or update a connector.
|
||||
|
||||
{ref}/create-connector-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorPutRequest, options?): Promise<ConnectorPutResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorPutRequest extends <<RequestBase>> {
|
||||
connector_id?: <<Id>>
|
||||
description?: string
|
||||
index_name?: <<IndexName>>
|
||||
is_native?: boolean
|
||||
language?: string
|
||||
name?: string
|
||||
service_type?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorPutResponse {
|
||||
result: <<Result>>
|
||||
id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-connector-sync_job_cancel]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobCancel]]
|
||||
== client.connector.syncJobCancel
|
||||
|
||||
Cancel a connector sync job. Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. The connector service is then responsible for setting the status of connector sync jobs to cancelled.
|
||||
|
||||
{ref}/cancel-connector-sync-job-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobCancelRequest, options?): Promise<ConnectorSyncJobCancelResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobCancelRequest extends <<RequestBase>> {
|
||||
connector_sync_job_id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobCancelResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
[[reference-connector-sync_job_check_in]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobCheckIn]]
|
||||
== client.connector.syncJobCheckIn
|
||||
|
||||
Checks in a connector sync job (refreshes 'last_seen').
|
||||
|
||||
{ref}/check-in-connector-sync-job-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobCheckInRequest, options?): Promise<ConnectorSyncJobCheckInResponse>
|
||||
----
|
||||
|
||||
@ -1,46 +0,0 @@
|
||||
[[reference-connector-sync_job_claim]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobClaim]]
|
||||
== client.connector.syncJobClaim
|
||||
|
||||
Claims a connector sync job.
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobClaimRequest, options?): Promise<ConnectorSyncJobClaimResponse>
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-connector-sync_job_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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobDelete]]
|
||||
== client.connector.syncJobDelete
|
||||
|
||||
Delete a connector sync job. Remove a connector sync job and its associated data. This is a destructive action that is not recoverable.
|
||||
|
||||
{ref}/delete-connector-sync-job-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobDeleteRequest, options?): Promise<ConnectorSyncJobDeleteResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobDeleteRequest extends <<RequestBase>> {
|
||||
connector_sync_job_id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type ConnectorSyncJobDeleteResponse = <<AcknowledgedResponseBase>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
[[reference-connector-sync_job_error]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobError]]
|
||||
== client.connector.syncJobError
|
||||
|
||||
Sets an error for a connector sync job.
|
||||
|
||||
{ref}/set-connector-sync-job-error-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobErrorRequest, options?): Promise<ConnectorSyncJobErrorResponse>
|
||||
----
|
||||
|
||||
@ -1,68 +0,0 @@
|
||||
[[reference-connector-sync_job_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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobGet]]
|
||||
== client.connector.syncJobGet
|
||||
|
||||
Get a connector sync job.
|
||||
|
||||
{ref}/get-connector-sync-job-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobGetRequest, options?): Promise<ConnectorSyncJobGetResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobGetRequest extends <<RequestBase>> {
|
||||
connector_sync_job_id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
type ConnectorSyncJobGetResponse = <<ConnectorConnectorSyncJob>>
|
||||
|
||||
----
|
||||
|
||||
@ -1,75 +0,0 @@
|
||||
[[reference-connector-sync_job_list]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobList]]
|
||||
== client.connector.syncJobList
|
||||
|
||||
Get all connector sync jobs. Get information about all stored connector sync jobs listed by their creation date in ascending order.
|
||||
|
||||
{ref}/list-connector-sync-jobs-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobListRequest, options?): Promise<ConnectorSyncJobListResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobListRequest extends <<RequestBase>> {
|
||||
from?: <<integer>>
|
||||
size?: <<integer>>
|
||||
status?: <<ConnectorSyncStatus>>
|
||||
connector_id?: <<Id>>
|
||||
job_type?: <<ConnectorSyncJobType>> | <<ConnectorSyncJobType>>[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobListResponse {
|
||||
count: <<long>>
|
||||
results: <<ConnectorConnectorSyncJob>>[]
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,72 +0,0 @@
|
||||
[[reference-connector-sync_job_post]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobPost]]
|
||||
== client.connector.syncJobPost
|
||||
|
||||
Create a connector sync job. Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.
|
||||
|
||||
{ref}/create-connector-sync-job-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobPostRequest, options?): Promise<ConnectorSyncJobPostResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobPostRequest extends <<RequestBase>> {
|
||||
id: <<Id>>
|
||||
job_type?: <<ConnectorSyncJobType>>
|
||||
trigger_method?: <<ConnectorSyncJobTriggerMethod>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorSyncJobPostResponse {
|
||||
id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
[[reference-connector-sync_job_update_stats]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.syncJobUpdateStats]]
|
||||
== client.connector.syncJobUpdateStats
|
||||
|
||||
Updates the stats fields in the connector sync job document.
|
||||
|
||||
{ref}/set-connector-sync-job-stats-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorSyncJobUpdateStatsRequest, options?): Promise<ConnectorSyncJobUpdateStatsResponse>
|
||||
----
|
||||
|
||||
@ -1,70 +0,0 @@
|
||||
[[reference-connector-update_active_filtering]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateActiveFiltering]]
|
||||
== client.connector.updateActiveFiltering
|
||||
|
||||
Activate the connector draft filter. Activates the valid draft filtering for a connector.
|
||||
|
||||
{ref}/update-connector-filtering-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateActiveFilteringRequest, options?): Promise<ConnectorUpdateActiveFilteringResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateActiveFilteringRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateActiveFilteringResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,72 +0,0 @@
|
||||
[[reference-connector-update_api_key_id]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateApiKeyId]]
|
||||
== client.connector.updateApiKeyId
|
||||
|
||||
Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.
|
||||
|
||||
{ref}/update-connector-api-key-id-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateApiKeyIdRequest, options?): Promise<ConnectorUpdateApiKeyIdResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateApiKeyIdRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
api_key_id?: string
|
||||
api_key_secret_id?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateApiKeyIdResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,72 +0,0 @@
|
||||
[[reference-connector-update_configuration]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateConfiguration]]
|
||||
== client.connector.updateConfiguration
|
||||
|
||||
Update the connector configuration. Update the configuration field in the connector document.
|
||||
|
||||
{ref}/update-connector-configuration-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateConfigurationRequest, options?): Promise<ConnectorUpdateConfigurationResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateConfigurationRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
configuration?: <<ConnectorConnectorConfiguration>>
|
||||
values?: Record<string, any>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateConfigurationResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-connector-update_error]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateError]]
|
||||
== client.connector.updateError
|
||||
|
||||
Update the connector error field. Set the error field for the connector. If the error provided in the request body is non-null, the connector’s status is updated to error. Otherwise, if the error is reset to null, the connector status is updated to connected.
|
||||
|
||||
{ref}/update-connector-error-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateErrorRequest, options?): Promise<ConnectorUpdateErrorResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateErrorRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
error: <<SpecUtilsWithNullValue>><string>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateErrorResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,48 +0,0 @@
|
||||
[[reference-connector-update_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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateFeatures]]
|
||||
== client.connector.updateFeatures
|
||||
|
||||
Updates the connector features in the connector document.
|
||||
|
||||
{ref}/update-connector-features-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateFeaturesRequest, options?): Promise<ConnectorUpdateFeaturesResponse>
|
||||
----
|
||||
|
||||
@ -1,73 +0,0 @@
|
||||
[[reference-connector-update_filtering]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateFiltering]]
|
||||
== client.connector.updateFiltering
|
||||
|
||||
Update the connector filtering. Update the draft filtering configuration of a connector and marks the draft validation state as edited. The filtering draft is activated once validated by the running Elastic connector service. The filtering property is used to configure sync rules (both basic and advanced) for a connector.
|
||||
|
||||
{ref}/update-connector-filtering-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateFilteringRequest, options?): Promise<ConnectorUpdateFilteringResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateFilteringRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
filtering?: <<ConnectorFilteringConfig>>[]
|
||||
rules?: <<ConnectorFilteringRule>>[]
|
||||
advanced_snippet?: <<ConnectorFilteringAdvancedSnippet>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateFilteringResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-connector-update_filtering_validation]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateFilteringValidation]]
|
||||
== client.connector.updateFilteringValidation
|
||||
|
||||
Update the connector draft filtering validation. Update the draft filtering validation info for a connector.
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateFilteringValidationRequest, options?): Promise<ConnectorUpdateFilteringValidationResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateFilteringValidationRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
validation: <<ConnectorFilteringRulesValidation>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateFilteringValidationResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-connector-update_index_name]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateIndexName]]
|
||||
== client.connector.updateIndexName
|
||||
|
||||
Update the connector index name. Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored.
|
||||
|
||||
{ref}/update-connector-index-name-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateIndexNameRequest, options?): Promise<ConnectorUpdateIndexNameResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateIndexNameRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
index_name: <<SpecUtilsWithNullValue>><<<IndexName>>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateIndexNameResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,72 +0,0 @@
|
||||
[[reference-connector-update_name]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateName]]
|
||||
== client.connector.updateName
|
||||
|
||||
Update the connector name and description.
|
||||
|
||||
{ref}/update-connector-name-description-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateNameRequest, options?): Promise<ConnectorUpdateNameResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateNameRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
name?: string
|
||||
description?: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateNameResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,69 +0,0 @@
|
||||
[[reference-connector-update_native]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateNative]]
|
||||
== client.connector.updateNative
|
||||
|
||||
Update the connector is_native flag.
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateNativeRequest, options?): Promise<ConnectorUpdateNativeResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateNativeRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
is_native: boolean
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateNativeResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-connector-update_pipeline]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updatePipeline]]
|
||||
== client.connector.updatePipeline
|
||||
|
||||
Update the connector pipeline. When you create a new connector, the configuration of an ingest pipeline is populated with default settings.
|
||||
|
||||
{ref}/update-connector-pipeline-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdatePipelineRequest, options?): Promise<ConnectorUpdatePipelineResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdatePipelineRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
pipeline: <<ConnectorIngestPipelineParams>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdatePipelineResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-connector-update_scheduling]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateScheduling]]
|
||||
== client.connector.updateScheduling
|
||||
|
||||
Update the connector scheduling.
|
||||
|
||||
{ref}/update-connector-scheduling-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateSchedulingRequest, options?): Promise<ConnectorUpdateSchedulingResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateSchedulingRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
scheduling: <<ConnectorSchedulingConfiguration>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateSchedulingResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-connector-update_service_type]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateServiceType]]
|
||||
== client.connector.updateServiceType
|
||||
|
||||
Update the connector service type.
|
||||
|
||||
{ref}/update-connector-service-type-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateServiceTypeRequest, options?): Promise<ConnectorUpdateServiceTypeResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateServiceTypeRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
service_type: string
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateServiceTypeResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
@ -1,71 +0,0 @@
|
||||
[[reference-connector-update_status]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| 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>
|
||||
++++
|
||||
|
||||
[[client.connector.updateStatus]]
|
||||
== client.connector.updateStatus
|
||||
|
||||
Update the connector status.
|
||||
|
||||
{ref}/update-connector-status-api.html[{es} documentation]
|
||||
[discrete]
|
||||
== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(ConnectorUpdateStatusRequest, options?): Promise<ConnectorUpdateStatusResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Request
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateStatusRequest extends <<RequestBase>> {
|
||||
connector_id: <<Id>>
|
||||
status: <<ConnectorConnectorStatus>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
[discrete]
|
||||
=== Response
|
||||
|
||||
[source,ts,subs=+macros]
|
||||
----
|
||||
interface ConnectorUpdateStatusResponse {
|
||||
result: <<Result>>
|
||||
}
|
||||
|
||||
----
|
||||
|
||||
1077
docs/reference/connector.asciidoc
Normal file
1077
docs/reference/connector.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user