Class GetIndicesSettingsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>
co.elastic.clients.elasticsearch.indices.GetIndicesSettingsRequest.Builder
- All Implemented Interfaces:
WithJson<GetIndicesSettingsRequest.Builder>
,ObjectBuilder<GetIndicesSettingsRequest>
- Enclosing class:
- GetIndicesSettingsRequest
public static class GetIndicesSettingsRequest.Builder
extends RequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>
implements ObjectBuilder<GetIndicesSettingsRequest>
Builder for
GetIndicesSettingsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoIndices
(Boolean value) Whether to ignore if a wildcard indices expression resolves into no concrete indices.build()
Builds aGetIndicesSettingsRequest
.expandWildcards
(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.expandWildcards
(List<ExpandWildcard> list) Whether to expand wildcard expression to concrete indices that are open, closed or both.flatSettings
(Boolean value) Return settings in flat format (default: false)ignoreUnavailable
(Boolean value) Whether specified concrete indices should be ignored when unavailable (missing or closed)includeDefaults
(Boolean value) Whether to return all default setting for each of the indices.A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesA comma-separated list of index names; use_all
or empty string to perform the operation on all indicesReturn local information, do not retrieve the state from master node (default: false)masterTimeout
(Time value) Specify timeout for connection to masterSpecify timeout for connection to masterThe name of the settings that should be includedThe name of the settings that should be includedprotected GetIndicesSettingsRequest.Builder
self()
Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final GetIndicesSettingsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values) Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
Adds one or more values to
expandWildcards
. -
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
Adds all elements of
list
toindex
. -
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
Adds one or more values to
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
-
masterTimeout
public final GetIndicesSettingsRequest.Builder masterTimeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Specify timeout for connection to masterAPI name:
master_timeout
-
name
The name of the settings that should be includedAPI name:
name
Adds all elements of
list
toname
. -
name
The name of the settings that should be includedAPI name:
name
Adds one or more values to
name
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<GetIndicesSettingsRequest.Builder>
-
build
Builds aGetIndicesSettingsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetIndicesSettingsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-