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:

ToJsonp

public final class SimulateTemplateRequest
extends RequestBase
implements ToJsonp

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<SimulateTemplateRequest>	DESERIALIZER	Json deserializer for SimulateTemplateRequest
static Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,OpenSearchError>	ENDPOINT	Endpoint "indices.simulate_template".

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SimulateTemplateRequest(SimulateTemplateRequest.Builder builder)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	create()	If true, the template passed in the body is only used if no existing templates match the same index patterns.
jakarta.json.JsonValue	masterTimeout()	Period to wait for a connection to the master node.
java.lang.String	name()	Name of the index template to simulate.
protected static void	setupSimulateTemplateRequestDeserializer(DelegatingDeserializer<SimulateTemplateRequest.Builder> op)
void	toJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
IndexTemplate	value()	Request body.

Methods inherited from class java.lang.Object

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

Field Details

DESERIALIZER

public static final JsonpDeserializer<SimulateTemplateRequest> DESERIALIZER

Json deserializer for SimulateTemplateRequest

ENDPOINT

public static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,OpenSearchError> ENDPOINT

Endpoint "indices.simulate_template".

Constructor Details

SimulateTemplateRequest

protected SimulateTemplateRequest(SimulateTemplateRequest.Builder builder)

Method Details

name

@Nullable public 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

create

@Nullable public 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

@Nullable public jakarta.json.JsonValue masterTimeout()

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

value

public IndexTemplate value()

Request body. API name: value

toJsonp

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

Serialize this value to JSON.

Specified by:

toJsonp in interface ToJsonp

setupSimulateTemplateRequestDeserializer

protected static void setupSimulateTemplateRequestDeserializer(DelegatingDeserializer<SimulateTemplateRequest.Builder> op)