Package org.opensearch.client.opensearch.indices

Class SimulateTemplateRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.indices.SimulateTemplateRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class SimulateTemplateRequest
extends RequestBase
implements JsonpSerializable

Simulate resolving the given template name or body

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SimulateTemplateRequest.Builder	Builder for SimulateTemplateRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<SimulateTemplateRequest>	_DESERIALIZER
static Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.simulate_template".

Method Summary

Modifier and Type	Method	Description
Time	clusterManagerTimeout()	Period to wait for a connection to the cluster-manager node.
java.lang.Boolean	create()	If true, the template passed in the body is only used if no existing templates match the same index patterns.
protected static JsonpDeserializer<SimulateTemplateRequest>	createSimulateTemplateRequestDeserializer()
Time	masterTimeout()	Deprecated.
java.lang.String	name()	Name of the index template to simulate.
static SimulateTemplateRequest	of(java.util.function.Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
IndexTemplate	template()	Required - Request body.

Methods inherited from class java.lang.Object

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

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<SimulateTemplateRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.simulate_template".

Method Detail

of

public static SimulateTemplateRequest of(java.util.function.Function<SimulateTemplateRequest.Builder,ObjectBuilder<SimulateTemplateRequest>> fn)

create

@Nullable
public final java.lang.Boolean create()

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
@Nullable
public final Time masterTimeout()

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

@Nullable
public final Time clusterManagerTimeout()

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

@Nullable
public final java.lang.String name()

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 IndexTemplate template()

Required - Request body.

API name: _value_body

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

createSimulateTemplateRequestDeserializer

protected static JsonpDeserializer<SimulateTemplateRequest> createSimulateTemplateRequestDeserializer()