Package org.opensearch.client.opensearch.indices

Class AliasDefinition

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

  • Field Details

  • Method Details

    • of

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

    • filter

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

    • indexRouting

      @Nullable public final String indexRouting()
      The value used to route indexing operations to a specific shard. When specified, this overwrites the routing value for indexing operations.

      API name: index_routing

    • isHidden

      @Nullable public final Boolean isHidden()
      When true, the alias is hidden. All indexes for the alias must have the same is_hidden value.

      API name: is_hidden

    • isWriteIndex

      @Nullable public final Boolean isWriteIndex()
      When true, the index is the write index for the alias.

      API name: is_write_index

    • routing

      @Nullable public final String routing()
      The value used to route indexing and search operations to a specific shard.

      API name: routing

    • searchRouting

      @Nullable public final String searchRouting()
      The value used to route search operations to a specific shard. When specified, this overwrites the routing value for search operations.

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

    • builder

      @Nonnull public static AliasDefinition.Builder builder()

    • setupAliasDefinitionDeserializer

      protected static void setupAliasDefinitionDeserializer(ObjectDeserializer<AliasDefinition.Builder> op)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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