mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 21:48:39 +00:00
a7968a1a5e
This documents the index template v2 and component template APIs in the high level rest client. (cherry picked from commit 9bcf89b1e27613ab8887ce611ec2b0d1356cba8b) Signed-off-by: Andrei Dan <andrei.dan@elastic.co>
42 lines
1.3 KiB
Plaintext
42 lines
1.3 KiB
Plaintext
--
|
|
:api: delete-component-template
|
|
:request: DeleteComponentTemplateRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
|
|
[id="{upid}-{api}"]
|
|
=== Delete Component Template API
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Request
|
|
|
|
The Delete Component Template API allows you to delete a component template.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
--------------------------------------------------
|
|
<1> The name of the component template to delete.
|
|
|
|
=== Optional arguments
|
|
The following arguments can optionally be provided:
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request-masterTimeout]
|
|
--------------------------------------------------
|
|
<1> Timeout to connect to the master node as a `TimeValue`
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Response
|
|
|
|
The returned +{response}+ indicates if the delete component template request was received.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
--------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
--------------------------------------------------
|
|
<1> Whether or not the delete component template request was acknowledged.
|
|
|
|
include::../execution.asciidoc[]
|