Package co.elastic.clients.elasticsearch.indices

Class AddBlockRequest

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

Add an index block to 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 AddBlockRequest of(Function<AddBlockRequest.Builder,ObjectBuilder<AddBlockRequest>> fn)

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

      API name: allow_no_indices

    • block

      public final IndicesBlockOptions block()
      Required - The block type to add to 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 concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

      API name: ignore_unavailable

    • index

      public final List<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 adding blocks to. To allow the adding of blocks to 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

    • rebuild

      public AddBlockRequest.Builder rebuild()
      Returns:
      New AddBlockRequest.Builder initialized with field values of this instance