Package org.opensearch.client.opensearch.indices

Class PutIndicesSettingsRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<PutIndicesSettingsRequest.Builder>

org.opensearch.client.opensearch.indices.PutIndicesSettingsRequest.Builder

All Implemented Interfaces:

CopyableBuilder<PutIndicesSettingsRequest.Builder,PutIndicesSettingsRequest>, MutableBuilder<PutIndicesSettingsRequest.Builder,PutIndicesSettingsRequest>, ObjectBuilder<PutIndicesSettingsRequest>

Enclosing class:

PutIndicesSettingsRequest

public static class PutIndicesSettingsRequest.Builder
extends RequestBase.AbstractBuilder<PutIndicesSettingsRequest.Builder>
implements CopyableBuilder<PutIndicesSettingsRequest.Builder,PutIndicesSettingsRequest>

Builder for PutIndicesSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutIndicesSettingsRequest.Builder	allowNoIndices(Boolean value)	If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes.
PutIndicesSettingsRequest	build()	Builds a PutIndicesSettingsRequest.
final PutIndicesSettingsRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final PutIndicesSettingsRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
PutIndicesSettingsRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final PutIndicesSettingsRequest.Builder	expandWildcards(List<ExpandWildcard> list)	Type of index that wildcard patterns can match.
final PutIndicesSettingsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final PutIndicesSettingsRequest.Builder	flatSettings(Boolean value)	If true, returns settings in flat format.
final PutIndicesSettingsRequest.Builder	ignoreUnavailable(Boolean value)	Whether specified concrete indexes should be ignored when unavailable (missing or closed).
final PutIndicesSettingsRequest.Builder	index(String value, String... values)	Comma-separated list of data streams, indexes, and aliases used to limit the request.
final PutIndicesSettingsRequest.Builder	index(List<String> list)	Comma-separated list of data streams, indexes, and aliases used to limit the request.
final PutIndicesSettingsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final PutIndicesSettingsRequest.Builder	masterTimeout(Time value)	Deprecated.
final PutIndicesSettingsRequest.Builder	preserveExisting(Boolean value)	If true, existing index settings remain unchanged.
protected PutIndicesSettingsRequest.Builder	self()
final PutIndicesSettingsRequest.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - Request body.
final PutIndicesSettingsRequest.Builder	settings(IndexSettings value)	Required - Request body.
final PutIndicesSettingsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
final PutIndicesSettingsRequest.Builder	timeout(Time value)	Period to wait for a response.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public PutIndicesSettingsRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<PutIndicesSettingsRequest.Builder,PutIndicesSettingsRequest>

Returns:

a new builder instance.

self

@Nonnull
protected PutIndicesSettingsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutIndicesSettingsRequest.Builder>

allowNoIndices

@Nonnull
public final PutIndicesSettingsRequest.Builder allowNoIndices(@Nullable
 Boolean value)

If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.

API name: allow_no_indices

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final PutIndicesSettingsRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

expandWildcards

@Nonnull
public final PutIndicesSettingsRequest.Builder expandWildcards(List<ExpandWildcard> list)

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds all elements of list to expandWildcards.

expandWildcards

@Nonnull
public final PutIndicesSettingsRequest.Builder expandWildcards(ExpandWildcard value,
 ExpandWildcard... values)

Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as open,hidden.

API name: expand_wildcards

Adds one or more values to expandWildcards.

flatSettings

@Nonnull
public final PutIndicesSettingsRequest.Builder flatSettings(@Nullable
 Boolean value)

If true, returns settings in flat format.

API name: flat_settings

ignoreUnavailable

@Nonnull
public final PutIndicesSettingsRequest.Builder ignoreUnavailable(@Nullable
 Boolean value)

Whether specified concrete indexes should be ignored when unavailable (missing or closed).

API name: ignore_unavailable

index

@Nonnull
public final PutIndicesSettingsRequest.Builder index(List<String> list)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds all elements of list to index.

index

@Nonnull
public final PutIndicesSettingsRequest.Builder index(String value,
 String... values)

Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.

API name: index

Adds one or more values to index.

masterTimeout

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

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final PutIndicesSettingsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: master_timeout

preserveExisting

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

If true, existing index settings remain unchanged.

API name: preserve_existing

settings

@Nonnull
public final PutIndicesSettingsRequest.Builder settings(IndexSettings value)

Required - Request body.

settings

@Nonnull
public final PutIndicesSettingsRequest.Builder settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

Required - Request body.

timeout

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

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

timeout

@Nonnull
public final PutIndicesSettingsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

API name: timeout

build

@Nonnull
public PutIndicesSettingsRequest build()

Builds a PutIndicesSettingsRequest.

Specified by:

build in interface ObjectBuilder<PutIndicesSettingsRequest>

Throws:

NullPointerException - if some of the required fields are null.