Package org.opensearch.client.opensearch.indices

Class SimulateIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>

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

All Implemented Interfaces:

CopyableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest>, MutableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest>, ObjectBuilder<SimulateIndexTemplateRequest>

Enclosing class:

SimulateIndexTemplateRequest

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

Builder for SimulateIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SimulateIndexTemplateRequest.Builder	allowAutoCreate(Boolean value)	This setting overrides the value of the action.auto_create_index cluster setting.
SimulateIndexTemplateRequest	build()	Builds a SimulateIndexTemplateRequest.
final SimulateIndexTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final SimulateIndexTemplateRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
final SimulateIndexTemplateRequest.Builder	composedOf(String value, String... values)	An ordered list of component template names.
final SimulateIndexTemplateRequest.Builder	composedOf(List<String> list)	An ordered list of component template names.
SimulateIndexTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SimulateIndexTemplateRequest.Builder	dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)	API name: data_stream
final SimulateIndexTemplateRequest.Builder	dataStream(IndexTemplateDataStreamConfiguration value)	API name: data_stream
final SimulateIndexTemplateRequest.Builder	indexPatterns(String value, String... values)	API name: index_patterns
final SimulateIndexTemplateRequest.Builder	indexPatterns(List<String> list)	API name: index_patterns
final SimulateIndexTemplateRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final SimulateIndexTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final SimulateIndexTemplateRequest.Builder	meta(String key, JsonData value)	API name: _meta
final SimulateIndexTemplateRequest.Builder	meta(Map<String,JsonData> map)	API name: _meta
final SimulateIndexTemplateRequest.Builder	name(String value)	Required - Index or template name to simulate
final SimulateIndexTemplateRequest.Builder	priority(Integer value)	Priority to determine index template precedence when a new data stream or index is created.
protected SimulateIndexTemplateRequest.Builder	self()
final SimulateIndexTemplateRequest.Builder	template(Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)	API name: template
final SimulateIndexTemplateRequest.Builder	template(IndexTemplateMapping value)	API name: template
final SimulateIndexTemplateRequest.Builder	version(Long value)	API name: version

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder

errorTrace, human

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public SimulateIndexTemplateRequest.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<SimulateIndexTemplateRequest.Builder,SimulateIndexTemplateRequest>

Returns:

a new builder instance.

self

@Nonnull
protected SimulateIndexTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SimulateIndexTemplateRequest.Builder>

allowAutoCreate

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

This setting overrides the value of the action.auto_create_index cluster setting. If set to true in a template, then indexes can be automatically created using that template even if auto-creation of indexes is disabled using actions.auto_create_index. If set to false, then indexes or data streams matching the template must always be explicitly created, and may never be automatically created.

API name: allow_auto_create

clusterManagerTimeout

@Nonnull
public final SimulateIndexTemplateRequest.Builder clusterManagerTimeout(@Nullable
 Time value)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

@Nonnull
public final SimulateIndexTemplateRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

composedOf

@Nonnull
public final SimulateIndexTemplateRequest.Builder composedOf(List<String> list)

An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

Adds all elements of list to composedOf.

composedOf

@Nonnull
public final SimulateIndexTemplateRequest.Builder composedOf(String value,
 String... values)

An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

Adds one or more values to composedOf.

dataStream

@Nonnull
public final SimulateIndexTemplateRequest.Builder dataStream(@Nullable
 IndexTemplateDataStreamConfiguration value)

API name: data_stream

dataStream

@Nonnull
public final SimulateIndexTemplateRequest.Builder dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)

API name: data_stream

indexPatterns

@Nonnull
public final SimulateIndexTemplateRequest.Builder indexPatterns(List<String> list)

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

@Nonnull
public final SimulateIndexTemplateRequest.Builder indexPatterns(String value,
 String... values)

API name: index_patterns

Adds one or more values to indexPatterns.

masterTimeout

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

Deprecated.

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: master_timeout

masterTimeout

@Deprecated
@Nonnull
public final SimulateIndexTemplateRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Deprecated.

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: master_timeout

meta

@Nonnull
public final SimulateIndexTemplateRequest.Builder meta(Map<String,JsonData> map)

API name: _meta

Adds all elements of map to meta.

meta

@Nonnull
public final SimulateIndexTemplateRequest.Builder meta(String key,
 JsonData value)

API name: _meta

Adds an entry to meta.

name

@Nonnull
public final SimulateIndexTemplateRequest.Builder name(String value)

Required - Index or template name to simulate

API name: name

priority

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

Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch.

API name: priority

template

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

API name: template

template

@Nonnull
public final SimulateIndexTemplateRequest.Builder template(Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)

API name: template

version

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

API name: version

build

@Nonnull
public SimulateIndexTemplateRequest build()

Builds a SimulateIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<SimulateIndexTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.