Class PutComponentTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.cluster.PutComponentTemplateRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class PutComponentTemplateRequest
extends RequestBase
implements JsonpSerializable
Creates or updates a component template
- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<PutComponentTemplateRequest>
Json deserializer forPutComponentTemplateRequest
Endpoint "cluster.put_component_template
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
This setting overrides the value of theaction.auto_create_index
cluster setting.final Boolean
create()
Whether the index template should only be added if new or can also replace an existing onefinal Time
Specify timeout for connection to mastermeta()
Optional user metadata about the component template.final String
name()
Required - The name of the templatestatic PutComponentTemplateRequest
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
setupPutComponentTemplateRequestDeserializer
(ObjectDeserializer<PutComponentTemplateRequest.Builder> op) final IndexState
template()
Required - The template to be applied which includes mappings, settings, or aliases configuration.final Long
version()
Version number used to manage component templates externally.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forPutComponentTemplateRequest
-
_ENDPOINT
public static final Endpoint<PutComponentTemplateRequest,PutComponentTemplateResponse, _ENDPOINTErrorResponse> Endpoint "cluster.put_component_template
".
-
-
Method Details
-
of
-
meta
Optional user metadata about the component 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 data streams matching the template must always be explicitly created.API name:
allow_auto_create
-
create
Whether the index template should only be added if new or can also replace an existing oneAPI name:
create
-
masterTimeout
Specify timeout for connection to masterAPI name:
master_timeout
-
name
Required - The name of the templateAPI name:
name
-
template
Required - The template to be applied which includes mappings, settings, or aliases configuration.API name:
template
-
version
Version number used to manage component templates externally. This number isn't automatically generated or incremented by Elasticsearch.API name:
version
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupPutComponentTemplateRequestDeserializer
protected static void setupPutComponentTemplateRequestDeserializer(ObjectDeserializer<PutComponentTemplateRequest.Builder> op)
-