Package org.opensearch.client.opensearch.indices.get_index_template

Class IndexTemplate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.get_index_template.IndexTemplate.Builder

All Implemented Interfaces:

ObjectBuilder<IndexTemplate>

Enclosing class:

IndexTemplate

public static class IndexTemplate.Builder
extends ObjectBuilderBase
implements ObjectBuilder<IndexTemplate>

Builder for IndexTemplate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexTemplate.Builder	allowAutoCreate(java.lang.Boolean value)	API name: allow_auto_create
IndexTemplate	build()	Builds a IndexTemplate.
IndexTemplate.Builder	composedOf(java.lang.String value, java.lang.String... values)	Required - API name: composed_of
IndexTemplate.Builder	composedOf(java.util.List<java.lang.String> list)	Required - API name: composed_of
IndexTemplate.Builder	dataStream(java.lang.String key, JsonData value)	API name: data_stream
IndexTemplate.Builder	dataStream(java.util.Map<java.lang.String,JsonData> map)	API name: data_stream
IndexTemplate.Builder	indexPatterns(java.lang.String value, java.lang.String... values)	Required - API name: index_patterns
IndexTemplate.Builder	indexPatterns(java.util.List<java.lang.String> list)	Required - API name: index_patterns
IndexTemplate.Builder	meta(java.lang.String key, JsonData value)	API name: _meta
IndexTemplate.Builder	meta(java.util.Map<java.lang.String,JsonData> map)	API name: _meta
IndexTemplate.Builder	priority(java.lang.Long value)	API name: priority
IndexTemplate.Builder	template(java.util.function.Function<IndexTemplateSummary.Builder,ObjectBuilder<IndexTemplateSummary>> fn)	API name: template
IndexTemplate.Builder	template(IndexTemplateSummary value)	API name: template
IndexTemplate.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

indexPatterns

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

Required - API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

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

Required - API name: index_patterns

Adds one or more values to indexPatterns.

composedOf

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

Required - API name: composed_of

Adds all elements of list to composedOf.

composedOf

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

Required - API name: composed_of

Adds one or more values to composedOf.

template

public final IndexTemplate.Builder template(@Nullable
                                            IndexTemplateSummary value)

API name: template

template

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

API name: template

version

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

API name: version

priority

public final IndexTemplate.Builder priority(@Nullable
                                            java.lang.Long value)

API name: priority

meta

public final IndexTemplate.Builder meta(java.util.Map<java.lang.String,JsonData> map)

API name: _meta

Adds all entries of map to meta.

meta

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

API name: _meta

Adds an entry to meta.

allowAutoCreate

public final IndexTemplate.Builder allowAutoCreate(@Nullable
                                                   java.lang.Boolean value)

API name: allow_auto_create

dataStream

public final IndexTemplate.Builder dataStream(java.util.Map<java.lang.String,JsonData> map)

API name: data_stream

Adds all entries of map to dataStream.

dataStream

public final IndexTemplate.Builder dataStream(java.lang.String key,
                                              JsonData value)

API name: data_stream

Adds an entry to dataStream.

build

public IndexTemplate build()

Builds a IndexTemplate.

Specified by:

build in interface ObjectBuilder<IndexTemplate>

Throws:

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