Package co.elastic.clients.elasticsearch.indices

Class PutIndexTemplateRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<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.
PutIndexTemplateRequest.Builder	composedOf(java.lang.String value, java.lang.String... values)	API name: composed_of
PutIndexTemplateRequest.Builder	composedOf(java.util.List<java.lang.String> list)	API name: composed_of
PutIndexTemplateRequest.Builder	create(java.lang.Boolean value)	Whether the index template should only be added if new or can also replace an existing one
PutIndexTemplateRequest.Builder	dataStream(DataStreamVisibility value)	API name: data_stream
PutIndexTemplateRequest.Builder	dataStream(java.util.function.Function<DataStreamVisibility.Builder,ObjectBuilder<DataStreamVisibility>> fn)	API name: data_stream
PutIndexTemplateRequest.Builder	indexPatterns(java.lang.String value, java.lang.String... values)	API name: index_patterns
PutIndexTemplateRequest.Builder	indexPatterns(java.util.List<java.lang.String> list)	API name: index_patterns
PutIndexTemplateRequest.Builder	meta(java.lang.String key, JsonData value)	API name: _meta
PutIndexTemplateRequest.Builder	meta(java.util.Map<java.lang.String,JsonData> map)	API name: _meta
PutIndexTemplateRequest.Builder	name(java.lang.String value)	Required - Index or template name
PutIndexTemplateRequest.Builder	priority(java.lang.Integer value)	API name: priority
protected PutIndexTemplateRequest.Builder	self()
PutIndexTemplateRequest.Builder	template(IndexTemplateMapping value)	API name: template
PutIndexTemplateRequest.Builder	template(java.util.function.Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)	API name: template
PutIndexTemplateRequest.Builder	version(java.lang.Long value)	API name: version

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(java.util.Map<java.lang.String,JsonData> map)

API name: _meta

Adds all entries of map to meta.

meta

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

API name: _meta

Adds an entry to meta.

composedOf

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

API name: composed_of

Adds all elements of list to composedOf.

composedOf

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

API name: composed_of

Adds one or more values to composedOf.

create

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

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

API name: create

dataStream

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

API name: data_stream

dataStream

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

API name: data_stream

indexPatterns

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

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

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

API name: index_patterns

Adds one or more values to indexPatterns.

name

public final PutIndexTemplateRequest.Builder name(java.lang.String value)

Required - Index or template name

API name: name

priority

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

API name: priority

template

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

API name: template

template

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

API name: template

version

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

API name: version

self

protected PutIndexTemplateRequest.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<PutIndexTemplateRequest.Builder>

build

public PutIndexTemplateRequest build()

Builds a PutIndexTemplateRequest.

Specified by:

build in interface ObjectBuilder<PutIndexTemplateRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.