habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improvements to get docs to build

Browse Source
This commit is contained in:
Josh Mock
2024-12-04 11:54:14 -06:00
parent bd5c3d98fa
commit 1fde515fcf
581 changed files with 18074 additions and 26998 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/reference/async_search-delete.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.asyncSearch.delete]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Delete an async search. If the asynchronous search is still running, it is cance
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AsyncSearchDeleteRequest extends <<RequestBase>> {
id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchDeleteResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/async_search-get.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.asyncSearch.get]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get async search results. Retrieve the results of a previously submitted asynchr
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AsyncSearchGetRequest extends <<RequestBase>> {
id: <<Id>>
keep_alive?: <<Duration>>
@ -55,20 +58,14 @@ interface AsyncSearchGetRequest extends <<RequestBase>> {
wait_for_completion_timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchGetResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
[pass]
++++
</pre>
++++
----

43
docs/reference/async_search-status.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.asyncSearch.status]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Get the async search status. Get the status of a previously submitted async sear
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AsyncSearchStatusRequest extends <<RequestBase>> {
id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchStatusResponse = AsyncSearchStatusStatusResponseBase
[pass]
++++
</pre>
++++
----

43
docs/reference/async_search-submit.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[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]
----
@ -42,12 +47,10 @@ Run an async search. When the primary sort of the results is an indexed field, s
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AsyncSearchSubmitRequest extends <<RequestBase>> {
index?: <<Indices>>
wait_for_completion_timeout?: <<Duration>>
@ -118,20 +121,14 @@ interface AsyncSearchSubmitRequest extends <<RequestBase>> {
stats?: string[]
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AsyncSearchSubmitResponse<TDocument = unknown, TAggregations = Record<<<AggregateName>>, <<AggregationsAggregate>>>> = <<AsyncSearchAsyncSearchDocumentResponseBase>><TDocument, TAggregations>
[pass]
++++
</pre>
++++
----

43
docs/reference/autoscaling-delete_autoscaling_policy.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.autoscaling.deleteAutoscalingPolicy]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Delete an autoscaling policy. NOTE: This feature is designed for indirect use by
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AutoscalingDeleteAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AutoscalingDeleteAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

44
docs/reference/autoscaling-get_autoscaling_capacity.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[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]
----
@ -42,31 +47,22 @@ Get the autoscaling capacity. NOTE: This feature is designed for indirect use by
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {
}
[source,ts,subs=+macros]
----
interface AutoscalingGetAutoscalingCapacityRequest extends <<RequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AutoscalingGetAutoscalingCapacityResponse {
policies: Record<string, AutoscalingGetAutoscalingCapacityAutoscalingDeciders>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/autoscaling-get_autoscaling_policy.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.autoscaling.getAutoscalingPolicy]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Get an autoscaling policy. NOTE: This feature is designed for indirect use by El
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AutoscalingGetAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AutoscalingGetAutoscalingPolicyResponse = <<AutoscalingAutoscalingPolicy>>
[pass]
++++
</pre>
++++
----

43
docs/reference/autoscaling-put_autoscaling_policy.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.autoscaling.putAutoscalingPolicy]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Create or update an autoscaling policy. NOTE: This feature is designed for indir
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface AutoscalingPutAutoscalingPolicyRequest extends <<RequestBase>> {
name: <<Name>>
policy?: <<AutoscalingAutoscalingPolicy>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type AutoscalingPutAutoscalingPolicyResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/bulk.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</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]
----
@ -42,12 +47,10 @@ Bulk index or delete documents. Performs multiple indexing or delete operations
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <<RequestBase>> {
index?: <<IndexName>>
pipeline?: string
@ -62,17 +65,13 @@ interface BulkRequest<TDocument = unknown, TPartialDocument = unknown> extends <
operations?: (<<BulkOperationContainer>> | <<BulkUpdateAction>><TDocument, TPartialDocument> | TDocument)[]
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface BulkResponse {
errors: boolean
items: Partial<Record<<<BulkOperationType>>, <<BulkResponseItem>>>>[]
@ -80,7 +79,5 @@ interface BulkResponse {
ingest_took?: <<long>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-aliases.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.aliases]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Get aliases. Retrieves the cluster’s index aliases, including filter and routi
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatAliasesRequest extends <<CatCatRequestBase>> {
name?: <<Names>>
expand_wildcards?: <<ExpandWildcards>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatAliasesResponse = CatAliasesAliasesRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-allocation.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.allocation]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Provides a snapshot of the number of shards allocated to each data node and thei
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatAllocationRequest extends <<CatCatRequestBase>> {
node_id?: <<NodeIds>>
bytes?: <<Bytes>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatAllocationResponse = CatAllocationAllocationRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-component_templates.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.componentTemplates]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Get component templates. Returns information about component templates in a clus
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatComponentTemplatesRequest extends <<CatCatRequestBase>> {
name?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatComponentTemplatesResponse = CatComponentTemplatesComponentTemplate[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-count.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.count]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Get a document count. Provides quick access to a document count for a data strea
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatCountRequest extends <<CatCatRequestBase>> {
index?: <<Indices>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatCountResponse = CatCountCountRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-fielddata.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.fielddata]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Returns the amount of heap memory currently used by the field data cache on ever
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatFielddataRequest extends <<CatCatRequestBase>> {
fields?: <<Fields>>
bytes?: <<Bytes>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatFielddataResponse = CatFielddataFielddataRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-health.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.health]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Returns the health status of a cluster, similar to the cluster health API. IMPOR
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatHealthRequest extends <<CatCatRequestBase>> {
time?: <<TimeUnit>>
ts?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatHealthResponse = CatHealthHealthRecord[]
[pass]
++++
</pre>
++++
----

44
docs/reference/cat-help.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.help]]
=== client.cat.help
== client.cat.help
Get CAT help. Returns help for the CAT APIs.
{ref}/cat.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,29 +47,20 @@ Get CAT help. Returns help for the CAT APIs.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface CatHelpRequest extends <<CatCatRequestBase>> {
}
[source,ts,subs=+macros]
----
interface CatHelpRequest extends <<CatCatRequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
type CatHelpResponse = CatHelpHelpRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-indices.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.indices]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get index information. Returns high-level information about indices in a cluster
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatIndicesRequest extends <<CatCatRequestBase>> {
index?: <<Indices>>
bytes?: <<Bytes>>
@ -58,20 +61,14 @@ interface CatIndicesRequest extends <<CatCatRequestBase>> {
time?: <<TimeUnit>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatIndicesResponse = CatIndicesIndicesRecord[]
[pass]
++++
</pre>
++++
----

44
docs/reference/cat-master.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.master]]
=== 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
== Function signature
[source,ts]
----
@ -42,29 +47,20 @@ Returns information about the master node, including the ID, bound IP address, a
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface CatMasterRequest extends <<CatCatRequestBase>> {
}
[source,ts,subs=+macros]
----
interface CatMasterRequest extends <<CatCatRequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
type CatMasterResponse = CatMasterMasterRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-ml_data_frame_analytics.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.mlDataFrameAnalytics]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get data frame analytics jobs. Returns configuration and usage information about
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatMlDataFrameAnalyticsRequest extends <<CatCatRequestBase>> {
id?: <<Id>>
allow_no_match?: boolean
@ -57,20 +60,14 @@ interface CatMlDataFrameAnalyticsRequest extends <<CatCatRequestBase>> {
time?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatMlDataFrameAnalyticsResponse = CatMlDataFrameAnalyticsDataFrameAnalyticsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-ml_datafeeds.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.mlDatafeeds]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get datafeeds. Returns configuration and usage information about datafeeds. This
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatMlDatafeedsRequest extends <<CatCatRequestBase>> {
datafeed_id?: <<Id>>
allow_no_match?: boolean
@ -56,20 +59,14 @@ interface CatMlDatafeedsRequest extends <<CatCatRequestBase>> {
time?: <<TimeUnit>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatMlDatafeedsResponse = CatMlDatafeedsDatafeedsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-ml_jobs.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.mlJobs]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get anomaly detection jobs. Returns configuration and usage information for anom
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatMlJobsRequest extends <<CatCatRequestBase>> {
job_id?: <<Id>>
allow_no_match?: boolean
@ -57,20 +60,14 @@ interface CatMlJobsRequest extends <<CatCatRequestBase>> {
time?: <<TimeUnit>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatMlJobsResponse = CatMlJobsJobsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-ml_trained_models.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.mlTrainedModels]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get trained models. Returns configuration and usage information about inference
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatMlTrainedModelsRequest extends <<CatCatRequestBase>> {
model_id?: <<Id>>
allow_no_match?: boolean
@ -58,20 +61,14 @@ interface CatMlTrainedModelsRequest extends <<CatCatRequestBase>> {
size?: <<integer>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatMlTrainedModelsResponse = CatMlTrainedModelsTrainedModelsRecord[]
[pass]
++++
</pre>
++++
----

44
docs/reference/cat-nodeattrs.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.nodeattrs]]
=== 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
== Function signature
[source,ts]
----
@ -42,29 +47,20 @@ Returns information about custom node attributes. IMPORTANT: cat APIs are only i
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface CatNodeattrsRequest extends <<CatCatRequestBase>> {
}
[source,ts,subs=+macros]
----
interface CatNodeattrsRequest extends <<CatCatRequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
type CatNodeattrsResponse = CatNodeattrsNodeAttributesRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-nodes.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.nodes]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Returns information about the nodes in a cluster. IMPORTANT: cat APIs are only i
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatNodesRequest extends <<CatCatRequestBase>> {
bytes?: <<Bytes>>
full_id?: boolean | string
include_unloaded_segments?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatNodesResponse = CatNodesNodesRecord[]
[pass]
++++
</pre>
++++
----

44
docs/reference/cat-pending_tasks.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.pendingTasks]]
=== 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
== Function signature
[source,ts]
----
@ -42,29 +47,20 @@ Returns cluster-level changes that have not yet been executed. IMPORTANT: cat AP
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface CatPendingTasksRequest extends <<CatCatRequestBase>> {
}
[source,ts,subs=+macros]
----
interface CatPendingTasksRequest extends <<CatCatRequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
type CatPendingTasksResponse = CatPendingTasksPendingTasksRecord[]
[pass]
++++
</pre>
++++
----

44
docs/reference/cat-plugins.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.plugins]]
=== 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
== Function signature
[source,ts]
----
@ -42,29 +47,20 @@ Returns a list of plugins running on each node of a cluster. IMPORTANT: cat APIs
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface CatPluginsRequest extends <<CatCatRequestBase>> {
}
[source,ts,subs=+macros]
----
interface CatPluginsRequest extends <<CatCatRequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
type CatPluginsResponse = CatPluginsPluginsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-recovery.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.recovery]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Returns information about ongoing and completed shard recoveries. Shard recovery
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatRecoveryRequest extends <<CatCatRequestBase>> {
index?: <<Indices>>
active_only?: boolean
@ -55,20 +58,14 @@ interface CatRecoveryRequest extends <<CatCatRequestBase>> {
detailed?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatRecoveryResponse = CatRecoveryRecoveryRecord[]
[pass]
++++
</pre>
++++
----

44
docs/reference/cat-repositories.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.repositories]]
=== 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
== Function signature
[source,ts]
----
@ -42,29 +47,20 @@ Returns the snapshot repositories for a cluster. IMPORTANT: cat APIs are only in
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface CatRepositoriesRequest extends <<CatCatRequestBase>> {
}
[source,ts,subs=+macros]
----
interface CatRepositoriesRequest extends <<CatCatRequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
type CatRepositoriesResponse = CatRepositoriesRepositoriesRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-segments.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.segments]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Returns low-level information about the Lucene segments in index shards. For dat
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatSegmentsRequest extends <<CatCatRequestBase>> {
index?: <<Indices>>
bytes?: <<Bytes>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatSegmentsResponse = CatSegmentsSegmentsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-shards.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.shards]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Returns information about the shards in a cluster. For data streams, the API ret
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatShardsRequest extends <<CatCatRequestBase>> {
index?: <<Indices>>
bytes?: <<Bytes>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatShardsResponse = CatShardsShardsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-snapshots.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.snapshots]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Returns information about the snapshots stored in one or more repositories. A sn
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatSnapshotsRequest extends <<CatCatRequestBase>> {
repository?: <<Names>>
ignore_unavailable?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatSnapshotsResponse = CatSnapshotsSnapshotsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-tasks.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.tasks]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Returns information about tasks currently executing in the cluster. IMPORTANT: c
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatTasksRequest extends <<CatCatRequestBase>> {
actions?: string[]
detailed?: boolean
@ -55,20 +58,14 @@ interface CatTasksRequest extends <<CatCatRequestBase>> {
parent_task_id?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatTasksResponse = CatTasksTasksRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-templates.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.templates]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Returns information about index templates in a cluster. You can use index templa
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatTemplatesRequest extends <<CatCatRequestBase>> {
name?: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatTemplatesResponse = CatTemplatesTemplatesRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-thread_pool.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.threadPool]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Returns thread pool statistics for each node in a cluster. Returned information
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatThreadPoolRequest extends <<CatCatRequestBase>> {
thread_pool_patterns?: <<Names>>
time?: <<TimeUnit>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatThreadPoolResponse = CatThreadPoolThreadPoolRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/cat-transforms.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cat.transforms]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get transforms. Returns configuration and usage information about transforms. CA
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CatTransformsRequest extends <<CatCatRequestBase>> {
transform_id?: <<Id>>
allow_no_match?: boolean
@ -58,20 +61,14 @@ interface CatTransformsRequest extends <<CatCatRequestBase>> {
size?: <<integer>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CatTransformsResponse = CatTransformsTransformsRecord[]
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-delete_auto_follow_pattern.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.deleteAutoFollowPattern]]
=== client.ccr.deleteAutoFollowPattern
== client.ccr.deleteAutoFollowPattern
Deletes auto-follow patterns.
{ref}/ccr-delete-auto-follow-pattern.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Deletes auto-follow patterns.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrDeleteAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrDeleteAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-follow.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.follow]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Creates a new follower index configured to follow the referenced leader index.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
wait_for_active_shards?: <<WaitForActiveShards>>
@ -65,24 +68,18 @@ interface CcrFollowRequest extends <<RequestBase>> {
remote_cluster?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrFollowResponse {
follow_index_created: boolean
follow_index_shards_acked: boolean
index_following_started: boolean
}
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-follow_info.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.followInfo]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Retrieves information about all follower indices, including parameters and statu
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrFollowInfoRequest extends <<RequestBase>> {
index: <<Indices>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrFollowInfoResponse {
follower_indices: CcrFollowInfoFollowerIndex[]
}
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-follow_stats.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.followStats]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Retrieves follower stats. return shard-level stats about the following tasks ass
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrFollowStatsRequest extends <<RequestBase>> {
index: <<Indices>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrFollowStatsResponse {
indices: <<CcrFollowIndexStats>>[]
}
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-forget_follower.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.forgetFollower]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Removes the follower retention leases from the leader.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrForgetFollowerRequest extends <<RequestBase>> {
index: <<IndexName>>
follower_cluster?: string
@ -56,22 +59,16 @@ interface CcrForgetFollowerRequest extends <<RequestBase>> {
leader_remote_cluster?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrForgetFollowerResponse {
_shards: <<ShardStatistics>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-get_auto_follow_pattern.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.getAutoFollowPattern]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Gets configured auto-follow patterns. Returns the specified auto-follow pattern
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrGetAutoFollowPatternRequest extends <<RequestBase>> {
name?: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CcrGetAutoFollowPatternResponse {
patterns: CcrGetAutoFollowPatternAutoFollowPattern[]
}
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-pause_auto_follow_pattern.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.pauseAutoFollowPattern]]
=== client.ccr.pauseAutoFollowPattern
== client.ccr.pauseAutoFollowPattern
Pauses an auto-follow pattern
{ref}/ccr-pause-auto-follow-pattern.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Pauses an auto-follow pattern
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrPauseAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrPauseAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-pause_follow.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.pauseFollow]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Pauses a follower index. The follower index will not fetch any additional operat
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrPauseFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrPauseFollowResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-put_auto_follow_pattern.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.putAutoFollowPattern]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Creates a new named collection of auto-follow patterns against a specified remot
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrPutAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
remote_cluster: string
@ -67,20 +70,14 @@ interface CcrPutAutoFollowPatternRequest extends <<RequestBase>> {
max_write_request_size?: <<ByteSize>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrPutAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-resume_auto_follow_pattern.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.resumeAutoFollowPattern]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Resumes an auto-follow pattern that has been paused
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrResumeAutoFollowPatternRequest extends <<RequestBase>> {
name: <<Name>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrResumeAutoFollowPatternResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-resume_follow.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.resumeFollow]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Resumes a follower index that has been paused
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrResumeFollowRequest extends <<RequestBase>> {
index: <<IndexName>>
max_outstanding_read_requests?: <<long>>
@ -62,20 +65,14 @@ interface CcrResumeFollowRequest extends <<RequestBase>> {
read_poll_timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrResumeFollowResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

44
docs/reference/ccr-stats.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.stats]]
=== client.ccr.stats
== client.ccr.stats
Gets all stats related to cross-cluster replication.
{ref}/ccr-get-stats.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,32 +47,23 @@ Gets all stats related to cross-cluster replication.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface CcrStatsRequest extends <<RequestBase>> {
}
[source,ts,subs=+macros]
----
interface CcrStatsRequest extends <<RequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrStatsResponse {
auto_follow_stats: CcrStatsAutoFollowStats
follow_stats: CcrStatsFollowStats
}
[pass]
++++
</pre>
++++
----

