Package org.opensearch.client.opensearch.indices.update_aliases

Class AddAction

java.lang.Object
org.opensearch.client.opensearch.indices.update_aliases.AddAction
All Implemented Interfaces:
JsonpSerializable, PlainJsonSerializable, ActionVariant, ToCopyableBuilder<AddAction.Builder,AddAction>
@JsonpDeserializable @Generated("org.opensearch.client.codegen.CodeGenerator") public class AddAction extends Object implements ActionVariant, PlainJsonSerializable, ToCopyableBuilder<AddAction.Builder,AddAction>
The configuration for adding an alias.

  • Field Details

  • Method Details

    • of

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

    • _actionKind

      public Action.Kind _actionKind()
      Action variant kind.
      Specified by:
      _actionKind in interface ActionVariant

    • alias

      @Nullable public final String alias()
      API name: alias

    • aliases

      @Nonnull public final List<String> aliases()
      The list of aliases to add. Index alias names support date math.

      API name: aliases

    • filter

      @Nullable public final Query filter()
      API name: filter

    • index

      @Nullable public final String index()
      API name: index

    • indexRouting

      @Nullable public final String indexRouting()
      API name: index_routing

    • indices

      @Nonnull public final List<String> indices()
      API name: indices

    • isHidden

      @Nullable public final Boolean isHidden()
      Whether the alias is hidden.

      API name: is_hidden

    • isWriteIndex

      @Nullable public final Boolean isWriteIndex()
      Whether this is the write index or data stream for the alias.

      API name: is_write_index

    • mustExist

      @Nullable public final Boolean mustExist()
      Whether the alias must exist to perform the action.

      API name: must_exist

    • routing

      @Nullable public final String routing()
      API name: routing

    • searchRouting

      @Nullable public final String searchRouting()
      API name: search_routing

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

    • builder

      @Nonnull public static AddAction.Builder builder()

    • setupAddActionDeserializer

      protected static void setupAddActionDeserializer(ObjectDeserializer<AddAction.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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