Package co.elastic.clients.elasticsearch.indices

Class AddBlockRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<AddBlockRequest.Builder>
co.elastic.clients.elasticsearch.indices.AddBlockRequest.Builder
All Implemented Interfaces:
WithJson<AddBlockRequest.Builder>, ObjectBuilder<AddBlockRequest>
Enclosing class:
AddBlockRequest
public static class AddBlockRequest.Builder extends RequestBase.AbstractBuilder<AddBlockRequest.Builder> implements ObjectBuilder<AddBlockRequest>
Builder for AddBlockRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final AddBlockRequest.Builder allowNoIndices(@Nullable Boolean value)
      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 AddBlockRequest.Builder block(IndicesBlockOptions value)
      Required - The block type to add to the index.

      API name: block

    • expandWildcards

      public final AddBlockRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final AddBlockRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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

      Adds one or more values to expandWildcards.

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • index

      public final AddBlockRequest.Builder index(String value)
      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

      public final AddBlockRequest.Builder masterTimeout(@Nullable Time value)
      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

    • masterTimeout

      public final AddBlockRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

      public final AddBlockRequest.Builder timeout(@Nullable Time value)
      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

    • timeout

      public final AddBlockRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

    • self

      protected AddBlockRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<AddBlockRequest.Builder>

    • build

      public AddBlockRequest build()
      Builds a AddBlockRequest.
      Specified by:
      build in interface ObjectBuilder<AddBlockRequest>
      Throws:
      NullPointerException - if some of the required fields are null.