Package org.opensearch.client.opensearch.indices

Class GetIndexRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.indices.GetIndexRequest
All Implemented Interfaces:
ToCopyableBuilder<GetIndexRequest.Builder,GetIndexRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class GetIndexRequest extends RequestBase implements ToCopyableBuilder<GetIndexRequest.Builder,GetIndexRequest>
Returns information about one or more indexes.

  • Field Details

  • Method Details

    • of

      public static GetIndexRequest of(Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)

    • allowNoIndices

      @Nullable public final Boolean allowNoIndices()
      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

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

      API name: cluster_manager_timeout

    • expandWildcards

      @Nonnull public final List<ExpandWildcard> expandWildcards()
      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

    • flatSettings

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

      API name: flat_settings

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • includeDefaults

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

      API name: include_defaults

    • index

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

      API name: index

    • local

      @Nullable public final Boolean local()
      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 @Nullable public final Time masterTimeout()
      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

    • toBuilder

      @Nonnull public GetIndexRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetIndexRequest.Builder,GetIndexRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static GetIndexRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object