Package org.opensearch.client.opensearch.indices

Class AddBlockRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.AddBlockRequest
All Implemented Interfaces:
ToCopyableBuilder<AddBlockRequest.Builder,AddBlockRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class AddBlockRequest extends RequestBase implements ToCopyableBuilder<AddBlockRequest.Builder,AddBlockRequest>
Adds a block to an index.

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all string or when no indexes have been specified).

      API name: allow_no_indices

    • block

      @Nonnull public final IndicesBlockOptions block()
      Required - The block to add (one of read, write, read_only or metadata).

      API name: block

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      Whether to expand wildcard expression to concrete indexes that are open, closed or both.

      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      Whether specified concrete indexes should be ignored when unavailable (missing or closed).

      API name: ignore_unavailable

    • index

      @Nonnull public final List<String> index()
      Required - A comma separated list of indexes to add a block to.

      API name: index

    • masterTimeout

      @Deprecated @Nullable public final Time masterTimeout()
      Deprecated.
      Specify timeout for connection to cluster manager.

      API name: master_timeout

    • timeout

      @Nullable public final Time timeout()
      Explicit operation timeout

      API name: timeout

    • toBuilder

      @Nonnull public AddBlockRequest.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<AddBlockRequest.Builder,AddBlockRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static AddBlockRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

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