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 classSimulateTemplateRequest.BuilderBuilder forSimulateTemplateRequest. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<SimulateTemplateRequest>DESERIALIZERJson deserializer for SimulateTemplateRequeststatic Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,OpenSearchError>ENDPOINTEndpoint "indices.simulate_template". -
Constructor Summary
Constructors Modifier Constructor Description protectedSimulateTemplateRequest(SimulateTemplateRequest.Builder builder) -
Method Summary
Modifier and Type Method Description java.lang.Booleancreate()If true, the template passed in the body is only used if no existing templates match the same index patterns.jakarta.json.JsonValuemasterTimeout()Period to wait for a connection to the master node.java.lang.Stringname()Name of the index template to simulate.protected static voidsetupSimulateTemplateRequestDeserializer(DelegatingDeserializer<SimulateTemplateRequest.Builder> op)voidtoJsonp(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this value to JSON.IndexTemplatevalue()Request body.
-
Field Details
-
DESERIALIZER
Json deserializer for SimulateTemplateRequest -
ENDPOINT
public static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,OpenSearchError> ENDPOINTEndpoint "indices.simulate_template".
-
-
Constructor Details
-
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
Request body. API name:value -
toJsonp
Serialize this value to JSON. -
setupSimulateTemplateRequestDeserializer
protected static void setupSimulateTemplateRequestDeserializer(DelegatingDeserializer<SimulateTemplateRequest.Builder> op)
-