Class SimulateTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.SimulateTemplateRequest
- All Implemented Interfaces:
ElasticsearchCommonRequest
,JsonpSerializable
@JsonpDeserializable public final class SimulateTemplateRequest extends RequestBase implements JsonpSerializable
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SimulateTemplateRequest.Builder
Builder forSimulateTemplateRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._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,ElasticsearchError>
ENDPOINT
Endpoint "indices.simulate_template
". -
Constructor Summary
Constructors Constructor Description SimulateTemplateRequest(SimulateTemplateRequest.Builder builder)
SimulateTemplateRequest(java.util.function.Function<SimulateTemplateRequest.Builder,SimulateTemplateRequest.Builder> fn)
-
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.protected static JsonpDeserializer<SimulateTemplateRequest>
createSimulateTemplateRequestDeserializer()
java.lang.String
masterTimeout()
Period to wait for a connection to the master node.java.lang.String
name()
Name of the index template to simulate.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 Details
-
_DESERIALIZER
-
ENDPOINT
public static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse,ElasticsearchError> ENDPOINTEndpoint "indices.simulate_template
".
-
-
Constructor Details
-
SimulateTemplateRequest
-
SimulateTemplateRequest
public SimulateTemplateRequest(java.util.function.Function<SimulateTemplateRequest.Builder,SimulateTemplateRequest.Builder> fn)
-
-
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 java.lang.String 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
-
template
Required - Request body.API name:
_value_body
-
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createSimulateTemplateRequestDeserializer
protected static JsonpDeserializer<SimulateTemplateRequest> createSimulateTemplateRequestDeserializer()
-