Package co.elastic.clients.elasticsearch.indices

Class SimulateIndexTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.SimulateIndexTemplateRequest.Builder

All Implemented Interfaces:

WithJson<SimulateIndexTemplateRequest.Builder>, ObjectBuilder<SimulateIndexTemplateRequest>

Enclosing class:

SimulateIndexTemplateRequest

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

Builder for SimulateIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimulateIndexTemplateRequest	build()	Builds a SimulateIndexTemplateRequest.
final SimulateIndexTemplateRequest.Builder	cause(String value)	User defined reason for dry-run creating the new template for simulation purposes
final SimulateIndexTemplateRequest.Builder	create(Boolean value)	Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one
final SimulateIndexTemplateRequest.Builder	includeDefaults(Boolean value)	If true, returns all relevant default configurations for the index template.
final SimulateIndexTemplateRequest.Builder	indexTemplate(IndexTemplate value)	Required - Request body.
final SimulateIndexTemplateRequest.Builder	indexTemplate(Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)	Required - Request body.
final SimulateIndexTemplateRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final SimulateIndexTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final SimulateIndexTemplateRequest.Builder	name(String value)	Required - Name of the index to simulate
protected SimulateIndexTemplateRequest.Builder	self()
SimulateIndexTemplateRequest.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

cause

public final SimulateIndexTemplateRequest.Builder cause(@Nullable
 String value)

User defined reason for dry-run creating the new template for simulation purposes

API name: cause

create

public final SimulateIndexTemplateRequest.Builder create(@Nullable
 Boolean value)

Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one

API name: create

includeDefaults

public final SimulateIndexTemplateRequest.Builder includeDefaults(@Nullable
 Boolean value)

If true, returns all relevant default configurations for the index template.

API name: include_defaults

masterTimeout

public final SimulateIndexTemplateRequest.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 SimulateIndexTemplateRequest.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

name

public final SimulateIndexTemplateRequest.Builder name(String value)

Required - Name of the index to simulate

API name: name

indexTemplate

public final SimulateIndexTemplateRequest.Builder indexTemplate(IndexTemplate value)

Required - Request body.

indexTemplate

public final SimulateIndexTemplateRequest.Builder indexTemplate(Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)

Required - Request body.

withJson

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

Overrides:

withJson in class WithJsonObjectBuilderBase<SimulateIndexTemplateRequest.Builder>

Parameters:

parser - the JSONP parser

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

Returns:

this object

self

protected SimulateIndexTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>

build

public SimulateIndexTemplateRequest build()

Builds a SimulateIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<SimulateIndexTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.