Class GetIndicesSettingsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.indices.GetIndicesSettingsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<GetIndicesSettingsRequest>
- Enclosing class:
- GetIndicesSettingsRequest
public static class GetIndicesSettingsRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<GetIndicesSettingsRequest>
Builder for
GetIndicesSettingsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description GetIndicesSettingsRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.GetIndicesSettingsRequest
build()
Builds aGetIndicesSettingsRequest
.GetIndicesSettingsRequest.Builder
expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Whether to expand wildcard expression to concrete indices that are open, closed or both.GetIndicesSettingsRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
Whether to expand wildcard expression to concrete indices that are open, closed or both.GetIndicesSettingsRequest.Builder
flatSettings(java.lang.Boolean value)
Return settings in flat format (default: false)GetIndicesSettingsRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)GetIndicesSettingsRequest.Builder
includeDefaults(java.lang.Boolean value)
Whether to return all default setting for each of the indices.GetIndicesSettingsRequest.Builder
index(java.lang.String value, java.lang.String... values)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesGetIndicesSettingsRequest.Builder
index(java.util.List<java.lang.String> list)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesGetIndicesSettingsRequest.Builder
local(java.lang.Boolean value)
Return local information, do not retrieve the state from master node (default: false)GetIndicesSettingsRequest.Builder
masterTimeout(Time value)
Specify timeout for connection to masterGetIndicesSettingsRequest.Builder
masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Specify timeout for connection to masterGetIndicesSettingsRequest.Builder
name(java.lang.String value, java.lang.String... values)
The name of the settings that should be includedGetIndicesSettingsRequest.Builder
name(java.util.List<java.lang.String> list)
The name of the settings that should be includedMethods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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
public final GetIndicesSettingsRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)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
public final GetIndicesSettingsRequest.Builder index(java.lang.String value, java.lang.String... values)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(java.util.function.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
public final GetIndicesSettingsRequest.Builder name(java.lang.String value, java.lang.String... values)The name of the settings that should be includedAPI name:
name
Adds one or more values to
name
. -
build
Builds aGetIndicesSettingsRequest
.- Specified by:
build
in interfaceObjectBuilder<GetIndicesSettingsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-