43
docs/reference/ccr-unfollow.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.ccr.unfollow]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Stops the following task associated with a follower index and removes index meta
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CcrUnfollowRequest extends <<RequestBase>> {
index: <<IndexName>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CcrUnfollowResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/clear_scroll.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</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]
----
@ -42,33 +47,25 @@ Clear a scrolling search. Clear the search context and results for a scrolling s
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClearScrollRequest extends <<RequestBase>> {
scroll_id?: <<ScrollIds>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClearScrollResponse {
succeeded: boolean
num_freed: <<integer>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/close_point_in_time.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</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]
----
@ -42,33 +47,25 @@ Close a point in time. A point in time must be opened explicitly before being us
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClosePointInTimeRequest extends <<RequestBase>> {
id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClosePointInTimeResponse {
succeeded: boolean
num_freed: <<integer>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-allocation_explain.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.allocationExplain]]
=== client.cluster.allocationExplain
== client.cluster.allocationExplain
Provides explanations for shard allocations in the cluster.
{ref}/cluster-allocation-explain.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Provides explanations for shard allocations in the cluster.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterAllocationExplainRequest extends <<RequestBase>> {
include_disk_info?: boolean
include_yes_decisions?: boolean
@ -57,17 +60,13 @@ interface ClusterAllocationExplainRequest extends <<RequestBase>> {
shard?: <<integer>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterAllocationExplainResponse {
allocate_explanation?: string
allocation_delay?: <<Duration>>
@ -96,7 +95,5 @@ interface ClusterAllocationExplainResponse {
note?: string
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-delete_component_template.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.deleteComponentTemplate]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Delete component templates. Deletes component templates. Component templates are
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterDeleteComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterDeleteComponentTemplateResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-delete_voting_config_exclusions.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.deleteVotingConfigExclusions]]
=== client.cluster.deleteVotingConfigExclusions
== client.cluster.deleteVotingConfigExclusions
Clears cluster voting config exclusions.
{ref}/voting-config-exclusions.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Clears cluster voting config exclusions.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterDeleteVotingConfigExclusionsRequest extends <<RequestBase>> {
wait_for_removal?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterDeleteVotingConfigExclusionsResponse = boolean
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-exists_component_template.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.existsComponentTemplate]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Check component templates. Returns information about whether a particular compon
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterExistsComponentTemplateRequest extends <<RequestBase>> {
name: <<Names>>
master_timeout?: <<Duration>>
local?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterExistsComponentTemplateResponse = boolean
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-get_component_template.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.getComponentTemplate]]
=== client.cluster.getComponentTemplate
== client.cluster.getComponentTemplate
Get component templates. Retrieves information about component templates.
{ref}/indices-component-template.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get component templates. Retrieves information about component templates.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
name?: <<Name>>
flat_settings?: boolean
@ -56,22 +59,16 @@ interface ClusterGetComponentTemplateRequest extends <<RequestBase>> {
master_timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterGetComponentTemplateResponse {
component_templates: <<ClusterComponentTemplate>>[]
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-get_settings.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.getSettings]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Returns cluster-wide settings. By default, it returns only settings that have be
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterGetSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
include_defaults?: boolean
@ -55,24 +58,18 @@ interface ClusterGetSettingsRequest extends <<RequestBase>> {
timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterGetSettingsResponse {
persistent: Record<string, any>
transient: Record<string, any>
defaults?: Record<string, any>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-health.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.health]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ The cluster health API returns a simple status on the health of the cluster. You
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterHealthRequest extends <<RequestBase>> {
index?: <<Indices>>
expand_wildcards?: <<ExpandWildcards>>
@ -63,20 +66,14 @@ interface ClusterHealthRequest extends <<RequestBase>> {
wait_for_status?: <<HealthStatus>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterHealthResponse = ClusterHealthHealthResponseBody
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-info.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.info]]
=== client.cluster.info
== client.cluster.info
Get cluster info. Returns basic information about the cluster.
{ref}/cluster-info.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,27 +47,21 @@ Get cluster info. Returns basic information about the cluster.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterInfoRequest extends <<RequestBase>> {
target: <<ClusterInfoTargets>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterInfoResponse {
cluster_name: <<Name>>
http?: <<NodesHttp>>
@ -71,7 +70,5 @@ interface ClusterInfoResponse {
script?: <<NodesScripting>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-pending_tasks.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.pendingTasks]]
=== 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
== Function signature
[source,ts]
----
@ -42,33 +47,25 @@ Returns cluster-level changes (such as create index, update mapping, allocate or
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterPendingTasksRequest extends <<RequestBase>> {
local?: boolean
master_timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterPendingTasksResponse {
tasks: ClusterPendingTasksPendingTask[]
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-post_voting_config_exclusions.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.postVotingConfigExclusions]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Updates the cluster voting config exclusions by node ids or node names.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterPostVotingConfigExclusionsRequest extends <<RequestBase>> {
node_names?: <<Names>>
node_ids?: <<Ids>>
timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterPostVotingConfigExclusionsResponse = boolean
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-put_component_template.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.putComponentTemplate]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Create or update a component template. Creates or updates a component template.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterPutComponentTemplateRequest extends <<RequestBase>> {
name: <<Name>>
create?: boolean
@ -58,20 +61,14 @@ interface ClusterPutComponentTemplateRequest extends <<RequestBase>> {
deprecated?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterPutComponentTemplateResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-put_settings.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.putSettings]]
=== client.cluster.putSettings
== client.cluster.putSettings
Updates the cluster settings.
{ref}/cluster-update-settings.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Updates the cluster settings.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterPutSettingsRequest extends <<RequestBase>> {
flat_settings?: boolean
master_timeout?: <<Duration>>
@ -56,24 +59,18 @@ interface ClusterPutSettingsRequest extends <<RequestBase>> {
transient?: Record<string, any>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterPutSettingsResponse {
acknowledged: boolean
persistent: Record<string, any>
transient: Record<string, any>
}
[pass]
++++
</pre>
++++
----

44
docs/reference/cluster-remote_info.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.remoteInfo]]
=== 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
== Function signature
[source,ts]
----
@ -42,29 +47,20 @@ The cluster remote info API allows you to retrieve all of the configured remote
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface ClusterRemoteInfoRequest extends <<RequestBase>> {
}
[source,ts,subs=+macros]
----
interface ClusterRemoteInfoRequest extends <<RequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
type ClusterRemoteInfoResponse = Record<string, ClusterRemoteInfoClusterRemoteInfo>
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-reroute.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.reroute]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Allows to manually change the allocation of individual shards in the cluster.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterRerouteRequest extends <<RequestBase>> {
dry_run?: boolean
explain?: boolean
@ -58,24 +61,18 @@ interface ClusterRerouteRequest extends <<RequestBase>> {
commands?: ClusterRerouteCommand[]
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ClusterRerouteResponse {
acknowledged: boolean
explanations?: ClusterRerouteRerouteExplanation[]
state?: any
}
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-state.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.state]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Returns a comprehensive information about the state of the cluster.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterStateRequest extends <<RequestBase>> {
metric?: <<Metrics>>
index?: <<Indices>>
@ -61,20 +64,14 @@ interface ClusterStateRequest extends <<RequestBase>> {
wait_for_timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterStateResponse = any
[pass]
++++
</pre>
++++
----

43
docs/reference/cluster-stats.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.cluster.stats]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Returns cluster statistics. It returns basic index metrics (shard numbers, store
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ClusterStatsRequest extends <<RequestBase>> {
node_id?: <<NodeIds>>
include_remotes?: boolean
timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ClusterStatsResponse = ClusterStatsStatsResponseBase
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-check_in.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.checkIn]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Check in a connector. Update the `last_seen` field in the connector and set it t
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorCheckInRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorCheckInResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-delete.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.delete]]
=== 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
== Function signature
[source,ts]
----
@ -42,31 +47,23 @@ Delete a connector. Removes a connector and associated sync jobs. This is a dest
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorDeleteRequest extends <<RequestBase>> {
connector_id: <<Id>>
delete_sync_jobs?: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ConnectorDeleteResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-get.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.get]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Get a connector. Get the details about a connector.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorGetRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ConnectorGetResponse = <<ConnectorConnector>>
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-list.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.list]]
=== client.connector.list
== client.connector.list
Get all connectors. Get information about all connectors.
{ref}/list-connector-api.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get all connectors. Get information about all connectors.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorListRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
@ -57,23 +60,17 @@ interface ConnectorListRequest extends <<RequestBase>> {
query?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorListResponse {
count: <<long>>
results: <<ConnectorConnector>>[]
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-post.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.post]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Create a connector. Connectors are Elasticsearch integrations that bring content
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorPostRequest extends <<RequestBase>> {
description?: string
index_name?: <<IndexName>>
@ -57,23 +60,17 @@ interface ConnectorPostRequest extends <<RequestBase>> {
service_type?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorPostResponse {
result: <<Result>>
id: <<Id>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-put.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.put]]
=== client.connector.put
== client.connector.put
Create or update a connector.
{ref}/create-connector-api.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Create or update a connector.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorPutRequest extends <<RequestBase>> {
connector_id?: <<Id>>
description?: string
@ -58,23 +61,17 @@ interface ConnectorPutRequest extends <<RequestBase>> {
service_type?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorPutResponse {
result: <<Result>>
id: <<Id>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-sync_job_cancel.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobCancel]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Cancel a connector sync job. Cancel a connector sync job, which sets the status
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorSyncJobCancelRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorSyncJobCancelResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

13
docs/reference/connector-sync_job_check_in.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobCheckIn]]
=== 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
== Function signature
[source,ts]
----

13
docs/reference/connector-sync_job_claim.asciidoc
View File

@ -24,15 +24,20 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobClaim]]
=== client.connector.syncJobClaim
== client.connector.syncJobClaim
Claims a connector sync job.
[discrete]
==== Function signature
== Function signature
[source,ts]
----

43
docs/reference/connector-sync_job_delete.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobDelete]]
=== 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
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Delete a connector sync job. Remove a connector sync job and its associated data
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorSyncJobDeleteRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ConnectorSyncJobDeleteResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

13
docs/reference/connector-sync_job_error.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobError]]
=== 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
== Function signature
[source,ts]
----

