Package co.elastic.clients.elasticsearch.indices.put_index_template

Class IndexTemplateMapping.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<IndexTemplateMapping.Builder>

co.elastic.clients.elasticsearch.indices.put_index_template.IndexTemplateMapping.Builder

All Implemented Interfaces:

WithJson<IndexTemplateMapping.Builder>, ObjectBuilder<IndexTemplateMapping>

Enclosing class:

IndexTemplateMapping

public static class IndexTemplateMapping.Builder
extends WithJsonObjectBuilderBase<IndexTemplateMapping.Builder>
implements ObjectBuilder<IndexTemplateMapping>

Builder for IndexTemplateMapping.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexTemplateMapping.Builder	aliases(String key, Alias value)	Aliases to add.
final IndexTemplateMapping.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases to add.
final IndexTemplateMapping.Builder	aliases(Map<String,Alias> map)	Aliases to add.
IndexTemplateMapping	build()	Builds a IndexTemplateMapping.
final IndexTemplateMapping.Builder	lifecycle(DataStreamLifecycle value)	API name: lifecycle
final IndexTemplateMapping.Builder	lifecycle(Function<DataStreamLifecycle.Builder,ObjectBuilder<DataStreamLifecycle>> fn)	API name: lifecycle
final IndexTemplateMapping.Builder	mappings(TypeMapping value)	Mapping for fields in the index.
final IndexTemplateMapping.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	Mapping for fields in the index.
protected IndexTemplateMapping.Builder	self()
final IndexTemplateMapping.Builder	settings(IndexSettings value)	Configuration options for the index.
final IndexTemplateMapping.Builder	settings(Function<IndexSettings.Builder,ObjectBuilder<IndexSettings>> fn)	Configuration options for the index.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

aliases

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

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 entries of map to aliases.

aliases

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

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

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

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 using a builder lambda.

mappings

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

Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters.

API name: mappings

mappings

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

Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping parameters.

API name: mappings

settings

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

Configuration options for the index.

API name: settings

settings

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

Configuration options for the index.

API name: settings

lifecycle

public final IndexTemplateMapping.Builder lifecycle(@Nullable
 DataStreamLifecycle value)

API name: lifecycle

lifecycle

public final IndexTemplateMapping.Builder lifecycle(Function<DataStreamLifecycle.Builder,ObjectBuilder<DataStreamLifecycle>> fn)

API name: lifecycle

self

protected IndexTemplateMapping.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<IndexTemplateMapping.Builder>

build

public IndexTemplateMapping build()

Builds a IndexTemplateMapping.

Specified by:

build in interface ObjectBuilder<IndexTemplateMapping>

Throws:

NullPointerException - if some of the required fields are null.