Package co.elastic.clients.elasticsearch.indices

Class PutDataStreamSettingsRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.PutDataStreamSettingsRequest.Builder

All Implemented Interfaces:

WithJson<PutDataStreamSettingsRequest.Builder>, ObjectBuilder<PutDataStreamSettingsRequest>

Enclosing class:

PutDataStreamSettingsRequest

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

Builder for PutDataStreamSettingsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutDataStreamSettingsRequest	build()	Builds a PutDataStreamSettingsRequest.
final PutDataStreamSettingsRequest.Builder	dryRun(Boolean value)	If true, the request does not actually change the settings on any data streams or indices.
final PutDataStreamSettingsRequest.Builder	masterTimeout(Time value)	The period to wait for a connection to the master node.
final PutDataStreamSettingsRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a connection to the master node.
final PutDataStreamSettingsRequest.Builder	name(String value, String... values)	Required - A comma-separated list of data streams or data stream patterns.
final PutDataStreamSettingsRequest.Builder	name(List<String> list)	Required - A comma-separated list of data streams or data stream patterns.
protected PutDataStreamSettingsRequest.Builder	self()
final PutDataStreamSettingsRequest.Builder	settings(IndexSettings value)	Required - Request body.
final PutDataStreamSettingsRequest.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - Request body.
final PutDataStreamSettingsRequest.Builder	timeout(Time value)	The period to wait for a response.
final PutDataStreamSettingsRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The period to wait for a response.
PutDataStreamSettingsRequest.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

dryRun

public final PutDataStreamSettingsRequest.Builder dryRun(@Nullable
 Boolean value)

If true, the request does not actually change the settings on any data streams or indices. Instead, it simulates changing the settings and reports back to the user what would have happened had these settings actually been applied.

API name: dry_run

masterTimeout

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

The 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 PutDataStreamSettingsRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The 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

name

public final PutDataStreamSettingsRequest.Builder name(List<String> list)

Required - A comma-separated list of data streams or data stream patterns.

API name: name

Adds all elements of list to name.

name

public final PutDataStreamSettingsRequest.Builder name(String value,
 String... values)

Required - A comma-separated list of data streams or data stream patterns.

API name: name

Adds one or more values to name.

timeout

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

The 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 PutDataStreamSettingsRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The 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 PutDataStreamSettingsRequest.Builder settings(IndexSettings value)

Required - Request body.

settings

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

Required - Request body.

withJson

public PutDataStreamSettingsRequest.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<PutDataStreamSettingsRequest.Builder>

Overrides:

withJson in class WithJsonObjectBuilderBase<PutDataStreamSettingsRequest.Builder>

Parameters:

parser - the JSONP parser

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

Returns:

this object

self

protected PutDataStreamSettingsRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutDataStreamSettingsRequest.Builder>

build

public PutDataStreamSettingsRequest build()

Builds a PutDataStreamSettingsRequest.

Specified by:

build in interface ObjectBuilder<PutDataStreamSettingsRequest>

Throws:

NullPointerException - if some of the required fields are null.