Package co.elastic.clients.elasticsearch.indices

Class RemoveBlockRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.RemoveBlockRequest
public class RemoveBlockRequest extends RequestBase
Remove an index block.

Remove an index block from an index. Index blocks limit the operations allowed on an index by blocking specific operation types.

See Also:

  • Field Details

  • Method Details

    • of

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

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

      API name: allow_no_indices

    • block

      public final IndicesBlockOptions block()
      Required - The block type to remove from the index.

      API name: block

    • expandWildcards

      public final List<ExpandWildcard> expandWildcards()
      The type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. It supports comma-separated values, such as open,hidden.

      API name: expand_wildcards

    • ignoreUnavailable

      @Nullable public final Boolean ignoreUnavailable()
      If false, the request returns an error if it targets a missing or closed index.

      API name: ignore_unavailable

    • index

      public final String index()
      Required - A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you are removing blocks from. To allow the removal of blocks from indices with _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the elasticsearch.yml file or by using the cluster update settings API.

      API name: index

    • masterTimeout

      @Nullable public final Time masterTimeout()
      The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.

      API name: master_timeout

    • timeout

      @Nullable public final Time timeout()
      The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. It can also be set to -1 to indicate that the request should never timeout.

      API name: timeout