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
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	expandWildcards(ExpandWildcard value, ExpandWildcard... values)	Whether to expand wildcard expression to concrete indices that are open, closed or both.
PutIndicesSettingsRequest.Builder	expandWildcards(java.util.List<ExpandWildcard> list)	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(Time value)	Specify timeout for connection to master
PutIndicesSettingsRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Specify timeout for connection to master
PutIndicesSettingsRequest.Builder	preserveExisting(java.lang.Boolean value)	Whether to update existing settings.
protected PutIndicesSettingsRequest.Builder	self()
PutIndicesSettingsRequest.Builder	settings(IndexSettings value)	Required - Request body.
PutIndicesSettingsRequest.Builder	settings(java.util.function.Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - Request body.
PutIndicesSettingsRequest.Builder	timeout(Time value)	Explicit operation timeout
PutIndicesSettingsRequest.Builder	timeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Explicit operation timeout
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
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

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

Specify timeout for connection to master

API name: master_timeout

masterTimeout

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

Specify timeout for connection to master

API name: master_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.

settings

public final PutIndicesSettingsRequest.Builder settings(java.util.function.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:

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