Package org.opensearch.client.opensearch.indices.simulate_template

Class Template.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.simulate_template.Template.Builder

All Implemented Interfaces:

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

Enclosing class:

Template

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

Builder for Template.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final Template.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Required - The map of alias names to their configurations.
final Template.Builder	aliases(String key, Alias value)	Required - The map of alias names to their configurations.
final Template.Builder	aliases(Map<String,Alias> map)	Required - The map of alias names to their configurations.
Template	build()	Builds a Template.
Template.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final Template.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	API name: mappings
final Template.Builder	mappings(TypeMapping value)	API name: mappings
final Template.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Required - API name: settings
final Template.Builder	settings(IndexSettings value)	Required - 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

Constructor Details

Builder

public Builder()

Method Details

copy

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

Returns:

a new builder instance.

aliases

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

Required - The map of alias names to their configurations.

API name: aliases

Adds all elements of map to aliases.

aliases

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

Required - The map of alias names to their configurations.

API name: aliases

Adds an entry to aliases.

aliases

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

Required - The map of alias names to their configurations.

API name: aliases

Adds a value to aliases using a builder lambda.

mappings

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

API name: mappings

mappings

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

API name: mappings

settings

@Nonnull
public final Template.Builder settings(IndexSettings value)

Required - API name: settings

settings

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

Required - API name: settings

build

@Nonnull
public Template build()

Builds a Template.

Specified by:

build in interface ObjectBuilder<Template>

Throws:

NullPointerException - if some of the required fields are null.