Package org.opensearch.client.opensearch.indices

Class SimulateTemplateRequest.Builder

java.lang.Object

org.opensearch.client.opensearch.indices.SimulateTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SimulateTemplateRequest>

Enclosing class:

SimulateTemplateRequest

public static class SimulateTemplateRequest.Builder
extends java.lang.Object
implements ObjectBuilder<SimulateTemplateRequest>

Builder for SimulateTemplateRequest.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimulateTemplateRequest	build()	Builds a SimulateTemplateRequest.
SimulateTemplateRequest.Builder	create(java.lang.Boolean value)	If true, the template passed in the body is only used if no existing templates match the same index patterns.
SimulateTemplateRequest.Builder	masterTimeout(jakarta.json.JsonValue value)	Period to wait for a connection to the master node.
SimulateTemplateRequest.Builder	name(java.lang.String value)	Name of the index template to simulate.
SimulateTemplateRequest.Builder	value(java.util.function.Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)	Request body.
SimulateTemplateRequest.Builder	value(IndexTemplate value)	Request body.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

name

public SimulateTemplateRequest.Builder name(@Nullable java.lang.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

create

public SimulateTemplateRequest.Builder create(@Nullable java.lang.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 SimulateTemplateRequest.Builder masterTimeout(@Nullable jakarta.json.JsonValue 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

value

public SimulateTemplateRequest.Builder value(IndexTemplate value)

Request body. API name: value

value

public SimulateTemplateRequest.Builder value(java.util.function.Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)

Request body. API name: value

build

public SimulateTemplateRequest build()

Builds a SimulateTemplateRequest.

Specified by:

build in interface ObjectBuilder<SimulateTemplateRequest>

Throws:

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