Package org.opensearch.client.opensearch.indices

Class OpenRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<OpenRequest.Builder>
org.opensearch.client.opensearch.indices.OpenRequest.Builder
All Implemented Interfaces:
CopyableBuilder<OpenRequest.Builder,OpenRequest>, MutableBuilder<OpenRequest.Builder,OpenRequest>, ObjectBuilder<OpenRequest>
Enclosing class:
OpenRequest
public static class OpenRequest.Builder extends RequestBase.AbstractBuilder<OpenRequest.Builder> implements CopyableBuilder<OpenRequest.Builder,OpenRequest>
Builder for OpenRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public OpenRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<OpenRequest.Builder,OpenRequest>
      Returns:
      a new builder instance.

    • self

      @Nonnull protected OpenRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<OpenRequest.Builder>

    • allowNoIndices

      @Nonnull public final OpenRequest.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 indexes. This behavior applies even if the request targets other open indexes.

      API name: allow_no_indices

    • clusterManagerTimeout

      @Nonnull public final OpenRequest.Builder clusterManagerTimeout(@Nullable Time value)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • clusterManagerTimeout

      @Nonnull public final OpenRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Operation timeout for connection to cluster-manager node.

      API name: cluster_manager_timeout

    • expandWildcards

      @Nonnull public final OpenRequest.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

      @Nonnull public final OpenRequest.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.

    • ignoreUnavailable

      @Nonnull public final OpenRequest.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

      @Nonnull public final OpenRequest.Builder index(List<String> list)
      Required - Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indexes you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the opensearch.yml file or using the cluster update settings API.

      API name: index

      Adds all elements of list to index.

    • index

      @Nonnull public final OpenRequest.Builder index(String value, String... values)
      Required - Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). By default, you must explicitly name the indexes you using to limit the request. To limit a request using _all, *, or other wildcard expressions, change the action.destructive_requires_name setting to false. You can update this setting in the opensearch.yml file or using the cluster update settings API.

      API name: index

      Adds one or more values to index.

    • masterTimeout

      @Deprecated @Nonnull public final OpenRequest.Builder masterTimeout(@Nullable Time value)
      Deprecated.
      Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • masterTimeout

      @Deprecated @Nonnull public final OpenRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Deprecated.
      Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • taskExecutionTimeout

      @Nonnull public final OpenRequest.Builder taskExecutionTimeout(@Nullable Time value)
      Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

      API name: task_execution_timeout

    • taskExecutionTimeout

      @Nonnull public final OpenRequest.Builder taskExecutionTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

      API name: task_execution_timeout

    • timeout

      @Nonnull public final OpenRequest.Builder timeout(@Nullable Time value)
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • timeout

      @Nonnull public final OpenRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

      API name: timeout

    • waitForActiveShards

      @Nonnull public final OpenRequest.Builder waitForActiveShards(@Nullable WaitForActiveShards value)
      The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      API name: wait_for_active_shards

    • waitForActiveShards

      @Nonnull public final OpenRequest.Builder waitForActiveShards(Function<WaitForActiveShards.Builder,ObjectBuilder<WaitForActiveShards>> fn)
      The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

      API name: wait_for_active_shards

    • waitForCompletion

      @Nonnull public final OpenRequest.Builder waitForCompletion(@Nullable Boolean value)
      Should this request wait until the operation has completed before returning.

      API name: wait_for_completion

    • build

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