Package co.elastic.clients.elasticsearch.indices.update_aliases

Class AddAction

java.lang.Object
co.elastic.clients.elasticsearch.indices.update_aliases.AddAction
All Implemented Interfaces:
ActionVariant, JsonpSerializable
@JsonpDeserializable public class AddAction extends Object implements ActionVariant, JsonpSerializable
See Also:

  • 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()
      Alias for the action. Index alias names support date math.

      API name: alias

    • aliases

      public final List<String> aliases()
      Aliases for the action. Index alias names support date math.

      API name: aliases

    • filter

      @Nullable public final Query filter()
      Query used to limit documents the alias can access.

      API name: filter

    • index

      @Nullable public final String index()
      Data stream or index for the action. Supports wildcards (*).

      API name: index

    • indices

      public final List<String> indices()
      Data streams or indices for the action. Supports wildcards (*).

      API name: indices

    • indexRouting

      @Nullable public final String indexRouting()
      Value used to route indexing operations to a specific shard. If specified, this overwrites the routing value for indexing operations. Data stream aliases don’t support this parameter.

      API name: index_routing

    • isHidden

      @Nullable public final Boolean isHidden()
      If true, the alias is hidden.

      API name: is_hidden

    • isWriteIndex

      @Nullable public final Boolean isWriteIndex()
      If true, sets the write index or data stream for the alias.

      API name: is_write_index

    • routing

      @Nullable public final String routing()
      Value used to route indexing and search operations to a specific shard. Data stream aliases don’t support this parameter.

      API name: routing

    • searchRouting

      @Nullable public final String searchRouting()
      Value used to route search operations to a specific shard. If specified, this overwrites the routing value for search operations. Data stream aliases don’t support this parameter.

      API name: search_routing

    • mustExist

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

      API name: must_exist

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

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • setupAddActionDeserializer

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