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, PlainJsonSerializable, ToCopyableBuilder<RolloverRequest.Builder,RolloverRequest>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public final class RolloverRequest extends RequestBase implements PlainJsonSerializable, ToCopyableBuilder<RolloverRequest.Builder,RolloverRequest>
Updates an alias to point to a new index when the existing index is considered to be too large or too old.

  • Field Details

  • Method Details

    • of

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

    • alias

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

      API name: alias

    • aliases

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

      API name: aliases

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • conditions

      @Nullable public final RolloverConditions conditions()
      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()
      API name: mappings

    • masterTimeout

      @Deprecated @Nullable public final Time masterTimeout()
      Deprecated.
      Period to wait for a connection to the cluster-manager 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

      @Nonnull 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)

    • toBuilder

      @Nonnull public RolloverRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RolloverRequest.Builder,RolloverRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static RolloverRequest.Builder builder()

    • setupRolloverRequestDeserializer

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

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object