Package org.opensearch.client.opensearch.indices.put_index_template

Class IndexTemplateMapping.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.put_index_template.IndexTemplateMapping.Builder

All Implemented Interfaces:

PlainDeserializable<IndexTemplateMapping.Builder>, CopyableBuilder<IndexTemplateMapping.Builder,IndexTemplateMapping>, MutableBuilder<IndexTemplateMapping.Builder,IndexTemplateMapping>, ObjectBuilder<IndexTemplateMapping>

Enclosing class:

IndexTemplateMapping

public static class IndexTemplateMapping.Builder
extends ObjectBuilderBase
implements CopyableBuilder<IndexTemplateMapping.Builder,IndexTemplateMapping>, PlainDeserializable<IndexTemplateMapping.Builder>

Builder for IndexTemplateMapping.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexTemplateMapping.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	The aliases to add.
final IndexTemplateMapping.Builder	aliases(String key, Alias value)	The aliases to add.
final IndexTemplateMapping.Builder	aliases(Map<String,Alias> map)	The aliases to add.
IndexTemplateMapping	build()	Builds a IndexTemplateMapping.
IndexTemplateMapping.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexTemplateMapping.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
final IndexTemplateMapping.Builder	mappings(TypeMapping value)	API name: mappings
IndexTemplateMapping.Builder	self()
final IndexTemplateMapping.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	API name: settings
final IndexTemplateMapping.Builder	settings(IndexSettings value)	API name: settings

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.util.MutableBuilder

applyMutation

Methods inherited from interface org.opensearch.client.json.PlainDeserializable

withJson, withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public IndexTemplateMapping.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<IndexTemplateMapping.Builder,IndexTemplateMapping>

Returns:

a new builder instance.

self

@Nonnull
public IndexTemplateMapping.Builder self()

Specified by:

self in interface PlainDeserializable<IndexTemplateMapping.Builder>

aliases

@Nonnull
public final IndexTemplateMapping.Builder aliases(Map<String,Alias> map)

The aliases to add. If the index template includes a data_stream object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the index_routing, routing, and search_routing options.

API name: aliases

Adds all elements of map to aliases.

aliases

@Nonnull
public final IndexTemplateMapping.Builder aliases(String key,
 Alias value)

The aliases to add. If the index template includes a data_stream object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the index_routing, routing, and search_routing options.

API name: aliases

Adds an entry to aliases.

aliases

@Nonnull
public final IndexTemplateMapping.Builder aliases(String key,
 Function<Alias.Builder,ObjectBuilder<Alias>> fn)

The aliases to add. If the index template includes a data_stream object, these are data stream aliases. Otherwise, these are index aliases. Data stream aliases ignore the index_routing, routing, and search_routing options.

API name: aliases

Adds a value to aliases using a builder lambda.

mappings

@Nonnull
public final IndexTemplateMapping.Builder mappings(@Nullable
 TypeMapping value)

API name: mappings

mappings

@Nonnull
public final IndexTemplateMapping.Builder mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

API name: mappings

settings

@Nonnull
public final IndexTemplateMapping.Builder settings(@Nullable
 IndexSettings value)

API name: settings

settings

@Nonnull
public final IndexTemplateMapping.Builder settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)

API name: settings

build

@Nonnull
public IndexTemplateMapping build()

Builds a IndexTemplateMapping.

Specified by:

build in interface ObjectBuilder<IndexTemplateMapping>

Throws:

NullPointerException - if some of the required fields are null.