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, ToXContent, ToXContentObject, TaskAwareRequest

public class RolloverRequest
extends AcknowledgedRequest<RolloverRequest>
implements IndicesRequest, ToXContentObject

Request class to swap index under an alias upon satisfying conditions Note: there is a new class with the same name for the Java HLRC that uses a typeless format. Any changes done to this class should also go to that client class.

Nested Class Summary

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

TransportRequest.Empty

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

IndicesRequest.Replaceable

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

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

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

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
void	fromXContent(boolean isTypeIncluded, XContentParser parser)
java.lang.String	getAlias()
java.util.Map<java.lang.String,Condition>	getConditions()
CreateIndexRequest	getCreateIndexRequest()	Returns the inner CreateIndexRequest.
java.lang.String	getNewIndexName()
java.lang.String[]	indices()	Returns the array of indices that the action relates to
IndicesOptions	indicesOptions()	Returns the indices options used to resolve indices.
boolean	isDryRun()
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	setNewIndexName(java.lang.String newIndexName)	Sets the alias to rollover to another index
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

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

ackTimeout, timeout, timeout, timeout

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

masterNodeTimeout, masterNodeTimeout, masterNodeTimeout

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

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

masterNodeTimeout

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

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.

isDryRun

public boolean isDryRun()

getConditions

public java.util.Map<java.lang.String,Condition> getConditions()

getAlias

public java.lang.String getAlias()

getNewIndexName

public java.lang.String getNewIndexName()

getCreateIndexRequest

public CreateIndexRequest getCreateIndexRequest()

Returns the inner CreateIndexRequest. Allows to configure mappings, settings and aliases for the new index.

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

fromXContent

public void fromXContent(boolean isTypeIncluded,
                         XContentParser parser)
                  throws java.io.IOException

Throws:

java.io.IOException