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
Creates a new index for a data stream or index alias.
See Also:

  • Field Details

  • Method Details

    • of

      public static RolloverRequest of(Function<RolloverRequest.Builder,ObjectBuilder<RolloverRequest>> fn)

    • alias

      public final String alias()
      Required - Name of the data stream or index alias to roll over.

      API name: alias

    • aliases

      public final Map<String,Alias> aliases()
      Aliases for the target index. Data streams do not support this parameter.

      API name: aliases

    • conditions

      @Nullable public final RolloverConditions 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 a max_* condition. The index will rollover if any max_* condition is satisfied and all min_* conditions are satisfied.

      API name: conditions

    • dryRun

      @Nullable public final Boolean dryRun()
      If true, checks whether the current index satisfies the specified conditions but does not perform a rollover.

      API name: dry_run

    • mappings

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

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

      @Nullable public final String newIndex()
      Name of the index to create. Supports date math. Data streams do not support this parameter.

      API name: new_index

    • settings

      public final Map<String,JsonData> settings()
      Configuration options for the index. Data streams do not support this parameter.

      API name: settings

    • timeout

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

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

      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)