Package org.opensearch.client.opensearch.indices

Class PutIndexTemplateRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<PutIndexTemplateRequest>

Enclosing class:

PutIndexTemplateRequest

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

Builder for PutIndexTemplateRequest.

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
PutIndexTemplateRequest.Builder	addComposedOf(java.lang.String value)	Add a value to composedOf(List), creating the list if needed.
PutIndexTemplateRequest.Builder	addIndexPatterns(java.lang.String value)	Add a value to indexPatterns(List), creating the list if needed.
PutIndexTemplateRequest	build()	Builds a PutIndexTemplateRequest.
PutIndexTemplateRequest.Builder	composedOf(java.lang.String... value)	API name: composed_of
PutIndexTemplateRequest.Builder	composedOf(java.util.List<java.lang.String> value)	API name: composed_of
PutIndexTemplateRequest.Builder	dataStream(jakarta.json.JsonValue value)	API name: data_stream
PutIndexTemplateRequest.Builder	indexPatterns(java.lang.String... value)	API name: index_patterns
PutIndexTemplateRequest.Builder	indexPatterns(java.util.List<java.lang.String> value)	API name: index_patterns
PutIndexTemplateRequest.Builder	meta(java.util.Map<java.lang.String,jakarta.json.JsonValue> value)	API name: _meta
PutIndexTemplateRequest.Builder	name(java.lang.String value)	Index or template name API name: name
PutIndexTemplateRequest.Builder	priority(java.lang.Number value)	API name: priority
PutIndexTemplateRequest.Builder	putMeta(java.lang.String key, jakarta.json.JsonValue value)	Add a key/value to meta(Map), creating the map if needed.
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.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

name

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

Index or template name API name: name

indexPatterns

public PutIndexTemplateRequest.Builder indexPatterns(@Nullable java.util.List<java.lang.String> value)

API name: index_patterns

indexPatterns

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

API name: index_patterns

addIndexPatterns

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

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

composedOf

public PutIndexTemplateRequest.Builder composedOf(@Nullable java.util.List<java.lang.String> value)

API name: composed_of

composedOf

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

API name: composed_of

addComposedOf

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

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

template

public PutIndexTemplateRequest.Builder template(@Nullable IndexTemplateMapping value)

API name: template

template

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

API name: template

dataStream

public PutIndexTemplateRequest.Builder dataStream(@Nullable jakarta.json.JsonValue value)

API name: data_stream

priority

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

API name: priority

version

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

API name: version

meta

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

API name: _meta

putMeta

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

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

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.