Class IndexTemplate
java.lang.Object
co.elastic.clients.elasticsearch.indices.IndexTemplate
- All Implemented Interfaces:
JsonpSerializable
- See Also:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<IndexTemplate>
Json deserializer forIndexTemplate
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
API name:allow_auto_create
Required - An ordered list of component template names.If this object is included, the template is used to create data streams and their backing indices.Required - Name of the index template.meta()
Optional user metadata about the index template.static IndexTemplate
final Long
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
final IndexTemplateSummary
template()
Template to be applied.toString()
final Long
version()
Version number used to manage index templates externally.
-
Field Details
-
_DESERIALIZER
Json deserializer forIndexTemplate
-
-
Method Details
-
of
-
indexPatterns
Required - Name of the index template.API name:
index_patterns
-
composedOf
Required - 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
-
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
-
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
-
meta
Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.API name:
_meta
-
allowAutoCreate
API name:allow_auto_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
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
toString
-
setupIndexTemplateDeserializer
-