Class GetIndicesSettingsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.GetIndicesSettingsRequest
Returns settings for one or more 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 TypeFieldDescriptionEndpoint "indices.get_settings
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Whether to ignore if a wildcard indices expression resolves into no concrete indices.final List<ExpandWildcard>
Whether to expand wildcard expression to concrete indices that are open, closed or both.final Boolean
Return settings in flat format (default: false)final Boolean
Whether specified concrete indices should be ignored when unavailable (missing or closed)final Boolean
Whether to return all default setting for each of the indices.index()
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesfinal Boolean
local()
Return local information, do not retrieve the state from master node (default: false)final Time
Specify timeout for connection to mastername()
The name of the settings that should be includedstatic GetIndicesSettingsRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetIndicesSettingsRequest,GetIndicesSettingsResponse, _ENDPOINTErrorResponse> Endpoint "indices.get_settings
".
-
-
Method Details
-
of
public static GetIndicesSettingsRequest of(Function<GetIndicesSettingsRequest.Builder, ObjectBuilder<GetIndicesSettingsRequest>> fn) -
allowNoIndices
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_all
string or when no indices have been specified)API name:
allow_no_indices
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
flatSettings
Return settings in flat format (default: false)API name:
flat_settings
-
includeDefaults
Whether to return all default setting for each of the indices.API name:
include_defaults
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
local
Return local information, do not retrieve the state from master node (default: false)API name:
local
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
name
The name of the settings that should be includedAPI name:
name
-