Module org.elasticsearch.server
Class RolloverRequest
java.lang.Object
org.elasticsearch.transport.TransportMessage
org.elasticsearch.transport.AbstractTransportRequest
org.elasticsearch.action.ActionRequest
org.elasticsearch.action.LegacyActionRequest
org.elasticsearch.action.support.master.MasterNodeRequest<RolloverRequest>
org.elasticsearch.action.support.master.AcknowledgedRequest<RolloverRequest>
org.elasticsearch.action.admin.indices.rollover.RolloverRequest
- All Implemented Interfaces:
IndicesRequest,Writeable,RefCounted,TaskAwareRequest,TransportRequest
Request class to swap index under an alias or increment data stream generation 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.action.support.master.AcknowledgedRequest
AcknowledgedRequest.PlainNested classes/interfaces inherited from interface org.elasticsearch.action.IndicesRequest
IndicesRequest.RemoteClusterShardRequest, IndicesRequest.Replaceable, IndicesRequest.SingleIndexNoWildcardsNested 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_TIMEOUTFields inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
INFINITE_MASTER_NODE_TIMEOUT, TRAPPY_IMPLICIT_DEFAULT_MASTER_NODE_TIMEOUTFields inherited from interface org.elasticsearch.core.RefCounted
ALWAYS_REFERENCED -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanareConditionsMet(Map<String, Boolean> conditionResults) Given the results of evaluating each individual condition, determine whether the rollover request should proceed -- that is, whether the conditions are met.Returns the task object that should be used to keep track of the processing of the request.voiddryRun(boolean dryRun) Sets if the rollover should not be executed when conditions are metbooleanvoidfromXContent(XContentParser parser) Collection<Condition<?>> Returns the innerCreateIndexRequest.inthashCode()booleanDetermines whether the request should be applied to data streams.String[]indices()Returns the array of indices that the action relates toReturns the indices options used to resolve indices.booleanisDryRun()booleanisLazy()voidlazy(boolean lazy) Sets if an unconditional rollover should wait for a document to come before it gets executedvoidsetConditions(RolloverConditions conditions) Sets the conditions that need to be met for the index to roll overvoidsetIndicesOptions(IndicesOptions indicesOptions) voidsetNewIndexName(String newIndexName) Sets the alias to roll over to another indexvoidsetRolloverTarget(String rolloverTarget) Sets the rollover target to roll over to another indexvoidsetWaitForActiveShards(ActiveShardCount waitForActiveShards) Sets the wait for active shards configuration for the rolled index that gets created.validate()voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.action.support.master.AcknowledgedRequest
ackTimeout, ackTimeoutMethods inherited from class org.elasticsearch.action.support.master.MasterNodeRequest
masterNodeTimeout, masterNodeTimeout, masterTermMethods inherited from class org.elasticsearch.action.ActionRequest
getShouldStoreResultMethods inherited from class org.elasticsearch.transport.AbstractTransportRequest
getParentTask, getRequestId, remoteAddress, remoteAddress, setParentTask, setRequestId, toStringMethods inherited from class org.elasticsearch.transport.TransportMessage
decRef, hasReferences, incRef, tryIncRefMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.core.RefCounted
decRef, hasReferences, incRef, mustIncRef, tryIncRefMethods inherited from interface org.elasticsearch.tasks.TaskAwareRequest
createTask, getDescription, setParentTask
-
Constructor Details
-
RolloverRequest
- Throws:
IOException
-
RolloverRequest
-
-
Method Details
-
validate
- Overrides:
validatein classAcknowledgedRequest<RolloverRequest>
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classAcknowledgedRequest<RolloverRequest>- Throws:
IOException
-
indices
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
indicesOptions
Description copied from interface:IndicesRequestReturns 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:
indicesOptionsin interfaceIndicesRequest
-
setIndicesOptions
-
includeDataStreams
public boolean includeDataStreams()Description copied from interface:IndicesRequestDetermines whether the request should be applied to data streams. Whenfalse, none of the names or wildcard expressions inIndicesRequest.indices()should be applied to or expanded to any data streams. All layers involved in the request's fulfillment including security, name resolution, etc., should respect this flag.- Specified by:
includeDataStreamsin interfaceIndicesRequest
-
setRolloverTarget
Sets the rollover target to roll over to another index -
setNewIndexName
Sets the alias to roll over to another index -
dryRun
public void dryRun(boolean dryRun) Sets if the rollover should not be executed when conditions are met -
setWaitForActiveShards
Sets the wait for active shards configuration for the rolled index that gets created. -
setConditions
Sets the conditions that need to be met for the index to roll over -
lazy
public void lazy(boolean lazy) Sets if an unconditional rollover should wait for a document to come before it gets executed -
isDryRun
public boolean isDryRun() -
getConditions
-
getConditionValues
-
getRolloverTarget
-
getNewIndexName
-
isLazy
public boolean isLazy() -
areConditionsMet
Given the results of evaluating each individual condition, determine whether the rollover request should proceed -- that is, whether the conditions are met. If there are no conditions at all, then the request is unconditional (i.e. a command), and the conditions are met. If the request has conditions, then all min_* conditions and at least one max_* condition must have a true result.- Parameters:
conditionResults- a map of individual conditions and their associated evaluation results- Returns:
- where the conditions for rollover are satisfied or not
-
getCreateIndexRequest
Returns the innerCreateIndexRequest. Allows to configure mappings, settings and aliases for the new index. -
fromXContent
- Throws:
IOException
-
createTask
public Task createTask(long id, String type, String action, TaskId parentTaskId, Map<String, String> headers) Description copied from interface:TaskAwareRequestReturns the task object that should be used to keep track of the processing of the request.- Specified by:
createTaskin interfaceTaskAwareRequest
-
equals
-
hashCode
public int hashCode()
-