Class GetIndexRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetIndexRequest
Returns information about one or more indices. For data streams, the API
returns information about the stream’s backing indices.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<GetIndexRequest,
GetIndexResponse, ErrorResponse> Endpoint "indices.get
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices.final List<ExpandWildcard>
Type of index that wildcard expressions can match.features()
Return only information on specified index featuresfinal Boolean
If true, returns settings in flat format.final Boolean
If false, requests that target a missing index return an error.final Boolean
If true, return all default settings in the response.index()
Required - Comma-separated list of data streams, indices, and index aliases used to limit the request.final Boolean
local()
If true, the request retrieves information from the local node only.final Time
Period to wait for a connection to the master node.static GetIndexRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "indices.get
".
-
-
Method Details
-
of
public static GetIndexRequest of(Function<GetIndexRequest.Builder, ObjectBuilder<GetIndexRequest>> fn) -
allowNoIndices
If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. 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
-
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
-
features
Return only information on specified index featuresAPI name:
features
-
flatSettings
If true, returns settings in flat format.API name:
flat_settings
-
includeDefaults
If true, return all default settings in the response.API name:
include_defaults
-
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
If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.API name:
local
-
masterTimeout
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
-