43
docs/reference/connector-sync_job_get.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobGet]]
=== client.connector.syncJobGet
== client.connector.syncJobGet
Get a connector sync job.
{ref}/get-connector-sync-job-api.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,30 +47,22 @@ Get a connector sync job.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorSyncJobGetRequest extends <<RequestBase>> {
connector_sync_job_id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type ConnectorSyncJobGetResponse = <<ConnectorConnectorSyncJob>>
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-sync_job_list.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobList]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Get all connector sync jobs. Get information about all stored connector sync job
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorSyncJobListRequest extends <<RequestBase>> {
from?: <<integer>>
size?: <<integer>>
@ -56,23 +59,17 @@ interface ConnectorSyncJobListRequest extends <<RequestBase>> {
job_type?: <<ConnectorSyncJobType>> | <<ConnectorSyncJobType>>[]
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorSyncJobListResponse {
count: <<long>>
results: <<ConnectorConnectorSyncJob>>[]
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-sync_job_post.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobPost]]
=== 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
== Function signature
[source,ts]
----
@ -42,34 +47,26 @@ Create a connector sync job. Create a connector sync job document in the interna
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorSyncJobPostRequest extends <<RequestBase>> {
id: <<Id>>
job_type?: <<ConnectorSyncJobType>>
trigger_method?: <<ConnectorSyncJobTriggerMethod>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorSyncJobPostResponse {
id: <<Id>>
}
[pass]
++++
</pre>
++++
----

13
docs/reference/connector-sync_job_update_stats.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.syncJobUpdateStats]]
=== 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
== Function signature
[source,ts]
----

