Package org.opensearch.client.opensearch.indices

Class SimulateTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

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

All Implemented Interfaces:

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

Enclosing class:

SimulateTemplateRequest

public static class SimulateTemplateRequest.Builder
extends RequestBase.AbstractBuilder<SimulateTemplateRequest.Builder>
implements CopyableBuilder<SimulateTemplateRequest.Builder,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	cause(String value)	User defined reason for dry-run creating the new template for simulation purposes.
final SimulateTemplateRequest.Builder	clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Operation timeout for connection to cluster-manager node.
final SimulateTemplateRequest.Builder	clusterManagerTimeout(Time value)	Operation timeout for connection to cluster-manager node.
SimulateTemplateRequest.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
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(Function<Time.Builder,ObjectBuilder<Time>> fn)	Deprecated.
final SimulateTemplateRequest.Builder	masterTimeout(Time value)	Deprecated.
final SimulateTemplateRequest.Builder	name(String value)	Name of the index template to simulate.
protected SimulateTemplateRequest.Builder	self()
final SimulateTemplateRequest.Builder	template(Function<IndexTemplate.Builder,ObjectBuilder<IndexTemplate>> fn)	Required - Request body.
final SimulateTemplateRequest.Builder	template(IndexTemplate value)	Required - Request body.

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

Returns:

a new builder instance.

self

@Nonnull
protected SimulateTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<SimulateTemplateRequest.Builder>

cause

@Nonnull
public final SimulateTemplateRequest.Builder cause(@Nullable
 String value)

User defined reason for dry-run creating the new template for simulation purposes.

API name: cause

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

clusterManagerTimeout

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

Operation timeout for connection to cluster-manager node.

API name: cluster_manager_timeout

create

@Nonnull
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

@Deprecated
@Nonnull
public final SimulateTemplateRequest.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 SimulateTemplateRequest.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

name

@Nonnull
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

@Nonnull
public final SimulateTemplateRequest.Builder template(IndexTemplate value)

Required - Request body.

template

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

Required - Request body.

build

@Nonnull
public SimulateTemplateRequest build()

Builds a SimulateTemplateRequest.

Specified by:

build in interface ObjectBuilder<SimulateTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.