Index Aliases API
editIndex Aliases API
editIndices Aliases Request
editThe Index Aliases API allows aliasing an index with a name, with all APIs automatically converting the alias name to the actual index name.
An IndicesAliasesRequest
must have at least one AliasActions
:
IndicesAliasesRequest request = new IndicesAliasesRequest(); AliasActions aliasAction = new AliasActions(AliasActions.Type.ADD) .index("index1") .alias("alias1"); request.addAliasAction(aliasAction);
Creates an |
|
Creates an |
|
Adds the alias action to the request |
The following action types are supported: add
- alias an index, remove
-
removes the alias associated with the index, and remove_index
- deletes the
index.
AliasActions addIndexAction = new AliasActions(AliasActions.Type.ADD) .index("index1") .alias("alias1") .filter("{\"term\":{\"year\":2016}}"); AliasActions addIndicesAction = new AliasActions(AliasActions.Type.ADD) .indices("index1", "index2") .alias("alias2") .routing("1"); AliasActions removeAction = new AliasActions(AliasActions.Type.REMOVE) .index("index3") .alias("alias3"); AliasActions removeIndexAction = new AliasActions(AliasActions.Type.REMOVE_INDEX) .index("index4");
Creates an alias |
|
Creates an alias |
|
Removes the associated alias |
|
|
Optional arguments
editThe following arguments can optionally be provided:
Timeout to wait for the all the nodes to acknowledge the operation as a |
|
Timeout to wait for the all the nodes to acknowledge the operation as a |
Synchronous Execution
editIndicesAliasesResponse indicesAliasesResponse = client.indices().updateAliases(request, RequestOptions.DEFAULT);
Asynchronous Execution
editThe asynchronous execution of an update index aliases request requires both the IndicesAliasesRequest
instance and an ActionListener
instance to be passed to the asynchronous
method:
The asynchronous method does not block and returns immediately. Once it is
completed the ActionListener
is called back using the onResponse
method
if the execution successfully completed or using the onFailure
method if
it failed.
A typical listener for IndicesAliasesResponse
looks like:
Indices Aliases Response
editThe returned IndicesAliasesResponse
allows to retrieve information about the
executed operation as follows: