IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

› › ›

Rollover Index API

edit

Rollover Index API

edit

Rollover Request

edit

The Rollover Index API requires a RolloverRequest instance. A RolloverRequest requires two string arguments at construction time, and one or more conditions that determine when the index has to be rolled over:

RolloverRequest request = new RolloverRequest("alias", "index-2"); 
request.addMaxIndexAgeCondition(new TimeValue(7, TimeUnit.DAYS)); 
request.addMaxIndexDocsCondition(1000); 
request.addMaxIndexSizeCondition(new ByteSizeValue(5, ByteSizeUnit.GB));

	The alias (first argument) that points to the index to rollover, and optionally the name of the new index in case the rollover operation is performed
	Condition on the age of the index
	Condition on the number of documents in the index
	Condition on the size of the index

Optional arguments

edit

The following arguments can optionally be provided:

request.dryRun(true);

Whether the rollover should be performed (default) or only simulated

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

	Timeout to wait for the all the nodes to acknowledge the index is opened as a `TimeValue`
	Timeout to wait for the all the nodes to acknowledge the index is opened 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`

request.getCreateIndexRequest().waitForActiveShards(2); 
request.getCreateIndexRequest().waitForActiveShards(ActiveShardCount.DEFAULT);

	The number of active shard copies to wait for before the rollover index API returns a response, as an `int`
	The number of active shard copies to wait for before the rollover index API returns a response, as an `ActiveShardCount`

request.getCreateIndexRequest().settings(Settings.builder()
        .put("index.number_of_shards", 4));

Add the settings to apply to the new index, which include the number of shards to create for it

request.getCreateIndexRequest().mapping("type", "field", "type=keyword");

Add the mappings to associate the new index with. See Index mappings for examples on the different ways to provide mappings

request.getCreateIndexRequest().alias(new Alias("another_alias"));

Add the aliases to associate the new index with

Synchronous Execution

edit

RolloverResponse rolloverResponse = client.indices().rollover(request, RequestOptions.DEFAULT);

Asynchronous Execution

edit

The asynchronous execution of a rollover request requires both the RolloverRequest instance and an ActionListener instance to be passed to the asynchronous method:

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

The RolloverRequest 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 RolloverResponse looks like:

ActionListener<RolloverResponse> listener = new ActionListener<RolloverResponse>() {
    @Override
    public void onResponse(RolloverResponse rolloverResponse) {
        
    }

    @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

Rollover Response

edit

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

boolean acknowledged = rolloverResponse.isAcknowledged(); 
boolean shardsAcked = rolloverResponse.isShardsAcknowledged(); 
String oldIndex = rolloverResponse.getOldIndex(); 
String newIndex = rolloverResponse.getNewIndex(); 
boolean isRolledOver = rolloverResponse.isRolledOver(); 
boolean isDryRun = rolloverResponse.isDryRun(); 
Map<String, Boolean> conditionStatus = rolloverResponse.getConditionStatus();

	Indicates whether all of the nodes have acknowledged the request
	Indicates whether the requisite number of shard copies were started for each shard in the index before timing out
	The name of the old index, eventually rolled over
	The name of the new index
	Whether the index has been rolled over
	Whether the operation was performed or it was a dry run
	The different conditions and whether they were matched or not

« Force Merge API Put Mapping API »