Class PutIndicesSettingsRequest.Builder
- java.lang.Object
-
- org.opensearch.client.util.ObjectBuilderBase
-
- org.opensearch.client.opensearch.indices.PutIndicesSettingsRequest.Builder
-
- All Implemented Interfaces:
ObjectBuilder<PutIndicesSettingsRequest>
- Enclosing class:
- PutIndicesSettingsRequest
public static class PutIndicesSettingsRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<PutIndicesSettingsRequest>
Builder forPutIndicesSettingsRequest.
-
-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description PutIndicesSettingsRequest.BuilderallowNoIndices(java.lang.Boolean value)Whether to ignore if a wildcard indices expression resolves into no concrete indices.PutIndicesSettingsRequestbuild()Builds aPutIndicesSettingsRequest.PutIndicesSettingsRequest.BuilderclusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Specify timeout for connection to cluster-managerPutIndicesSettingsRequest.BuilderclusterManagerTimeout(Time value)Specify timeout for connection to cluster-managerPutIndicesSettingsRequest.BuilderexpandWildcards(java.util.List<ExpandWildcard> list)Whether to expand wildcard expression to concrete indices that are open, closed or both.PutIndicesSettingsRequest.BuilderexpandWildcards(ExpandWildcard value, ExpandWildcard... values)Whether to expand wildcard expression to concrete indices that are open, closed or both.PutIndicesSettingsRequest.BuilderflatSettings(java.lang.Boolean value)Return settings in flat format (default: false)PutIndicesSettingsRequest.BuilderignoreUnavailable(java.lang.Boolean value)Whether specified concrete indices should be ignored when unavailable (missing or closed)PutIndicesSettingsRequest.Builderindex(java.lang.String value, java.lang.String... values)A comma-separated list of index names; use_allor empty string to perform the operation on all indicesPutIndicesSettingsRequest.Builderindex(java.util.List<java.lang.String> list)A comma-separated list of index names; use_allor empty string to perform the operation on all indicesPutIndicesSettingsRequest.BuildermasterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Deprecated.PutIndicesSettingsRequest.BuildermasterTimeout(Time value)Deprecated.PutIndicesSettingsRequest.BuilderpreserveExisting(java.lang.Boolean value)Whether to update existing settings.PutIndicesSettingsRequest.Buildersettings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)Required - Request body.PutIndicesSettingsRequest.Buildersettings(IndexSettings value)Required - Request body.PutIndicesSettingsRequest.Buildertimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)Explicit operation timeoutPutIndicesSettingsRequest.Buildertimeout(Time value)Explicit operation timeout-
Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
-
-
-
Method Detail
-
allowNoIndices
public final PutIndicesSettingsRequest.Builder allowNoIndices(@Nullable java.lang.Boolean value)
Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes_allstring or when no indices have been specified)API name:
allow_no_indices
-
expandWildcards
public final PutIndicesSettingsRequest.Builder expandWildcards(java.util.List<ExpandWildcard> list)
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcardsAdds all elements of
listtoexpandWildcards.
-
expandWildcards
public final PutIndicesSettingsRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)
Whether to expand wildcard expression to concrete indices that are open, closed or both.API name:
expand_wildcardsAdds one or more values to
expandWildcards.
-
flatSettings
public final PutIndicesSettingsRequest.Builder flatSettings(@Nullable java.lang.Boolean value)
Return settings in flat format (default: false)API name:
flat_settings
-
ignoreUnavailable
public final PutIndicesSettingsRequest.Builder ignoreUnavailable(@Nullable java.lang.Boolean value)
Whether specified concrete indices should be ignored when unavailable (missing or closed)API name:
ignore_unavailable
-
index
public final PutIndicesSettingsRequest.Builder index(java.util.List<java.lang.String> list)
A comma-separated list of index names; use_allor empty string to perform the operation on all indicesAPI name:
indexAdds all elements of
listtoindex.
-
index
public final PutIndicesSettingsRequest.Builder index(java.lang.String value, java.lang.String... values)
A comma-separated list of index names; use_allor empty string to perform the operation on all indicesAPI name:
indexAdds one or more values to
index.
-
masterTimeout
@Deprecated public final PutIndicesSettingsRequest.Builder masterTimeout(@Nullable Time value)
Deprecated.Specify timeout for connection to masterAPI name:
master_timeout
-
masterTimeout
@Deprecated public final PutIndicesSettingsRequest.Builder masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Deprecated.Specify timeout for connection to masterAPI name:
master_timeout
-
clusterManagerTimeout
public final PutIndicesSettingsRequest.Builder clusterManagerTimeout(@Nullable Time value)
Specify timeout for connection to cluster-managerAPI name:
cluster_manager_timeout
-
clusterManagerTimeout
public final PutIndicesSettingsRequest.Builder clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Specify timeout for connection to cluster-managerAPI name:
cluster_manager_timeout
-
preserveExisting
public final PutIndicesSettingsRequest.Builder preserveExisting(@Nullable java.lang.Boolean value)
Whether to update existing settings. If set totrueexisting settings on an index remain unchanged, the default isfalseAPI name:
preserve_existing
-
timeout
public final PutIndicesSettingsRequest.Builder timeout(@Nullable Time value)
Explicit operation timeoutAPI name:
timeout
-
timeout
public final PutIndicesSettingsRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
Explicit operation timeoutAPI name:
timeout
-
settings
public final PutIndicesSettingsRequest.Builder settings(IndexSettings value)
Required - Request body.API name:
_value_body
-
settings
public final PutIndicesSettingsRequest.Builder settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)
Required - Request body.API name:
_value_body
-
build
public PutIndicesSettingsRequest build()
Builds aPutIndicesSettingsRequest.- Specified by:
buildin interfaceObjectBuilder<PutIndicesSettingsRequest>- Throws:
java.lang.NullPointerException- if some of the required fields are null.
-
-