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

Class RolloverRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.support.master.MasterNodeRequest<Request>

org.elasticsearch.action.support.master.AcknowledgedRequest<RolloverRequest>

org.elasticsearch.action.admin.indices.rollover.RolloverRequest

All Implemented Interfaces:

IndicesRequest, AckedRequest, Streamable, Writeable, TaskAwareRequest

public class RolloverRequest
extends AcknowledgedRequest<RolloverRequest>
implements IndicesRequest

Request class to swap index under an alias upon satisfying conditions

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest

IndicesRequest.Replaceable

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static ObjectParser<RolloverRequest,java.lang.Void>	PARSER

Fields inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest

DEFAULT_ACK_TIMEOUT, timeout

Fields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest

DEFAULT_MASTER_NODE_TIMEOUT, masterNodeTimeout

Constructor Summary

Constructors

Constructor	Description
RolloverRequest(java.lang.String alias, java.lang.String newIndexName)

Method Summary

Modifier and Type	Method	Description
void	addMaxIndexAgeCondition(TimeValue age)	Adds condition to check if the index is at least age old
void	addMaxIndexDocsCondition(long numDocs)	Adds condition to check if the index has at least numDocs
void	addMaxIndexSizeCondition(ByteSizeValue size)	Adds a size-based condition to check if the index size is at least size.
void	dryRun(boolean dryRun)	Sets if the rollover should not be executed when conditions are met
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
void	setAlias(java.lang.String alias)	Sets the alias to rollover to another index
void	setCreateIndexRequest(CreateIndexRequest createIndexRequest)	Sets rollover index creation request to override index settings when the rolled over index has to be created
void	setNewIndexName(java.lang.String newIndexName)	Sets the alias to rollover to another index
void	setWaitForActiveShards(int waitForActiveShards)	A shortcut for setWaitForActiveShards(ActiveShardCount) where the numerical shard count is passed in, instead of having to first call ActiveShardCount.from(int) to get the ActiveShardCount.
void	setWaitForActiveShards(ActiveShardCount waitForActiveShards)	Sets the number of shard copies that should be active for creation of the new rollover index to return.
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from interface org.elasticsearch.cluster.ack.AckedRequest

masterNodeTimeout

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

ackTimeout, timeout, timeout, timeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

newWriteableReader

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Field Detail

PARSER

public static final ObjectParser<RolloverRequest,java.lang.Void> PARSER

Constructor Detail

RolloverRequest

public RolloverRequest(java.lang.String alias,
                       java.lang.String newIndexName)

Method Detail

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class AcknowledgedRequest<RolloverRequest>

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class AcknowledgedRequest<RolloverRequest>

Throws:

java.io.IOException

indices

public java.lang.String[] indices()

Description copied from interface: IndicesRequest

Returns the array of indices that the action relates to

Specified by:

indices in interface IndicesRequest

indicesOptions

public IndicesOptions indicesOptions()

Description copied from interface: IndicesRequest

Returns the indices options used to resolve indices. They tell for instance whether a single index is accepted, whether an empty array will be converted to _all, and how wildcards will be expanded if needed.

Specified by:

indicesOptions in interface IndicesRequest

setAlias

public void setAlias(java.lang.String alias)

Sets the alias to rollover to another index

setNewIndexName

public void setNewIndexName(java.lang.String newIndexName)

Sets the alias to rollover to another index

dryRun

public void dryRun(boolean dryRun)

Sets if the rollover should not be executed when conditions are met

addMaxIndexAgeCondition

public void addMaxIndexAgeCondition(TimeValue age)

Adds condition to check if the index is at least age old

addMaxIndexDocsCondition

public void addMaxIndexDocsCondition(long numDocs)

Adds condition to check if the index has at least numDocs

addMaxIndexSizeCondition

public void addMaxIndexSizeCondition(ByteSizeValue size)

Adds a size-based condition to check if the index size is at least size.

setCreateIndexRequest

public void setCreateIndexRequest(CreateIndexRequest createIndexRequest)

Sets rollover index creation request to override index settings when the rolled over index has to be created

setWaitForActiveShards

public void setWaitForActiveShards(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

setWaitForActiveShards

public void setWaitForActiveShards(int waitForActiveShards)

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