Package co.elastic.clients.elasticsearch.indices

Class SimulateTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.indices.SimulateTemplateRequest.Builder

All Implemented Interfaces:

WithJson<SimulateTemplateRequest.Builder>, ObjectBuilder<SimulateTemplateRequest>

Enclosing class:

SimulateTemplateRequest

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

Builder for SimulateTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimulateTemplateRequest	build()	Builds a SimulateTemplateRequest.
final SimulateTemplateRequest.Builder	create(Boolean value)	If true, the template passed in the body is only used if no existing templates match the same index patterns.
final SimulateTemplateRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final SimulateTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final SimulateTemplateRequest.Builder	name(String value)	Name of the index template to simulate.
protected SimulateTemplateRequest.Builder	self()
final SimulateTemplateRequest.Builder	template(IndexTemplate value)	Required - Request body.
final SimulateTemplateRequest.Builder	template(Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)	Required - Request body.
SimulateTemplateRequest.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

create

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

If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation.

API name: create

masterTimeout

public final SimulateTemplateRequest.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 SimulateTemplateRequest.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 SimulateTemplateRequest.Builder name(@Nullable
 String value)

Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template configuration in the request body.

API name: name

template

public final SimulateTemplateRequest.Builder template(IndexTemplate value)

Required - Request body.

template

public final SimulateTemplateRequest.Builder template(Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)

Required - Request body.

withJson

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

Overrides:

withJson in class WithJsonObjectBuilderBase<SimulateTemplateRequest.Builder>

Parameters:

parser - the JSONP parser

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

Returns:

this object

self

protected SimulateTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SimulateTemplateRequest.Builder>

build

public SimulateTemplateRequest build()

Builds a SimulateTemplateRequest.

Specified by:

build in interface ObjectBuilder<SimulateTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.