Package co.elastic.clients.elasticsearch.indices

Class PutIndexTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutIndexTemplateRequest.Builder>

co.elastic.clients.elasticsearch.indices.PutIndexTemplateRequest.Builder

All Implemented Interfaces:

WithJson<PutIndexTemplateRequest.Builder>, ObjectBuilder<PutIndexTemplateRequest>

Enclosing class:

PutIndexTemplateRequest

public static class PutIndexTemplateRequest.Builder
extends RequestBase.AbstractBuilder<PutIndexTemplateRequest.Builder>
implements ObjectBuilder<PutIndexTemplateRequest>

Builder for PutIndexTemplateRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutIndexTemplateRequest	build()	Builds a PutIndexTemplateRequest.
final PutIndexTemplateRequest.Builder	composedOf(String value, String... values)	An ordered list of component template names.
final PutIndexTemplateRequest.Builder	composedOf(List<String> list)	An ordered list of component template names.
final PutIndexTemplateRequest.Builder	create(Boolean value)	If true, this request cannot replace or update existing index templates.
final PutIndexTemplateRequest.Builder	dataStream(DataStreamVisibility value)	If this object is included, the template is used to create data streams and their backing indices.
final PutIndexTemplateRequest.Builder	dataStream(Function<DataStreamVisibility.Builder,ObjectBuilder<DataStreamVisibility>> fn)	If this object is included, the template is used to create data streams and their backing indices.
final PutIndexTemplateRequest.Builder	indexPatterns(String value, String... values)	Name of the index template to create.
final PutIndexTemplateRequest.Builder	indexPatterns(List<String> list)	Name of the index template to create.
final PutIndexTemplateRequest.Builder	meta(String key, JsonData value)	Optional user metadata about the index template.
final PutIndexTemplateRequest.Builder	meta(Map<String,JsonData> map)	Optional user metadata about the index template.
final PutIndexTemplateRequest.Builder	name(String value)	Required - Index or template name
final PutIndexTemplateRequest.Builder	priority(Integer value)	Priority to determine index template precedence when a new data stream or index is created.
protected PutIndexTemplateRequest.Builder	self()
final PutIndexTemplateRequest.Builder	template(IndexTemplateMapping value)	Template to be applied.
final PutIndexTemplateRequest.Builder	template(Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)	Template to be applied.
final PutIndexTemplateRequest.Builder	version(Long value)	Version number used to manage index templates externally.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

meta

public final PutIndexTemplateRequest.Builder meta(Map<String,JsonData> map)

Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.

API name: _meta

Adds all entries of map to meta.

meta

public final PutIndexTemplateRequest.Builder meta(String key,
 JsonData value)

Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.

API name: _meta

Adds an entry to meta.

composedOf

public final PutIndexTemplateRequest.Builder composedOf(List<String> list)

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

Adds all elements of list to composedOf.

composedOf

public final PutIndexTemplateRequest.Builder composedOf(String value,
 String... values)

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

Adds one or more values to composedOf.

create

public final PutIndexTemplateRequest.Builder create(@Nullable
 Boolean value)

If true, this request cannot replace or update existing index templates.

API name: create

dataStream

public final PutIndexTemplateRequest.Builder dataStream(@Nullable
 DataStreamVisibility value)

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 a data_stream object.

API name: data_stream

dataStream

public final PutIndexTemplateRequest.Builder dataStream(Function<DataStreamVisibility.Builder,ObjectBuilder<DataStreamVisibility>> fn)

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 a data_stream object.

API name: data_stream

indexPatterns

public final PutIndexTemplateRequest.Builder indexPatterns(List<String> list)

Name of the index template to create.

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

public final PutIndexTemplateRequest.Builder indexPatterns(String value,
 String... values)

Name of the index template to create.

API name: index_patterns

Adds one or more values to indexPatterns.

name

public final PutIndexTemplateRequest.Builder name(String value)

Required - Index or template name

API name: name

priority

public final PutIndexTemplateRequest.Builder priority(@Nullable
 Integer value)

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

public final PutIndexTemplateRequest.Builder template(@Nullable
 IndexTemplateMapping value)

Template to be applied. It may optionally include an aliases, mappings, or settings configuration.

API name: template

template

public final PutIndexTemplateRequest.Builder template(Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)

Template to be applied. It may optionally include an aliases, mappings, or settings configuration.

API name: template

version

public final PutIndexTemplateRequest.Builder version(@Nullable
 Long value)

Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.

API name: version

self

protected PutIndexTemplateRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutIndexTemplateRequest.Builder>

build

public PutIndexTemplateRequest build()

Builds a PutIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutIndexTemplateRequest>

Throws:

NullPointerException - if some of the required fields are null.