Package org.opensearch.client.opensearch.indices

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 for PutIndicesSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutIndicesSettingsRequest.Builder	allowNoIndices(java.lang.Boolean value)	Whether to ignore if a wildcard indices expression resolves into no concrete indices.
PutIndicesSettingsRequest	build()	Builds a PutIndicesSettingsRequest.
PutIndicesSettingsRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to cluster-manager
PutIndicesSettingsRequest.Builder	clusterManagerTimeout(Time value)	Specify timeout for connection to cluster-manager
PutIndicesSettingsRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
PutIndicesSettingsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
PutIndicesSettingsRequest.Builder	flatSettings(java.lang.Boolean value)	Return settings in flat format (default: false)
PutIndicesSettingsRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	Whether specified concrete indices should be ignored when unavailable (missing or closed)
PutIndicesSettingsRequest.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 indices
PutIndicesSettingsRequest.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 indices
PutIndicesSettingsRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
PutIndicesSettingsRequest.Builder	masterTimeout(Time value)	Deprecated.
PutIndicesSettingsRequest.Builder	preserveExisting(java.lang.Boolean value)	Whether to update existing settings.
PutIndicesSettingsRequest.Builder	settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - Request body.
PutIndicesSettingsRequest.Builder	settings(IndexSettings value)	Required - Request body.
PutIndicesSettingsRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
PutIndicesSettingsRequest.Builder	timeout(Time value)	Explicit operation timeout

Methods inherited from class org.opensearch.client.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 Detail

Builder

public Builder()

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 _all string 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_wildcards

Adds all elements of list to expandWildcards.

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_wildcards

Adds 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 _all or empty string to perform the operation on all indices

API name: index

Adds all elements of list to index.

index

public final PutIndicesSettingsRequest.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 indices

API name: index

Adds one or more values to index.

masterTimeout

@Deprecated
public final PutIndicesSettingsRequest.Builder masterTimeout(@Nullable
                                                             Time value)

Deprecated.

Specify timeout for connection to master

API 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 master

API name: master_timeout

clusterManagerTimeout

public final PutIndicesSettingsRequest.Builder clusterManagerTimeout(@Nullable
                                                                     Time value)

Specify timeout for connection to cluster-manager

API 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-manager

API name: cluster_manager_timeout

preserveExisting

public final PutIndicesSettingsRequest.Builder preserveExisting(@Nullable
                                                                java.lang.Boolean value)

Whether to update existing settings. If set to true existing settings on an index remain unchanged, the default is false

API name: preserve_existing

timeout

public final PutIndicesSettingsRequest.Builder timeout(@Nullable
                                                       Time value)

Explicit operation timeout

API name: timeout

timeout

public final PutIndicesSettingsRequest.Builder timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)

Explicit operation timeout

API 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 a PutIndicesSettingsRequest.

Specified by:

build in interface ObjectBuilder<PutIndicesSettingsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.