43
docs/reference/connector-update_active_filtering.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateActiveFiltering]]
=== 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
== Function signature
[source,ts]
----
@ -42,32 +47,24 @@ Activate the connector draft filter. Activates the valid draft filtering for a c
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateActiveFilteringRequest extends <<RequestBase>> {
connector_id: <<Id>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateActiveFilteringResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_api_key_id.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateApiKeyId]]
=== 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
== Function signature
[source,ts]
----
@ -42,34 +47,26 @@ Update the connector API key ID. Update the `api_key_id` and `api_key_secret_id`
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateApiKeyIdRequest extends <<RequestBase>> {
connector_id: <<Id>>
api_key_id?: string
api_key_secret_id?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateApiKeyIdResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_configuration.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateConfiguration]]
=== 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
== Function signature
[source,ts]
----
@ -42,34 +47,26 @@ Update the connector configuration. Update the configuration field in the connec
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateConfigurationRequest extends <<RequestBase>> {
connector_id: <<Id>>
configuration?: <<ConnectorConnectorConfiguration>>
values?: Record<string, any>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateConfigurationResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_error.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateError]]
=== 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
== Function signature
[source,ts]
----
@ -42,33 +47,25 @@ Update the connector error field. Set the error field for the connector. If the
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateErrorRequest extends <<RequestBase>> {
connector_id: <<Id>>
error: <<SpecUtilsWithNullValue>><string>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateErrorResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

13
docs/reference/connector-update_features.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateFeatures]]
=== 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
== Function signature
[source,ts]
----

