Class RolloverRequest
- java.lang.Object
-
- org.elasticsearch.client.TimedRequest
-
- org.elasticsearch.client.indices.rollover.RolloverRequest
-
- All Implemented Interfaces:
Validatable
,ToXContent
,ToXContentObject
public class RolloverRequest extends TimedRequest implements ToXContentObject
Request class to swap index under an alias upon satisfying conditions
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
-
Field Summary
-
Fields inherited from class org.elasticsearch.client.TimedRequest
DEFAULT_ACK_TIMEOUT, DEFAULT_MASTER_NODE_TIMEOUT
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
-
Constructor Summary
Constructors Constructor Description RolloverRequest(java.lang.String alias, java.lang.String newIndexName)
-
Method Summary
Modifier and Type Method Description RolloverRequest
addMaxIndexAgeCondition(TimeValue age)
Adds condition to check if the index is at leastage
oldRolloverRequest
addMaxIndexDocsCondition(long numDocs)
Adds condition to check if the index has at leastnumDocs
RolloverRequest
addMaxIndexSizeCondition(ByteSizeValue size)
Adds a size-based condition to check if the index size is at leastsize
.RolloverRequest
dryRun(boolean dryRun)
Sets if the rollover should not be executed when conditions are metjava.lang.String
getAlias()
Returns the alias of the rollover operationjava.util.Map<java.lang.String,Condition<?>>
getConditions()
Returns all set conditionsCreateIndexRequest
getCreateIndexRequest()
Returns the innerCreateIndexRequest
.java.lang.String
getNewIndexName()
Returns the new index name for the rolloverboolean
isDryRun()
Returns if the rollover should not be executed when conditions are metXContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
-
Methods inherited from class org.elasticsearch.client.TimedRequest
masterNodeTimeout, setMasterTimeout, setTimeout, timeout
-
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.xcontent.ToXContentObject
isFragment
-
Methods inherited from interface org.elasticsearch.client.Validatable
validate
-
-
-
-
Method Detail
-
getAlias
public java.lang.String getAlias()
Returns the alias of the rollover operation
-
getNewIndexName
public java.lang.String getNewIndexName()
Returns the new index name for the rollover
-
dryRun
public RolloverRequest dryRun(boolean dryRun)
Sets if the rollover should not be executed when conditions are met
-
isDryRun
public boolean isDryRun()
Returns if the rollover should not be executed when conditions are met
-
addMaxIndexAgeCondition
public RolloverRequest addMaxIndexAgeCondition(TimeValue age)
Adds condition to check if the index is at leastage
old
-
addMaxIndexDocsCondition
public RolloverRequest addMaxIndexDocsCondition(long numDocs)
Adds condition to check if the index has at leastnumDocs
-
addMaxIndexSizeCondition
public RolloverRequest addMaxIndexSizeCondition(ByteSizeValue size)
Adds a size-based condition to check if the index size is at leastsize
.
-
getConditions
public java.util.Map<java.lang.String,Condition<?>> getConditions()
Returns all set conditions
-
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 java.io.IOException
- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
-