Class SimulateTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.SimulateTemplateRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class SimulateTemplateRequest
extends RequestBase
implements JsonpSerializable
Simulate resolving the given template name or body
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<SimulateTemplateRequest>
static final Endpoint<SimulateTemplateRequest,
SimulateTemplateResponse, ErrorResponse> Endpoint "indices.simulate_template
". -
Method Summary
Modifier and TypeMethodDescriptionfinal 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>
final Time
Period to wait for a connection to the master node.final String
name()
Name of the index template to simulate.static SimulateTemplateRequest
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this value to JSON.final IndexTemplate
template()
Required - Request body.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
-
_ENDPOINT
public static final Endpoint<SimulateTemplateRequest,SimulateTemplateResponse, _ENDPOINTErrorResponse> Endpoint "indices.simulate_template
".
-
-
Method Details
-
of
public static SimulateTemplateRequest of(Function<SimulateTemplateRequest.Builder, ObjectBuilder<SimulateTemplateRequest>> fn) -
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
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
-
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
Required - Request body. -
serialize
Serialize this value to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
createSimulateTemplateRequestDeserializer
protected static JsonpDeserializer<SimulateTemplateRequest> createSimulateTemplateRequestDeserializer()
-