Class RolloverRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.RolloverRequest
- All Implemented Interfaces:
JsonpSerializable
Creates a new index for a data stream or index alias.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<RolloverRequest>
Json deserializer forRolloverRequest
static final Endpoint<RolloverRequest,
RolloverResponse, ErrorResponse> Endpoint "indices.rollover
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
alias()
Required - Name of the data stream or index alias to roll over.aliases()
Aliases for the target index.final RolloverConditions
Conditions for the rollover.final Boolean
dryRun()
Iftrue
, checks whether the current index satisfies the specified conditions but does not perform a rollover.final TypeMapping
mappings()
Mapping for fields in the index.final Time
Period to wait for a connection to the master node.final String
newIndex()
Name of the index to create.static RolloverRequest
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) settings()
Configuration options for the index.protected static void
final Time
timeout()
Period to wait for a response.final WaitForActiveShards
The number of shard copies that must be active before proceeding with the operation.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forRolloverRequest
-
_ENDPOINT
Endpoint "indices.rollover
".
-
-
Method Details
-
of
public static RolloverRequest of(Function<RolloverRequest.Builder, ObjectBuilder<RolloverRequest>> fn) -
alias
Required - Name of the data stream or index alias to roll over.API name:
alias
-
aliases
Aliases for the target index. Data streams do not support this parameter.API name:
aliases
-
conditions
Conditions for the rollover. If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. If this parameter is not specified, Elasticsearch performs the rollover unconditionally. If conditions are specified, at least one of them must be amax_*
condition. The index will rollover if anymax_*
condition is satisfied and allmin_*
conditions are satisfied.API name:
conditions
-
dryRun
Iftrue
, checks whether the current index satisfies the specified conditions but does not perform a rollover.API name:
dry_run
-
mappings
Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping paramaters.API name:
mappings
-
masterTimeout
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.API name:
master_timeout
-
newIndex
Name of the index to create. Supports date math. Data streams do not support this parameter.API name:
new_index
-
settings
Configuration options for the index. Data streams do not support this parameter.API name:
settings
-
timeout
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.API name:
timeout
-
waitForActiveShards
The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1
).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)
-