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

Class IndexTemplate.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<IndexTemplate>

Enclosing class:

IndexTemplate

public static class IndexTemplate.Builder
extends java.lang.Object
implements ObjectBuilder<IndexTemplate>

Builder for IndexTemplate.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
IndexTemplate.Builder	addComposedOf(java.lang.String value)	Add a value to composedOf(List), creating the list if needed.
IndexTemplate.Builder	addIndexPatterns(java.lang.String value)	Add a value to indexPatterns(List), creating the list if needed.
IndexTemplate.Builder	allowAutoCreate(java.lang.Boolean value)	API name: allow_auto_create
IndexTemplate	build()	Builds a IndexTemplate.
IndexTemplate.Builder	composedOf(java.lang.String... value)	API name: composed_of
IndexTemplate.Builder	composedOf(java.util.List<java.lang.String> value)	API name: composed_of
IndexTemplate.Builder	dataStream(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: data_stream
IndexTemplate.Builder	indexPatterns(java.lang.String... value)	API name: index_patterns
IndexTemplate.Builder	indexPatterns(java.util.List<java.lang.String> value)	API name: index_patterns
IndexTemplate.Builder	meta(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: _meta
IndexTemplate.Builder	priority(java.lang.Number value)	API name: priority
IndexTemplate.Builder	putDataStream(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to dataStream(Map), creating the map if needed.
IndexTemplate.Builder	putMeta(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to meta(Map), creating the map if needed.
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.Number value)	API name: version

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

indexPatterns

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

API name: index_patterns

indexPatterns

public IndexTemplate.Builder indexPatterns(java.lang.String... value)

API name: index_patterns

addIndexPatterns

public IndexTemplate.Builder addIndexPatterns(java.lang.String value)

Add a value to indexPatterns(List), creating the list if needed.

composedOf

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

API name: composed_of

composedOf

public IndexTemplate.Builder composedOf(java.lang.String... value)

API name: composed_of

addComposedOf

public IndexTemplate.Builder addComposedOf(java.lang.String value)

Add a value to composedOf(List), creating the list if needed.

template

public IndexTemplate.Builder template(IndexTemplateSummary value)

API name: template

template

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

API name: template

version

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

API name: version

priority

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

API name: priority

meta

public IndexTemplate.Builder meta(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: _meta

putMeta

public IndexTemplate.Builder putMeta(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to meta(Map), creating the map if needed.

allowAutoCreate

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

API name: allow_auto_create

dataStream

public IndexTemplate.Builder dataStream(@Nullable java.util.Map<java.lang.String,jakarta.json.JsonValue> value)

API name: data_stream

putDataStream

public IndexTemplate.Builder putDataStream(java.lang.String key, jakarta.json.JsonValue value)

Add a key/value to dataStream(Map), creating the map if needed.

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.