Module org.elasticsearch.server

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

All Implemented Interfaces:

RequestBuilder<RolloverRequest,RolloverResponse>

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)

Method Summary

Modifier and Type	Method	Description
RolloverRequestBuilder	alias(Alias alias)
RolloverRequestBuilder	dryRun(boolean dryRun)
RolloverRequestBuilder	lazy(boolean lazy)
RolloverRequestBuilder	mapping(String source)
RolloverRequestBuilder	setConditions(RolloverConditions rolloverConditions)
RolloverRequestBuilder	setConditions(RolloverConditions.Builder rolloverConditions)
RolloverRequestBuilder	setNewIndexName(String newIndexName)
RolloverRequestBuilder	setRolloverTarget(String rolloverTarget)
RolloverRequestBuilder	settings(Settings settings)
RolloverRequestBuilder	simpleMapping(String... source)
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, request

Methods inherited from class java.lang.Object

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

Constructor Details

RolloverRequestBuilder

public RolloverRequestBuilder(ElasticsearchClient client)

Method Details

setRolloverTarget

public RolloverRequestBuilder setRolloverTarget(String rolloverTarget)

setNewIndexName

public RolloverRequestBuilder setNewIndexName(String newIndexName)

setConditions

public RolloverRequestBuilder setConditions(RolloverConditions rolloverConditions)

setConditions

public RolloverRequestBuilder setConditions(RolloverConditions.Builder rolloverConditions)

dryRun

public RolloverRequestBuilder dryRun(boolean dryRun)

lazy

public RolloverRequestBuilder lazy(boolean lazy)

settings

public RolloverRequestBuilder settings(Settings settings)

alias

public RolloverRequestBuilder alias(Alias alias)

simpleMapping

public RolloverRequestBuilder simpleMapping(String... source)

mapping

public RolloverRequestBuilder mapping(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 RolloverResponse.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.