Package co.elastic.clients.elasticsearch.indices

Class IndexTemplateSummary.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.indices.IndexTemplateSummary.Builder

All Implemented Interfaces:

WithJson<IndexTemplateSummary.Builder>, ObjectBuilder<IndexTemplateSummary>

Enclosing class:

IndexTemplateSummary

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

Builder for IndexTemplateSummary.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexTemplateSummary.Builder	aliases(String key, Alias value)	Aliases to add.
final IndexTemplateSummary.Builder	aliases(String key, Function<Alias.Builder,ObjectBuilder<Alias>> fn)	Aliases to add.
final IndexTemplateSummary.Builder	aliases(Map<String,Alias> map)	Aliases to add.
IndexTemplateSummary	build()	Builds a IndexTemplateSummary.
final IndexTemplateSummary.Builder	dataStreamOptions(DataStreamOptionsTemplate value)	API name: data_stream_options
final IndexTemplateSummary.Builder	dataStreamOptions(Function<DataStreamOptionsTemplate.Builder,ObjectBuilder<DataStreamOptionsTemplate>> fn)	API name: data_stream_options
final IndexTemplateSummary.Builder	lifecycle(DataStreamLifecycleWithRollover value)	API name: lifecycle
final IndexTemplateSummary.Builder	lifecycle(Function<DataStreamLifecycleWithRollover.Builder,ObjectBuilder<DataStreamLifecycleWithRollover>> fn)	API name: lifecycle
final IndexTemplateSummary.Builder	mappings(TypeMapping value)	Mapping for fields in the index.
final IndexTemplateSummary.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	Mapping for fields in the index.
protected IndexTemplateSummary.Builder	self()
final IndexTemplateSummary.Builder	settings(IndexSettings value)	Configuration options for the index.
final IndexTemplateSummary.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 IndexTemplateSummary.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 IndexTemplateSummary.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 IndexTemplateSummary.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 IndexTemplateSummary.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 IndexTemplateSummary.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 IndexTemplateSummary.Builder settings(@Nullable
 IndexSettings value)

Configuration options for the index.

API name: settings

settings

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

Configuration options for the index.

API name: settings

lifecycle

public final IndexTemplateSummary.Builder lifecycle(@Nullable
 DataStreamLifecycleWithRollover value)

API name: lifecycle

lifecycle

public final IndexTemplateSummary.Builder lifecycle(Function<DataStreamLifecycleWithRollover.Builder,ObjectBuilder<DataStreamLifecycleWithRollover>> fn)

API name: lifecycle

dataStreamOptions

public final IndexTemplateSummary.Builder dataStreamOptions(@Nullable
 DataStreamOptionsTemplate value)

API name: data_stream_options

dataStreamOptions

public final IndexTemplateSummary.Builder dataStreamOptions(Function<DataStreamOptionsTemplate.Builder,ObjectBuilder<DataStreamOptionsTemplate>> fn)

API name: data_stream_options

self

protected IndexTemplateSummary.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<IndexTemplateSummary.Builder>

build

public IndexTemplateSummary build()

Builds a IndexTemplateSummary.

Specified by:

build in interface ObjectBuilder<IndexTemplateSummary>

Throws:

NullPointerException - if some of the required fields are null.