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

Class AddAction.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<AddAction.Builder>
co.elastic.clients.elasticsearch.indices.update_aliases.AddAction.Builder
All Implemented Interfaces:
WithJson<AddAction.Builder>, ObjectBuilder<AddAction>
Enclosing class:
AddAction
public static class AddAction.Builder extends WithJsonObjectBuilderBase<AddAction.Builder> implements ObjectBuilder<AddAction>
Builder for AddAction.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • alias

      public final AddAction.Builder alias(@Nullable String value)
      Alias for the action. Index alias names support date math.

      API name: alias

    • aliases

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

      API name: aliases

      Adds all elements of list to aliases.

    • aliases

      public final AddAction.Builder aliases(String value, String... values)
      Aliases for the action. Index alias names support date math.

      API name: aliases

      Adds one or more values to aliases.

    • filter

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

      API name: filter

    • filter

      public final AddAction.Builder filter(Function<Query.Builder,ObjectBuilder<Query>> fn)
      Query used to limit documents the alias can access.

      API name: filter

    • filter

      public final AddAction.Builder filter(QueryVariant value)
      Query used to limit documents the alias can access.

      API name: filter

    • index

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

      API name: index

    • indices

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

      API name: indices

      Adds all elements of list to indices.

    • indices

      public final AddAction.Builder indices(String value, String... values)
      Data streams or indices for the action. Supports wildcards (*).

      API name: indices

      Adds one or more values to indices.

    • indexRouting

      public final AddAction.Builder indexRouting(@Nullable String value)
      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

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

      API name: is_hidden

    • isWriteIndex

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

      API name: is_write_index

    • routing

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

      API name: routing

    • searchRouting

      public final AddAction.Builder searchRouting(@Nullable String value)
      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

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

      API name: must_exist

    • self

      protected AddAction.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<AddAction.Builder>

    • build

      public AddAction build()
      Builds a AddAction.
      Specified by:
      build in interface ObjectBuilder<AddAction>
      Throws:
      NullPointerException - if some of the required fields are null.