Package co.elastic.clients.elasticsearch.indices

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.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutIndexTemplateRequest.Builder	Builder for PutIndexTemplateRequest.

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 final JsonpDeserializer<PutIndexTemplateRequest>	_DESERIALIZER	Json deserializer for PutIndexTemplateRequest
static final Endpoint<PutIndexTemplateRequest,PutIndexTemplateResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.put_index_template".

Method Summary

Modifier and Type	Method	Description
final List<String>	composedOf()	API name: composed_of
final Boolean	create()	Whether the index template should only be added if new or can also replace an existing one
final DataStreamVisibility	dataStream()	API name: data_stream
final List<String>	indexPatterns()	API name: index_patterns
final Map<String,JsonData>	meta()	API name: _meta
final String	name()	Required - Index or template name
static PutIndexTemplateRequest	of(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)
final Integer	priority()	API name: priority
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	setupPutIndexTemplateRequestDeserializer(ObjectDeserializer<PutIndexTemplateRequest.Builder> op)
final IndexTemplateMapping	template()	API name: template
final Long	version()	API name: version

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

public static final JsonpDeserializer<PutIndexTemplateRequest> _DESERIALIZER

Json deserializer for PutIndexTemplateRequest

_ENDPOINT

public static final Endpoint<PutIndexTemplateRequest,PutIndexTemplateResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.put_index_template".

Method Details

of

public static PutIndexTemplateRequest of(Function<PutIndexTemplateRequest.Builder,ObjectBuilder<PutIndexTemplateRequest>> fn)

meta

public final Map<String,JsonData> meta()

API name: _meta

composedOf

public final List<String> composedOf()

API name: composed_of

create

@Nullable
public final Boolean create()

Whether the index template should only be added if new or can also replace an existing one

API name: create

dataStream

@Nullable
public final DataStreamVisibility dataStream()

API name: data_stream

indexPatterns

public final List<String> indexPatterns()

API name: index_patterns

name

public final String name()

Required - Index or template name

API name: name

priority

@Nullable
public final Integer priority()

API name: priority

template

@Nullable
public final IndexTemplateMapping template()

API name: template

version

@Nullable
public final Long version()

API name: version

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

setupPutIndexTemplateRequestDeserializer

protected static void setupPutIndexTemplateRequestDeserializer(ObjectDeserializer<PutIndexTemplateRequest.Builder> op)