Package org.opensearch.client.opensearch.indices

Class SimulateIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.SimulateIndexTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<SimulateIndexTemplateRequest>

Enclosing class:

SimulateIndexTemplateRequest

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

Builder for SimulateIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SimulateIndexTemplateRequest.Builder	allowAutoCreate(java.lang.Boolean value)	API name: allow_auto_create
SimulateIndexTemplateRequest	build()	Builds a SimulateIndexTemplateRequest.
SimulateIndexTemplateRequest.Builder	clusterManagerTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the cluster-manager node.
SimulateIndexTemplateRequest.Builder	clusterManagerTimeout(Time value)	Period to wait for a connection to the cluster-manager node.
SimulateIndexTemplateRequest.Builder	composedOf(java.lang.String value, java.lang.String... values)	API name: composed_of
SimulateIndexTemplateRequest.Builder	composedOf(java.util.List<java.lang.String> list)	API name: composed_of
SimulateIndexTemplateRequest.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.
SimulateIndexTemplateRequest.Builder	dataStream(java.util.function.Function<DataStream.Builder,ObjectBuilder<DataStream>> fn)	API name: data_stream
SimulateIndexTemplateRequest.Builder	dataStream(DataStream value)	API name: data_stream
SimulateIndexTemplateRequest.Builder	indexPatterns(java.lang.String value, java.lang.String... values)	API name: index_patterns
SimulateIndexTemplateRequest.Builder	indexPatterns(java.util.List<java.lang.String> list)	API name: index_patterns
SimulateIndexTemplateRequest.Builder	masterTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
SimulateIndexTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
SimulateIndexTemplateRequest.Builder	meta(java.lang.String key, JsonData value)	API name: _meta
SimulateIndexTemplateRequest.Builder	meta(java.util.Map<java.lang.String,JsonData> map)	API name: _meta
SimulateIndexTemplateRequest.Builder	name(java.lang.String value)	Required - Index or template name to simulate
SimulateIndexTemplateRequest.Builder	priority(java.lang.Integer value)	API name: priority
SimulateIndexTemplateRequest.Builder	template(java.util.function.Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)	API name: template
SimulateIndexTemplateRequest.Builder	template(IndexTemplateMapping value)	API name: template
SimulateIndexTemplateRequest.Builder	version(java.lang.Long value)	API name: version

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

meta

public final SimulateIndexTemplateRequest.Builder meta(java.util.Map<java.lang.String,JsonData> map)

API name: _meta

Adds all entries of map to meta.

meta

public final SimulateIndexTemplateRequest.Builder meta(java.lang.String key,
                                                       JsonData value)

API name: _meta

Adds an entry to meta.

allowAutoCreate

public final SimulateIndexTemplateRequest.Builder allowAutoCreate(@Nullable
                                                                  java.lang.Boolean value)

API name: allow_auto_create

composedOf

public final SimulateIndexTemplateRequest.Builder composedOf(java.util.List<java.lang.String> list)

API name: composed_of

Adds all elements of list to composedOf.

composedOf

public final SimulateIndexTemplateRequest.Builder composedOf(java.lang.String value,
                                                             java.lang.String... values)

API name: composed_of

Adds one or more values to composedOf.

create

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

dataStream

public final SimulateIndexTemplateRequest.Builder dataStream(@Nullable
                                                             DataStream value)

API name: data_stream

dataStream

public final SimulateIndexTemplateRequest.Builder dataStream(java.util.function.Function<DataStream.Builder,ObjectBuilder<DataStream>> fn)

API name: data_stream

indexPatterns

public final SimulateIndexTemplateRequest.Builder indexPatterns(java.util.List<java.lang.String> list)

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

public final SimulateIndexTemplateRequest.Builder indexPatterns(java.lang.String value,
                                                                java.lang.String... values)

API name: index_patterns

Adds one or more values to indexPatterns.

masterTimeout

@Deprecated
public final SimulateIndexTemplateRequest.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 SimulateIndexTemplateRequest.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 SimulateIndexTemplateRequest.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 SimulateIndexTemplateRequest.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 SimulateIndexTemplateRequest.Builder name(java.lang.String value)

Required - Index or template name to simulate

API name: name

priority

public final SimulateIndexTemplateRequest.Builder priority(@Nullable
                                                           java.lang.Integer value)

API name: priority

template

public final SimulateIndexTemplateRequest.Builder template(@Nullable
                                                           IndexTemplateMapping value)

API name: template

template

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

API name: template

version

public final SimulateIndexTemplateRequest.Builder version(@Nullable
                                                          java.lang.Long value)

API name: version

build

public SimulateIndexTemplateRequest build()

Builds a SimulateIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<SimulateIndexTemplateRequest>

Throws:

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