43
docs/reference/connector-update_filtering.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateFiltering]]
=== 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
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Update the connector filtering. Update the draft filtering configuration of a co
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateFilteringRequest extends <<RequestBase>> {
connector_id: <<Id>>
filtering?: <<ConnectorFilteringConfig>>[]
@ -55,22 +58,16 @@ interface ConnectorUpdateFilteringRequest extends <<RequestBase>> {
advanced_snippet?: <<ConnectorFilteringAdvancedSnippet>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateFilteringResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_filtering_validation.asciidoc
View File

@ -24,15 +24,20 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateFilteringValidation]]
=== client.connector.updateFilteringValidation
== client.connector.updateFilteringValidation
Update the connector draft filtering validation. Update the draft filtering validation info for a connector.
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -40,33 +45,25 @@ Update the connector draft filtering validation. Update the draft filtering vali
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateFilteringValidationRequest extends <<RequestBase>> {
connector_id: <<Id>>
validation: <<ConnectorFilteringRulesValidation>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateFilteringValidationResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_index_name.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateIndexName]]
=== 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
== Function signature
[source,ts]
----
@ -42,33 +47,25 @@ Update the connector index name. Update the `index_name` field of a connector, s
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateIndexNameRequest extends <<RequestBase>> {
connector_id: <<Id>>
index_name: <<SpecUtilsWithNullValue>><<<IndexName>>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateIndexNameResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_name.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateName]]
=== client.connector.updateName
== client.connector.updateName
Update the connector name and description.
{ref}/update-connector-name-description-api.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,34 +47,26 @@ Update the connector name and description.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateNameRequest extends <<RequestBase>> {
connector_id: <<Id>>
name?: string
description?: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateNameResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_native.asciidoc
View File

@ -24,15 +24,20 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateNative]]
=== client.connector.updateNative
== client.connector.updateNative
Update the connector is_native flag.
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -40,33 +45,25 @@ Update the connector is_native flag.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateNativeRequest extends <<RequestBase>> {
connector_id: <<Id>>
is_native: boolean
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateNativeResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_pipeline.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updatePipeline]]
=== 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
== Function signature
[source,ts]
----
@ -42,33 +47,25 @@ Update the connector pipeline. When you create a new connector, the configuratio
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdatePipelineRequest extends <<RequestBase>> {
connector_id: <<Id>>
pipeline: <<ConnectorIngestPipelineParams>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdatePipelineResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_scheduling.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateScheduling]]
=== client.connector.updateScheduling
== client.connector.updateScheduling
Update the connector scheduling.
{ref}/update-connector-scheduling-api.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,33 +47,25 @@ Update the connector scheduling.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateSchedulingRequest extends <<RequestBase>> {
connector_id: <<Id>>
scheduling: <<ConnectorSchedulingConfiguration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateSchedulingResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_service_type.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateServiceType]]
=== client.connector.updateServiceType
== client.connector.updateServiceType
Update the connector service type.
{ref}/update-connector-service-type-api.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,33 +47,25 @@ Update the connector service type.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateServiceTypeRequest extends <<RequestBase>> {
connector_id: <<Id>>
service_type: string
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateServiceTypeResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/connector-update_status.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.connector.updateStatus]]
=== client.connector.updateStatus
== client.connector.updateStatus
Update the connector status.
{ref}/update-connector-status-api.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,33 +47,25 @@ Update the connector status.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface ConnectorUpdateStatusRequest extends <<RequestBase>> {
connector_id: <<Id>>
status: <<ConnectorConnectorStatus>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface ConnectorUpdateStatusResponse {
result: <<Result>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/count.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.count]]
=== client.count
== client.count
Returns number of documents matching a query.
{ref}/search-count.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Returns number of documents matching a query.
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CountRequest extends <<RequestBase>> {
index?: <<Indices>>
allow_no_indices?: boolean
@ -67,23 +70,17 @@ interface CountRequest extends <<RequestBase>> {
query?: <<QueryDslQueryContainer>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
interface CountResponse {
count: <<long>>
_shards: <<ShardStatistics>>
}
[pass]
++++
</pre>
++++
----

43
docs/reference/create.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.create]]
=== client.create
== client.create
Index a document. Adds a JSON document to the specified data stream or index and makes it searchable. If the target is an index and the document already exists, the request updates the document and increments its version.
{ref}/docs-index_.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Index a document. Adds a JSON document to the specified data stream or index and
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface CreateRequest<TDocument = unknown> extends <<RequestBase>> {
id: <<Id>>
index: <<IndexName>>
@ -61,20 +64,14 @@ interface CreateRequest<TDocument = unknown> extends <<RequestBase>> {
document?: TDocument
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type CreateResponse = <<WriteResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/dangling_indices-delete_dangling_index.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.danglingIndices.deleteDanglingIndex]]
=== client.danglingIndices.deleteDanglingIndex
== client.danglingIndices.deleteDanglingIndex
Delete a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
{ref}/modules-gateway-dangling-indices.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Delete a dangling index. If Elasticsearch encounters index data that is absent f
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface DanglingIndicesDeleteDanglingIndexRequest extends <<RequestBase>> {
index_uuid: <<Uuid>>
accept_data_loss: boolean
@ -55,20 +58,14 @@ interface DanglingIndicesDeleteDanglingIndexRequest extends <<RequestBase>> {
timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type DanglingIndicesDeleteDanglingIndexResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

43
docs/reference/dangling_indices-import_dangling_index.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.danglingIndices.importDanglingIndex]]
=== client.danglingIndices.importDanglingIndex
== client.danglingIndices.importDanglingIndex
Import a dangling index. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
{ref}/modules-gateway-dangling-indices.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,12 +47,10 @@ Import a dangling index. If Elasticsearch encounters index data that is absent f
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface DanglingIndicesImportDanglingIndexRequest extends <<RequestBase>> {
index_uuid: <<Uuid>>
accept_data_loss: boolean
@ -55,20 +58,14 @@ interface DanglingIndicesImportDanglingIndexRequest extends <<RequestBase>> {
timeout?: <<Duration>>
}
[pass]
++++
</pre>
++++
[discrete]
==== Response
----
[pass]
++++
<pre>
++++
[discrete]
=== Response
[source,ts,subs=+macros]
----
type DanglingIndicesImportDanglingIndexResponse = <<AcknowledgedResponseBase>>
[pass]
++++
</pre>
++++
----

44
docs/reference/dangling_indices-list_dangling_indices.asciidoc
View File

@ -24,17 +24,22 @@
|| ||
===========================================================================================================================
////////
++++
<style>
.lang-ts a.xref {
text-decoration: underline !important;
}
</style>
++++
[discrete]
[[client.danglingIndices.listDanglingIndices]]
=== client.danglingIndices.listDanglingIndices
== client.danglingIndices.listDanglingIndices
Get the dangling indices. If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. Use this API to list dangling indices, which you can then import or delete.
{ref}/modules-gateway-dangling-indices.html[{es} documentation]
[discrete]
==== Function signature
== Function signature
[source,ts]
----
@ -42,31 +47,22 @@ Get the dangling indices. If Elasticsearch encounters index data that is absent
----
[discrete]
==== Request
=== Request
[pass]
++++
<pre>
++++
interface DanglingIndicesListDanglingIndicesRequest extends <<RequestBase>> {
}
[source,ts,subs=+macros]
----
interface DanglingIndicesListDanglingIndicesRequest extends <<RequestBase>> {}
----
[pass]
++++
</pre>
++++
[discrete]
==== Response
=== Response
[pass]
++++
<pre>
++++
[source,ts,subs=+macros]
----
interface DanglingIndicesListDanglingIndicesResponse {
dangling_indices: DanglingIndicesListDanglingIndicesDanglingIndex[]
}
[pass]
++++
</pre>
++++
----

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