New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Get Field Mappings API Exists Alias API »
Elastic Docs ›Java REST Client [6.5] ›Java High Level REST Client ›Indices APIs

Index Aliases API

edit

Index Aliases API

edit

Indices Aliases Request

edit

The 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 IndicesAliasesRequest

Creates an AliasActions that aliases index test1 with alias1

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 alias1 with an optional filter on field year

Creates an alias alias2 associated with two indices and with an optional routing

Removes the associated alias alias3

remove_index is just like Delete Index API

Optional arguments

edit

The following arguments can optionally be provided:

request.timeout(TimeValue.timeValueMinutes(2)); 
request.timeout("2m");

Timeout to wait for the all the nodes to acknowledge the operation as a TimeValue

Timeout to wait for the all the nodes to acknowledge the operation as a String

 
request.masterNodeTimeout(TimeValue.timeValueMinutes(1)); 
request.masterNodeTimeout("1m");

Timeout to connect to the master node as a TimeValue

Timeout to connect to the master node as a String

Synchronous Execution

edit
AcknowledgedResponse indicesAliasesResponse =
        client.indices().updateAliases(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of an update index aliases request requires both the IndicesAliasesRequest instance and an ActionListener instance to be passed to the asynchronous method:

client.indices().updateAliasesAsync(request, RequestOptions.DEFAULT, listener);

The IndicesAliasesRequest to execute and the ActionListener to use when the execution completes

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:

ActionListener<AcknowledgedResponse> listener =
        new ActionListener<AcknowledgedResponse>() {
    @Override
    public void onResponse(AcknowledgedResponse indicesAliasesResponse) {
        
    }

    @Override
    public void onFailure(Exception e) {
        
    }
};

Called when the execution is successfully completed. The response is provided as an argument

Called in case of failure. The raised exception is provided as an argument

Indices Aliases Response

edit

The returned IndicesAliasesResponse allows to retrieve information about the executed operation as follows:

boolean acknowledged = indicesAliasesResponse.isAcknowledged();

Indicates whether all of the nodes have acknowledged the request
« Get Field Mappings API Exists Alias API »