Package org.opensearch.client.opensearch.indices

Class RolloverRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RolloverRequest.Builder	Builder for RolloverRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<RolloverRequest>	_DESERIALIZER	Json deserializer for RolloverRequest
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 rollover
java.util.Map<java.lang.String,Alias>	aliases()	API name: aliases
Time	clusterManagerTimeout()	Specify timeout for connection to cluster-manager
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.
IndexRolloverMapping	mappings()	API name: mappings
Time	masterTimeout()	Deprecated.
java.lang.String	newIndex()	The name of the rollover index
static 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 timeout
WaitForActiveShards	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 Detail

_DESERIALIZER

public static final JsonpDeserializer<RolloverRequest> _DESERIALIZER

Json deserializer for RolloverRequest

_ENDPOINT

public static final Endpoint<RolloverRequest,RolloverResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.rollover".

Method Detail

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 rollover

API name: alias

aliases

public final java.util.Map<java.lang.String,Alias> aliases()

API name: aliases

conditions

@Nullable
public final RolloverConditions 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 false

API name: dry_run

mappings

@Nullable
public final IndexRolloverMapping mappings()

API name: mappings

masterTimeout

@Deprecated
@Nullable
public final Time masterTimeout()

Deprecated.

Specify timeout for connection to master

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

Specify timeout for connection to cluster-manager

API name: cluster_manager_timeout

newIndex

@Nullable
public final java.lang.String newIndex()

The name of the rollover index

API name: new_index

settings

public final java.util.Map<java.lang.String,JsonData> settings()

API name: settings

timeout

@Nullable
public final Time timeout()

Explicit operation timeout

API name: timeout

waitForActiveShards

@Nullable
public final WaitForActiveShards 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

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupRolloverRequestDeserializer

protected static void setupRolloverRequestDeserializer(ObjectDeserializer<RolloverRequest.Builder> op)