Package org.opensearch.client.opensearch.indices

Class GetIndexRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public GetIndexRequest.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<GetIndexRequest.Builder,GetIndexRequest>
      Returns:
      a new builder instance.

    • self

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

    • allowNoIndices

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

    • clusterManagerTimeout

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

      API name: cluster_manager_timeout

    • clusterManagerTimeout

      @Nonnull public final GetIndexRequest.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 GetIndexRequest.Builder expandWildcards(List<ExpandWildcard> list)
      Type of index that wildcard expressions 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.

      API name: expand_wildcards

      Adds all elements of list to expandWildcards.

    • expandWildcards

      @Nonnull public final GetIndexRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
      Type of index that wildcard expressions 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.

      API name: expand_wildcards

      Adds one or more values to expandWildcards.

    • flatSettings

      @Nonnull public final GetIndexRequest.Builder flatSettings(@Nullable Boolean value)
      If true, returns settings in flat format.

      API name: flat_settings

    • ignoreUnavailable

      @Nonnull public final GetIndexRequest.Builder ignoreUnavailable(@Nullable Boolean value)
      If false, requests that target a missing index return an error.

      API name: ignore_unavailable

    • includeDefaults

      @Nonnull public final GetIndexRequest.Builder includeDefaults(@Nullable Boolean value)
      If true, return all default settings in the response.

      API name: include_defaults

    • index

      @Nonnull public final GetIndexRequest.Builder index(List<String> list)
      Required - Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported.

      API name: index

      Adds all elements of list to index.

    • index

      @Nonnull public final GetIndexRequest.Builder index(String value, String... values)
      Required - Comma-separated list of data streams, indexes, and index aliases used to limit the request. Wildcard expressions (*) are supported.

      API name: index

      Adds one or more values to index.

    • local

      @Nonnull public final GetIndexRequest.Builder local(@Nullable Boolean value)
      If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.

      API name: local

    • masterTimeout

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

    • build

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