Package org.opensearch.client.opensearch.indices

Class SimulateTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

ObjectBuilder<SimulateTemplateRequest>

Enclosing class:

SimulateTemplateRequest

public static class SimulateTemplateRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<SimulateTemplateRequest>

Builder for SimulateTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimulateTemplateRequest	build()	Builds a SimulateTemplateRequest.
SimulateTemplateRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the cluster-manager node.
SimulateTemplateRequest.Builder	clusterManagerTimeout(Time value)	Period to wait for a connection to the cluster-manager node.
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(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
SimulateTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
SimulateTemplateRequest.Builder	name(java.lang.String value)	Name of the index template to simulate.
SimulateTemplateRequest.Builder	template(java.util.function.Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)	Required - Request body.
SimulateTemplateRequest.Builder	template(IndexTemplate value)	Required - Request body.

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

create

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

@Deprecated
public final SimulateTemplateRequest.Builder masterTimeout(@Nullable
                                                           Time value)

Deprecated.

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

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

Deprecated.

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

clusterManagerTimeout

public final SimulateTemplateRequest.Builder clusterManagerTimeout(@Nullable
                                                                   Time value)

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

API name: cluster_manager_timeout

name

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

template

public final SimulateTemplateRequest.Builder template(IndexTemplate value)

Required - Request body.

API name: _value_body

template

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

Required - Request body.

API name: _value_body

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.