mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
Add delete alias to the HLRC (#48819)
The delete alias call is a rest only API call, but should still be added to the rest client. This commit adds it as well as relevant tests. Ref #47678
This commit is contained in:
parent
c868a11ddb
commit
7115d3e370
9 changed files with 259 additions and 1 deletions
49
docs/java-rest/high-level/indices/delete_alias.asciidoc
Normal file
49
docs/java-rest/high-level/indices/delete_alias.asciidoc
Normal file
|
@ -0,0 +1,49 @@
|
|||
--
|
||||
:api: delete-alias
|
||||
:request: DeleteAliasRequest
|
||||
:response: AcknowledgedResponse
|
||||
--
|
||||
|
||||
[id="{upid}-{api}"]
|
||||
=== Delete Alias API
|
||||
|
||||
[id="{upid}-{api}-request"]
|
||||
==== Delete Alias Request
|
||||
|
||||
An +{request}+ requires an `index` and an `alias` argument:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request]
|
||||
--------------------------------------------------
|
||||
|
||||
==== Optional arguments
|
||||
The following arguments can optionally be provided:
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-request-timeout]
|
||||
--------------------------------------------------
|
||||
<1> Timeout to wait for the all the nodes to acknowledge the index is opened
|
||||
as a `TimeValue`
|
||||
|
||||
["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"]
|
||||
==== Delete Alias Response
|
||||
|
||||
The returned +{response}+ indicates if the request to delete the alias
|
||||
was received.
|
||||
|
||||
["source","java",subs="attributes,callouts,macros"]
|
||||
--------------------------------------------------
|
||||
include-tagged::{doc-tests-file}[{api}-response]
|
||||
--------------------------------------------------
|
||||
<1> Whether or not the request to delete the alias was
|
||||
acknowledged.
|
||||
|
||||
include::../execution.asciidoc[]
|
|
@ -120,6 +120,7 @@ Alias Management::
|
|||
* <<{upid}-update-aliases>>
|
||||
* <<{upid}-exists-alias>>
|
||||
* <<{upid}-get-alias>>
|
||||
* <<{upid}-delete-alias>>
|
||||
|
||||
Template Management::
|
||||
* <<{upid}-get-templates>>
|
||||
|
@ -145,6 +146,7 @@ include::indices/put_mapping.asciidoc[]
|
|||
include::indices/get_mappings.asciidoc[]
|
||||
include::indices/get_field_mappings.asciidoc[]
|
||||
include::indices/update_aliases.asciidoc[]
|
||||
include::indices/delete_alias.asciidoc[]
|
||||
include::indices/exists_alias.asciidoc[]
|
||||
include::indices/get_alias.asciidoc[]
|
||||
include::indices/put_settings.asciidoc[]
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue