Class PutIndexTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutIndexTemplateRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutIndexTemplateRequest
extends RequestBase
implements JsonpSerializable
Creates or updates an index template. Index templates define settings,
mappings, and aliases that can be applied automatically to new indices.
- 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<PutIndexTemplateRequest>
Json deserializer forPutIndexTemplateRequest
static final Endpoint<PutIndexTemplateRequest,
PutIndexTemplateResponse, ErrorResponse> Endpoint "indices.put_index_template
". -
Method Summary
Modifier and TypeMethodDescriptionAn ordered list of component template names.final Boolean
create()
Iftrue
, this request cannot replace or update existing index templates.final DataStreamVisibility
If this object is included, the template is used to create data streams and their backing indices.Name of the index template to create.meta()
Optional user metadata about the index template.final String
name()
Required - Index or template namestatic PutIndexTemplateRequest
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
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 forPutIndexTemplateRequest
-
_ENDPOINT
public static final Endpoint<PutIndexTemplateRequest,PutIndexTemplateResponse, _ENDPOINTErrorResponse> Endpoint "indices.put_index_template
".
-
-
Method Details
-
of
public static PutIndexTemplateRequest of(Function<PutIndexTemplateRequest.Builder, ObjectBuilder<PutIndexTemplateRequest>> fn) -
meta
Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.API name:
_meta
-
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
, this request cannot replace or update existing index templates.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
-
indexPatterns
Name of the index template to create.API name:
index_patterns
-
name
Required - Index or template nameAPI 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
-
setupPutIndexTemplateRequestDeserializer
protected static void setupPutIndexTemplateRequestDeserializer(ObjectDeserializer<PutIndexTemplateRequest.Builder> op)
-