Package org.opensearch.client.opensearch.indices

Class TemplateMapping.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.TemplateMapping.Builder

All Implemented Interfaces:

ObjectBuilder<TemplateMapping>

Enclosing class:

TemplateMapping

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

Builder for TemplateMapping.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TemplateMapping.Builder	aliases(java.lang.String key, java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Required - API name: aliases
TemplateMapping.Builder	aliases(java.lang.String key, Alias value)	Required - API name: aliases
TemplateMapping.Builder	aliases(java.util.Map<java.lang.String,Alias> map)	Required - API name: aliases
TemplateMapping	build()	Builds a TemplateMapping.
TemplateMapping.Builder	indexPatterns(java.lang.String value, java.lang.String... values)	Required - API name: index_patterns
TemplateMapping.Builder	indexPatterns(java.util.List<java.lang.String> list)	Required - API name: index_patterns
TemplateMapping.Builder	mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	Required - API name: mappings
TemplateMapping.Builder	mappings(TypeMapping value)	Required - API name: mappings
TemplateMapping.Builder	order(int value)	Required - API name: order
TemplateMapping.Builder	settings(java.lang.String key, JsonData value)	Required - API name: settings
TemplateMapping.Builder	settings(java.util.Map<java.lang.String,JsonData> map)	Required - API name: settings
TemplateMapping.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

aliases

public final TemplateMapping.Builder aliases(java.util.Map<java.lang.String,Alias> map)

Required - API name: aliases

Adds all entries of map to aliases.

aliases

public final TemplateMapping.Builder aliases(java.lang.String key,
                                             Alias value)

Required - API name: aliases

Adds an entry to aliases.

aliases

public final TemplateMapping.Builder aliases(java.lang.String key,
                                             java.util.function.Function<Alias.Builder,ObjectBuilder<Alias>> fn)

Required - API name: aliases

Adds an entry to aliases using a builder lambda.

indexPatterns

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

Required - API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

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

Required - API name: index_patterns

Adds one or more values to indexPatterns.

mappings

public final TemplateMapping.Builder mappings(TypeMapping value)

Required - API name: mappings

mappings

public final TemplateMapping.Builder mappings(java.util.function.Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

Required - API name: mappings

order

public final TemplateMapping.Builder order(int value)

Required - API name: order

settings

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

Required - API name: settings

Adds all entries of map to settings.

settings

public final TemplateMapping.Builder settings(java.lang.String key,
                                              JsonData value)

Required - API name: settings

Adds an entry to settings.

version

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

API name: version

build

public TemplateMapping build()

Builds a TemplateMapping.

Specified by:

build in interface ObjectBuilder<TemplateMapping>

Throws:

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