Class PutSettingsRequest.Builder
java.lang.Object
co.elastic.clients.elasticsearch.indices.PutSettingsRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<PutSettingsRequest>
- Enclosing class:
- PutSettingsRequest
public static class PutSettingsRequest.Builder extends java.lang.Object implements ObjectBuilder<PutSettingsRequest>
Builder for
PutSettingsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description PutSettingsRequest.Builder
addExpandWildcards(ExpandWildcardOptions value)
Add a value toexpandWildcards(List)
, creating the list if needed.PutSettingsRequest.Builder
addIndex(java.lang.String value)
Add a value toindex(List)
, creating the list if needed.PutSettingsRequest.Builder
allowNoIndices(java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices.PutSettingsRequest
build()
Builds aPutSettingsRequest
.PutSettingsRequest.Builder
expandWildcards(ExpandWildcardOptions... value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.PutSettingsRequest.Builder
expandWildcards(java.util.List<ExpandWildcardOptions> value)
Whether to expand wildcard expression to concrete indices that are open, closed or both.PutSettingsRequest.Builder
flatSettings(java.lang.Boolean value)
Return settings in flat format (default: false)PutSettingsRequest.Builder
ignoreUnavailable(java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)PutSettingsRequest.Builder
index(java.lang.String... value)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesPutSettingsRequest.Builder
index(java.util.List<java.lang.String> value)
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesPutSettingsRequest.Builder
masterTimeout(java.lang.String value)
Specify timeout for connection to masterPutSettingsRequest.Builder
preserveExisting(java.lang.Boolean value)
Whether to update existing settings.PutSettingsRequest.Builder
settings(IndexSettings value)
Required - Request body.PutSettingsRequest.Builder
settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)
Required - Request body.PutSettingsRequest.Builder
timeout(java.lang.String value)
Explicit operation timeoutMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
index
A comma-separated list of index names; use_all
or empty string to perform the operation on all indicesAPI name:
index
-
addIndex
Add a value toindex(List)
, creating the list if needed. -
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 PutSettingsRequest.Builder expandWildcards(@Nullable java.util.List<ExpandWildcardOptions> value)Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
expandWildcards
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcards
-
addExpandWildcards
Add a value toexpandWildcards(List)
, creating the list if needed. -
flatSettings
Return settings in flat format (default: false)API name:
flat_settings
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
preserveExisting
Whether to update existing settings. If set totrue
existing settings on an index remain unchanged, the default isfalse
API name:
preserve_existing
-
timeout
Explicit operation timeoutAPI name:
timeout
-
settings
Required - Request body.API name:
_value_body
-
settings
public PutSettingsRequest.Builder settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)Required - Request body.API name:
_value_body
-
build
Builds aPutSettingsRequest
.- Specified by:
build
in interfaceObjectBuilder<PutSettingsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-