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)
      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. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      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. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      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. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • ignoreThrottled

      @Deprecated public final ResolveClusterRequest.Builder ignoreThrottled(@Nullable Boolean value)
      Deprecated.
      7.16.0
      If true, concrete, expanded, or aliased indices are ignored when frozen. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      API name: ignore_throttled

    • ignoreUnavailable

      public final ResolveClusterRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      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. NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index options to the _resolve/cluster API endpoint that takes no index expression.

      API name: ignore_unavailable

    • name

      public final ResolveClusterRequest.Builder name(List<String> list)
      A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax. Index and cluster exclusions (e.g., -cluster1:*) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching

      API name: name

      Adds all elements of list to name.

    • name

      public final ResolveClusterRequest.Builder name(String value, String... values)
      A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified using the <cluster>:<name> syntax. Index and cluster exclusions (e.g., -cluster1:*) are also supported. If no index expression is specified, information about all remote clusters configured on the local cluster is returned without doing any index matching

      API name: name

      Adds one or more values to name.

    • timeout

      public final ResolveClusterRequest.Builder timeout(@Nullable Time value)
      The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out.

      The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds).

      API name: timeout

    • timeout

      public final ResolveClusterRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      The maximum time to wait for remote clusters to respond. If a remote cluster does not respond within this timeout period, the API response will show the cluster as not connected and include an error message that the request timed out.

      The default timeout is unset and the query can take as long as the networking layer is configured to wait for remote clusters that are not responding (typically 30 seconds).

      API name: timeout

    • 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.