Package co.elastic.clients.elasticsearch.indices

Class PutIndicesSettingsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutIndicesSettingsRequest.Builder>

co.elastic.clients.elasticsearch.indices.PutIndicesSettingsRequest.Builder

All Implemented Interfaces:

WithJson<PutIndicesSettingsRequest.Builder>, ObjectBuilder<PutIndicesSettingsRequest>

Enclosing class:

PutIndicesSettingsRequest

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

Builder for PutIndicesSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final PutIndicesSettingsRequest.Builder	allowNoIndices(Boolean value)	A setting that does two separate checks on the index expression.
PutIndicesSettingsRequest	build()	Builds a PutIndicesSettingsRequest.
final PutIndicesSettingsRequest.Builder	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Type of index that wildcard patterns can match.
final PutIndicesSettingsRequest.Builder	expandWildcards(List<ExpandWildcard> list)	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)	If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable.
final PutIndicesSettingsRequest.Builder	index(String value, String... values)	Comma-separated list of data streams, indices, and aliases used to limit the request.
final PutIndicesSettingsRequest.Builder	index(List<String> list)	Comma-separated list of data streams, indices, and aliases used to limit the request.
final PutIndicesSettingsRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final PutIndicesSettingsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final PutIndicesSettingsRequest.Builder	preserveExisting(Boolean value)	If true, existing index settings remain unchanged.
final PutIndicesSettingsRequest.Builder	reopen(Boolean value)	Whether to close and reopen the index to apply non-dynamic settings.
protected PutIndicesSettingsRequest.Builder	self()
final PutIndicesSettingsRequest.Builder	settings(IndexSettings value)	Required - Request body.
final PutIndicesSettingsRequest.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - Request body.
final PutIndicesSettingsRequest.Builder	timeout(Time value)	Period to wait for a response.
final PutIndicesSettingsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a response.
PutIndicesSettingsRequest.Builder	withJson(jakarta.json.stream.JsonParser parser, JsonpMapper mapper)	Sets additional properties values on this object by reading from a JSON input.

Methods 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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

allowNoIndices

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

A setting that does two separate checks on the index expression. If false, the request returns an error (1) if any wildcard expression (including _all and *) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. If true, index expressions that resolve to no indices are allowed and the request returns an empty result.

API name: allow_no_indices

expandWildcards

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

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

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

If true, returns settings in flat format.

API name: flat_settings

ignoreUnavailable

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

If false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. If true, unavailable concrete targets are silently ignored.

API name: ignore_unavailable

index

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

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

API name: index

Adds all elements of list to index.

index

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

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

API name: index

Adds one or more values to index.

masterTimeout

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

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

API name: master_timeout

masterTimeout

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

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

API name: master_timeout

preserveExisting

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

If true, existing index settings remain unchanged.

API name: preserve_existing

reopen

public final PutIndicesSettingsRequest.Builder reopen(@Nullable
 Boolean value)

Whether to close and reopen the index to apply non-dynamic settings. If set to true the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes.

API name: reopen

timeout

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

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

settings

public final PutIndicesSettingsRequest.Builder settings(IndexSettings value)

Required - Request body.

settings

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

Required - Request body.

withJson

public PutIndicesSettingsRequest.Builder withJson(jakarta.json.stream.JsonParser parser,
 JsonpMapper mapper)

Description copied from interface: WithJson

Sets additional properties values on this object by reading from a JSON input.

This is a "partial deserialization": properties that were already set keep their value if they're not present in the JSON input, and properties can also be set after having called this method, including overriding those read from the JSON input.

This low level variant of withJson gives full control on the json parser and object mapper. Most of the time using WithJson.withJson(Reader) and WithJson.withJson(InputStream) will be more convenient.

Specified by:

withJson in interface WithJson<PutIndicesSettingsRequest.Builder>

Overrides:

withJson in class WithJsonObjectBuilderBase<PutIndicesSettingsRequest.Builder>

Parameters:

parser - the JSONP parser

mapper - the JSONP mapper used to deserialize values and nested objects

Returns:

this object

self

protected PutIndicesSettingsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutIndicesSettingsRequest.Builder>

build

public PutIndicesSettingsRequest build()

Builds a PutIndicesSettingsRequest.

Specified by:

build in interface ObjectBuilder<PutIndicesSettingsRequest>

Throws:

NullPointerException - if some of the required fields are null.