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
- 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
This setting overrides the value of theaction.auto_create_index
cluster setting.An ordered list of component template names.final Boolean
create()
Iftrue
, the template passed in the body is only used if no existing templates match the same index patterns.final DataStreamVisibility
If this object is included, the template is used to create data streams and their backing indices.final Boolean
If true, returns all relevant default configurations for the index template.Array of wildcard (*
) expressions used to match the names of data streams and indices during creation.final Time
Period to wait for a connection to the master node.meta()
Optional user metadata about the index template.final String
name()
Required - Index or template name to simulatestatic SimulateIndexTemplateRequest
final Integer
priority()
Priority to determine index template precedence when a new data stream or index is created.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()
Template to be applied.final Long
version()
Version number used to manage index templates externally.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
Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.API name:
_meta
-
allowAutoCreate
This setting overrides the value of theaction.auto_create_index
cluster setting. If set totrue
in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled viaactions.auto_create_index
. If set tofalse
, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.API name:
allow_auto_create
-
composedOf
An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.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
If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with adata_stream
object.API name:
data_stream
-
includeDefaults
If true, returns all relevant default configurations for the index template.API name:
include_defaults
-
indexPatterns
Array of wildcard (*
) expressions used to match the names of data streams and indices during creation.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
Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.API name:
priority
-
template
Template to be applied. It may optionally include analiases
,mappings
, orsettings
configuration.API name:
template
-
version
Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.API name:
version
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupSimulateIndexTemplateRequestDeserializer
protected static void setupSimulateIndexTemplateRequestDeserializer(ObjectDeserializer<SimulateIndexTemplateRequest.Builder> op)
-