Package org.opensearch.client.opensearch.indices

Class GetIndexRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.GetIndexRequest

public class GetIndexRequest
extends RequestBase

Returns information about one or more indices.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetIndexRequest.Builder	Builder for GetIndexRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static Endpoint<GetIndexRequest,GetIndexResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.get".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoIndices()	Ignore if a wildcard expression resolves to no concrete indices (default: false)
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.util.List<ExpandWildcard>	expandWildcards()	Type of index that wildcard expressions can match.
java.lang.Boolean	flatSettings()	If true, returns settings in flat format.
java.lang.Boolean	ignoreUnavailable()	If false, requests that target a missing index return an error.
java.lang.Boolean	includeDefaults()	If true, return all default settings in the response.
java.util.List<java.lang.String>	index()	Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.
java.lang.Boolean	local()	If true, the request retrieves information from the local node only.
Time	masterTimeout()	Deprecated.
static GetIndexRequest	of(java.util.function.Function<GetIndexRequest.Builder,ObjectBuilder<GetIndexRequest>> fn)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_ENDPOINT

public static final Endpoint<GetIndexRequest,GetIndexResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.get".

Method Detail

of

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

allowNoIndices

@Nullable
public final java.lang.Boolean allowNoIndices()

Ignore if a wildcard expression resolves to no concrete indices (default: false)

API name: allow_no_indices

expandWildcards

public final java.util.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 java.lang.Boolean flatSettings()

If true, returns settings in flat format.

API name: flat_settings

ignoreUnavailable

@Nullable
public final java.lang.Boolean ignoreUnavailable()

If false, requests that target a missing index return an error.

API name: ignore_unavailable

includeDefaults

@Nullable
public final java.lang.Boolean includeDefaults()

If true, return all default settings in the response.

API name: include_defaults

index

public final java.util.List<java.lang.String> index()

Required - Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported.

API name: index

local

@Nullable
public final java.lang.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 master node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

clusterManagerTimeout

@Nullable
public final Time clusterManagerTimeout()

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: cluster_manager_timeout