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,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(String alias, String newIndexName)RolloverRequest(StreamInput in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddMaxIndexAgeCondition(TimeValue age)Adds condition to check if the index is at leastageoldvoidaddMaxIndexDocsCondition(long numDocs)Adds condition to check if the index has at leastnumDocsvoidaddMaxIndexSizeCondition(ByteSizeValue size)Adds a size-based condition to check if the index size is at leastsize.voiddryRun(boolean dryRun)Sets if the rollover should not be executed when conditions are metvoidfromXContent(boolean isTypeIncluded, XContentParser parser)StringgetAlias()Map<String,Condition<?>>getConditions()CreateIndexRequestgetCreateIndexRequest()Returns the innerCreateIndexRequest.StringgetNewIndexName()String[]indices()Returns the array of indices that the action relates toIndicesOptionsindicesOptions()Returns the indices options used to resolve indices.booleanisDryRun()voidsetAlias(String alias)Sets the alias to rollover to another indexvoidsetNewIndexName(String newIndexName)Sets the alias to rollover to another indexXContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params)ActionRequestValidationExceptionvalidate()voidwriteTo(StreamOutput out)Write this into the 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(StreamInput in) throws IOException
- Throws:
IOException
-
-
Method Detail
-
validate
public ActionRequestValidationException validate()
- Specified by:
validatein classActionRequest
-
writeTo
public void writeTo(StreamOutput out) throws IOException
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Overrides:
writeToin classAcknowledgedRequest<RolloverRequest>- Throws:
IOException
-
indices
public String[] indices()
Description copied from interface:IndicesRequestReturns the array of indices that the action relates to- Specified by:
indicesin interfaceIndicesRequest
-
indicesOptions
public IndicesOptions 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
-
setAlias
public void setAlias(String alias)
Sets the alias to rollover to another index
-
setNewIndexName
public void setNewIndexName(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 leastageold
-
addMaxIndexDocsCondition
public void addMaxIndexDocsCondition(long numDocs)
Adds condition to check if the index has at leastnumDocs
-
addMaxIndexSizeCondition
public void addMaxIndexSizeCondition(ByteSizeValue size)
Adds a size-based condition to check if the index size is at leastsize.
-
isDryRun
public boolean isDryRun()
-
getAlias
public String getAlias()
-
getNewIndexName
public String getNewIndexName()
-
getCreateIndexRequest
public CreateIndexRequest getCreateIndexRequest()
Returns the innerCreateIndexRequest. Allows to configure mappings, settings and aliases for the new index.
-
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
- Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
fromXContent
public void fromXContent(boolean isTypeIncluded, XContentParser parser) throws IOException- Throws:
IOException
-
-