Class RolloverRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.RolloverRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class RolloverRequest extends RequestBase implements JsonpSerializable
Updates an alias to point to a new index when the existing index is
considered to be too large or too old.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RolloverRequest.Builder
Builder forRolloverRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<RolloverRequest>
_DESERIALIZER
Json deserializer forRolloverRequest
static Endpoint<RolloverRequest,RolloverResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.rollover
". -
Method Summary
Modifier and Type Method Description java.lang.String
alias()
Required - The name of the alias to rolloverjava.util.Map<java.lang.String,Alias>
aliases()
API name:aliases
RolloverConditions
conditions()
API name:conditions
java.lang.Boolean
dryRun()
If set to true the rollover action will only be validated but not actually performed even if a condition matches.java.lang.Boolean
includeTypeName()
Whether a type should be included in the body of the mappings.IndexRolloverMapping
mappings()
API name:mappings
Time
masterTimeout()
Specify timeout for connection to masterjava.lang.String
newIndex()
The name of the rollover indexstatic RolloverRequest
of(java.util.function.Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)
void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.util.Map<java.lang.String,JsonData>
settings()
API name:settings
protected static void
setupRolloverRequestDeserializer(ObjectDeserializer<RolloverRequest.Builder> op)
Time
timeout()
Explicit operation timeoutWaitForActiveShards
waitForActiveShards()
Set the number of active shards to wait for on the newly created rollover index before the operation returns.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forRolloverRequest
-
_ENDPOINT
Endpoint "indices.rollover
".
-
-
Method Details
-
of
public static RolloverRequest of(java.util.function.Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn) -
alias
public final java.lang.String alias()Required - The name of the alias to rolloverAPI name:
alias
-
aliases
API name:aliases
-
conditions
API name:conditions
-
dryRun
@Nullable public final java.lang.Boolean dryRun()If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is falseAPI name:
dry_run
-
includeTypeName
@Nullable public final java.lang.Boolean includeTypeName()Whether a type should be included in the body of the mappings.API name:
include_type_name
-
mappings
API name:mappings
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
newIndex
@Nullable public final java.lang.String newIndex()The name of the rollover indexAPI name:
new_index
-
settings
API name:settings
-
timeout
Explicit operation timeoutAPI name:
timeout
-
waitForActiveShards
Set the number of active shards to wait for on the newly created rollover index before the operation returns.API name:
wait_for_active_shards
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupRolloverRequestDeserializer
protected static void setupRolloverRequestDeserializer(ObjectDeserializer<RolloverRequest.Builder> op)
-