Package co.elastic.clients.elasticsearch.indices

Class ResolveClusterRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allowNoIndices

      public final ResolveClusterRequest.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

    • expandWildcards

      public final ResolveClusterRequest.Builder expandWildcards(List<ExpandWildcard> list)
      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. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      public final ResolveClusterRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      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. Supports comma-separated values, such as open,hidden. Valid values are: all, open, closed, hidden, none.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreThrottled

      public final ResolveClusterRequest.Builder ignoreThrottled(@Nullable Boolean value)
      If true, concrete, expanded or aliased indices are ignored when frozen. Defaults to false.

      API name: ignore_throttled

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • name

      public final ResolveClusterRequest.Builder name(List<String> list)
      Required - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.

      API name: name

      Adds all elements of list to name.

    • name

      public final ResolveClusterRequest.Builder name(String value, String... values)
      Required - Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax.

      API name: name

      Adds one or more values to name.

    • self

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

    • build

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