Class SimulateIndexTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.SimulateIndexTemplateRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class SimulateIndexTemplateRequest
extends RequestBase
implements JsonpSerializable
Simulate matching the given index name against the index templates in the
system
- 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<SimulateIndexTemplateRequest>
Json deserializer forSimulateIndexTemplateRequest
Endpoint "indices.simulate_index_template
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
API name:allow_auto_create
API name:composed_of
final Boolean
create()
Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns.final DataStream
API name:data_stream
API name:index_patterns
final Time
Period to wait for a connection to the master node.meta()
API name:_meta
final String
name()
Required - Index or template name to simulatestatic SimulateIndexTemplateRequest
final Integer
priority()
API name:priority
void
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
setupSimulateIndexTemplateRequestDeserializer
(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op) final IndexTemplateMapping
template()
API name:template
final Long
version()
API name:version
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forSimulateIndexTemplateRequest
-
_ENDPOINT
public static final Endpoint<SimulateIndexTemplateRequest,SimulateIndexTemplateResponse, _ENDPOINTErrorResponse> Endpoint "indices.simulate_index_template
".
-
-
Method Details
-
of
-
meta
API name:_meta
-
allowAutoCreate
API name:allow_auto_create
-
composedOf
API name:composed_of
-
create
Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns. Iffalse
, 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
-
dataStream
API name:data_stream
-
indexPatterns
API name:index_patterns
-
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
Required - Index or template name to simulateAPI name:
name
-
priority
API name:priority
-
template
API name:template
-
version
API name:version
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSimulateIndexTemplateRequestDeserializer
protected static void setupSimulateIndexTemplateRequestDeserializer(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op)
-