Package co.elastic.clients.elasticsearch.indices

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

  • Field Details

  • 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 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

    • 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

      @Nullable public final IndexRolloverMapping mappings()
      API name: mappings

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Specify timeout for connection to master

      API name: master_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)