Class PutTemplateRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.indices.PutTemplateRequest
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class PutTemplateRequest extends RequestBase implements JsonpSerializable
Creates or updates an index template.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PutTemplateRequest.Builder
Builder forPutTemplateRequest
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<PutTemplateRequest>
_DESERIALIZER
Json deserializer forPutTemplateRequest
static Endpoint<PutTemplateRequest,PutTemplateResponse,ErrorResponse>
_ENDPOINT
Endpoint "indices.put_template
". -
Method Summary
Modifier and Type Method Description java.util.Map<java.lang.String,Alias>
aliases()
Aliases for the index.java.lang.Boolean
create()
If true, this request cannot replace or update existing index templates.java.lang.Boolean
flatSettings()
API name:flat_settings
java.util.List<java.lang.String>
indexPatterns()
Array of wildcard expressions used to match the names of indices during creation.TypeMapping
mappings()
Mapping for fields in the index.Time
masterTimeout()
Period to wait for a connection to the master node.java.lang.String
name()
Required - The name of the templatestatic PutTemplateRequest
of(java.util.function.Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn)
java.lang.Integer
order()
Order in which Elasticsearch applies this template if index matches multiple templates.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
java.util.Map<java.lang.String,JsonData>
settings()
Configuration options for the index.protected static void
setupPutTemplateRequestDeserializer(ObjectDeserializer<PutTemplateRequest.Builder> op)
Time
timeout()
API name:timeout
java.lang.Long
version()
Version number used to manage index templates externally.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forPutTemplateRequest
-
_ENDPOINT
Endpoint "indices.put_template
".
-
-
Method Details
-
of
public static PutTemplateRequest of(java.util.function.Function<PutTemplateRequest.Builder,ObjectBuilder<PutTemplateRequest>> fn) -
aliases
Aliases for the index.API name:
aliases
-
create
@Nullable public final java.lang.Boolean create()If true, this request cannot replace or update existing index templates.API name:
create
-
flatSettings
@Nullable public final java.lang.Boolean flatSettings()API name:flat_settings
-
indexPatterns
public final java.util.List<java.lang.String> indexPatterns()Array of wildcard expressions used to match the names of indices during creation.API name:
index_patterns
-
mappings
Mapping for fields in the index.API name:
mappings
-
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
public final java.lang.String name()Required - The name of the templateAPI name:
name
-
order
@Nullable public final java.lang.Integer order()Order in which Elasticsearch applies this template if index matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher 'order' values are merged later, overriding templates with lower values.
API name:
order
-
settings
Configuration options for the index.API name:
settings
-
timeout
API name:timeout
-
version
@Nullable public final java.lang.Long 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
-
setupPutTemplateRequestDeserializer
protected static void setupPutTemplateRequestDeserializer(ObjectDeserializer<PutTemplateRequest.Builder> op)
-