Package co.elastic.clients.elasticsearch.indices

Class PutAliasRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutAliasRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutAliasRequest
extends RequestBase
implements JsonpSerializable
Creates or updates an alias.
See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static PutAliasRequest of​(java.util.function.Function<PutAliasRequest.Builder,​ObjectBuilder<PutAliasRequest>> fn)

    • filter

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

    • index

      public final java.util.List<java.lang.String> index()
      Required - A comma-separated list of index names the alias should point to (supports wildcards); use _all to perform the operation on all indices.

      API name: index

    • indexRouting

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

    • isWriteIndex

      @Nullable public final java.lang.Boolean isWriteIndex()
      API name: is_write_index

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Specify timeout for connection to master

      API name: master_timeout

    • name

      public final java.lang.String name()
      Required - The name of the alias to be created or updated

      API name: name

    • routing

      @Nullable public final java.lang.String routing()
      API name: routing

    • searchRouting

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

    • timeout

      @Nullable public final Time timeout()
      Explicit timestamp for the document

      API name: timeout

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

    • setupPutAliasRequestDeserializer

      protected static void setupPutAliasRequestDeserializer​(ObjectDeserializer<PutAliasRequest.Builder> op)