Package org.elasticsearch.action.admin.indices.rollover

Class RolloverRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response>

org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder<RolloverRequest,RolloverResponse,RolloverRequestBuilder>

org.elasticsearch.action.admin.indices.rollover.RolloverRequestBuilder

public class RolloverRequestBuilder
extends MasterNodeOperationRequestBuilder<RolloverRequest,RolloverResponse,RolloverRequestBuilder>

Field Summary

Fields inherited from class org.elasticsearch.action.ActionRequestBuilder

action, client, request

Constructor Summary

Constructors

Constructor	Description
RolloverRequestBuilder(ElasticsearchClient client, RolloverAction action)

Method Summary

Modifier and Type	Method	Description
RolloverRequestBuilder	addMaxIndexAgeCondition(TimeValue age)
RolloverRequestBuilder	addMaxIndexDocsCondition(long docs)
RolloverRequestBuilder	addMaxIndexSizeCondition(ByteSizeValue size)
RolloverRequestBuilder	alias(Alias alias)
RolloverRequestBuilder	dryRun(boolean dryRun)
RolloverRequestBuilder	mapping(java.lang.String type, java.lang.String source)
RolloverRequestBuilder	setAlias(java.lang.String alias)
RolloverRequestBuilder	setNewIndexName(java.lang.String newIndexName)
RolloverRequestBuilder	settings(Settings settings)
RolloverRequestBuilder	waitForActiveShards(int waitForActiveShards)	A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
RolloverRequestBuilder	waitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that should be active for creation of the new rollover index to return.

Methods inherited from class org.elasticsearch.action.support.master.MasterNodeOperationRequestBuilder

setMasterNodeTimeout, setMasterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RolloverRequestBuilder

public RolloverRequestBuilder(ElasticsearchClient client,
                              RolloverAction action)

Method Detail

setAlias

public RolloverRequestBuilder setAlias(java.lang.String alias)

setNewIndexName

public RolloverRequestBuilder setNewIndexName(java.lang.String newIndexName)

addMaxIndexAgeCondition

public RolloverRequestBuilder addMaxIndexAgeCondition(TimeValue age)

addMaxIndexDocsCondition

public RolloverRequestBuilder addMaxIndexDocsCondition(long docs)

addMaxIndexSizeCondition

public RolloverRequestBuilder addMaxIndexSizeCondition(ByteSizeValue size)

dryRun

public RolloverRequestBuilder dryRun(boolean dryRun)

settings

public RolloverRequestBuilder settings(Settings settings)

alias

public RolloverRequestBuilder alias(Alias alias)

mapping

public RolloverRequestBuilder mapping(java.lang.String type,
                                      java.lang.String source)

waitForActiveShards

public RolloverRequestBuilder waitForActiveShards(ActiveShardCount waitForActiveShards)

Sets the number of shard copies that should be active for creation of the new rollover index to return. Defaults to ActiveShardCount.DEFAULT, which will wait for one shard copy (the primary) to become active. Set this value to ActiveShardCount.ALL to wait for all shards (primary and all replicas) to be active before returning. Otherwise, use ActiveShardCount.from(int) to set this value to any non-negative integer, up to the number of copies per shard (number of replicas + 1), to wait for the desired amount of shard copies to become active before returning. Index creation will only wait up until the timeout value for the number of shard copies to be active before returning. Check ShardsAcknowledgedResponse.isShardsAcknowledged() to determine if the requisite shard copies were all started before returning or timing out.

Parameters:

waitForActiveShards - number of active shard copies to wait on

waitForActiveShards

public RolloverRequestBuilder waitForActiveShards(int waitForActiveShards)

A shortcut for waitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.