Package org.opensearch.client.opensearch.indices

Class PutIndexTemplateRequest.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.PutIndexTemplateRequest.Builder

All Implemented Interfaces:

ObjectBuilder<PutIndexTemplateRequest>

Enclosing class:

PutIndexTemplateRequest

public static class PutIndexTemplateRequest.Builder
extends ObjectBuilderBase
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	dataStream(java.util.function.Function<DataStream.Builder,ObjectBuilder<DataStream>> fn)	API name: data_stream
PutIndexTemplateRequest.Builder	dataStream(DataStream value)	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
PutIndexTemplateRequest.Builder	template(java.util.function.Function<IndexTemplateMapping.Builder,ObjectBuilder<IndexTemplateMapping>> fn)	API name: template
PutIndexTemplateRequest.Builder	template(IndexTemplateMapping value)	API name: template
PutIndexTemplateRequest.Builder	version(java.lang.Long value)	API name: version

Methods inherited from class org.opensearch.client.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

Constructor Detail

Builder

public Builder()

Method Detail

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.

dataStream

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

API name: data_stream

dataStream

public final PutIndexTemplateRequest.Builder dataStream(java.util.function.Function<DataStream.Builder,ObjectBuilder<DataStream>> 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

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.