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:

CopyableBuilder<TemplateMapping.Builder,TemplateMapping>, MutableBuilder<TemplateMapping.Builder,TemplateMapping>, ObjectBuilder<TemplateMapping>

Enclosing class:

TemplateMapping

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

Builder for TemplateMapping.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final TemplateMapping.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Required - API name: aliases
final TemplateMapping.Builder	aliases(String key, Alias value)	Required - API name: aliases
final TemplateMapping.Builder	aliases(Map<String,Alias> map)	Required - API name: aliases
TemplateMapping	build()	Builds a TemplateMapping.
TemplateMapping.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final TemplateMapping.Builder	indexPatterns(String value, String... values)	Required - API name: index_patterns
final TemplateMapping.Builder	indexPatterns(List<String> list)	Required - API name: index_patterns
final TemplateMapping.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	Required - API name: mappings
final TemplateMapping.Builder	mappings(TypeMapping value)	Required - API name: mappings
final TemplateMapping.Builder	order(int value)	Required - The order in which the template should be applied.
final TemplateMapping.Builder	settings(String key, JsonData value)	Required - The index settings to apply.
final TemplateMapping.Builder	settings(Map<String,JsonData> map)	Required - The index settings to apply.
final TemplateMapping.Builder	version(Long value)	API name: version

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

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public TemplateMapping.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<TemplateMapping.Builder,TemplateMapping>

Returns:

a new builder instance.

aliases

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

Required - API name: aliases

Adds all elements of map to aliases.

aliases

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

Required - API name: aliases

Adds an entry to aliases.

aliases

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

Required - API name: aliases

Adds a value to aliases using a builder lambda.

indexPatterns

@Nonnull
public final TemplateMapping.Builder indexPatterns(List<String> list)

Required - API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

@Nonnull
public final TemplateMapping.Builder indexPatterns(String value,
 String... values)

Required - API name: index_patterns

Adds one or more values to indexPatterns.

mappings

@Nonnull
public final TemplateMapping.Builder mappings(TypeMapping value)

Required - API name: mappings

mappings

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

Required - API name: mappings

order

@Nonnull
public final TemplateMapping.Builder order(int value)

Required - The order in which the template should be applied.

API name: order

settings

@Nonnull
public final TemplateMapping.Builder settings(Map<String,JsonData> map)

Required - The index settings to apply.

API name: settings

Adds all elements of map to settings.

settings

@Nonnull
public final TemplateMapping.Builder settings(String key,
 JsonData value)

Required - The index settings to apply.

API name: settings

Adds an entry to settings.

version

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

API name: version

build

@Nonnull
public TemplateMapping build()

Builds a TemplateMapping.

Specified by:

build in interface ObjectBuilder<TemplateMapping>

Throws:

NullPointerException - if some of the required fields are null.