Package org.opensearch.client.opensearch.ism

Class Action

java.lang.Object
org.opensearch.client.opensearch.ism.Action
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<Action.Builder,Action>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class Action extends Object implements PlainJsonSerializable, ToCopyableBuilder<Action.Builder,Action>
An action to perform.

  • Field Details

  • Method Details

    • of

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

    • alias

      @Nullable public final ActionAlias alias()
      Adds or removes an index alias.

      API name: alias

    • allocation

      @Nullable public final ActionAllocation allocation()
      Sets the allocations settings for index.

      API name: allocation

    • close

      @Nullable public final ActionClose close()
      Closes an index.

      API name: close

    • custom

      @Nonnull public final Map<String,JsonData> custom()
      Enables custom operations to be performed on the index.

      API name: custom

    • delete

      @Nullable public final ActionDelete delete()
      Deletes an index.

      API name: delete

    • forceMerge

      @Nullable public final ActionForceMerge forceMerge()
      Force merges an index.

      API name: force_merge

    • indexPriority

      @Nullable public final ActionIndexPriority indexPriority()
      The priority level of the index.

      API name: index_priority

    • notification

      @Nonnull public final Map<String,JsonData> notification()
      Sets a policy which determines when to send a notification regarding the index.

      API name: notification

    • open

      @Nullable public final ActionOpen open()
      Opens an index.

      API name: open

    • readOnly

      @Nullable public final ActionReadOnly readOnly()
      Changes the index permissions to read-only.

      API name: read_only

    • readWrite

      @Nullable public final ActionReadWrite readWrite()
      Changes the index permissions to read-write.

      API name: read_write

    • replicaCount

      @Nullable public final ActionReplicaCount replicaCount()
      The number of replicas for the index.

      API name: replica_count

    • retry

      @Nullable public final ActionRetry retry()
      The number of times to retry the action.

      API name: retry

    • rollover

      @Nullable public final ActionRollover rollover()
      Sets a rollover policy for the index.

      API name: rollover

    • rollup

      @Nonnull public final Map<String,JsonData> rollup()
      Determines when to perform an index rollup.

      API name: rollup

    • shrink

      @Nonnull public final Map<String,JsonData> shrink()
      Determines when to shrink the index.

      API name: shrink

    • snapshot

      @Nullable public final ActionSnapshot snapshot()
      Takes a snapshot of the index.

      API name: snapshot

    • timeout

      @Nullable public final ActionTimeout timeout()
      The amount of time to wait before the action fails.

      API name: timeout

    • transform

      @Nonnull public final Map<String,JsonData> transform()
      Determines when to perform an index transform.

      API name: transform

    • 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 Action.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<Action.Builder,Action>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static Action.Builder builder()

    • setupActionDeserializer

      protected static void setupActionDeserializer(ObjectDeserializer<Action.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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