Package org.opensearch.client.opensearch.indices

Class IndexTemplate.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.indices.IndexTemplate.Builder

All Implemented Interfaces:

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

Enclosing class:

IndexTemplate

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

Builder for IndexTemplate.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexTemplate.Builder	allowAutoCreate(Boolean value)	Whether the template allows automatic index creation.
IndexTemplate	build()	Builds a IndexTemplate.
final IndexTemplate.Builder	composedOf(String value, String... values)	An ordered list of component template names.
final IndexTemplate.Builder	composedOf(List<String> list)	An ordered list of component template names.
IndexTemplate.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final IndexTemplate.Builder	dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)	API name: data_stream
final IndexTemplate.Builder	dataStream(IndexTemplateDataStreamConfiguration value)	API name: data_stream
final IndexTemplate.Builder	indexPatterns(String value, String... values)	Required - API name: index_patterns
final IndexTemplate.Builder	indexPatterns(List<String> list)	Required - API name: index_patterns
final IndexTemplate.Builder	meta(String key, JsonData value)	API name: _meta
final IndexTemplate.Builder	meta(Map<String,JsonData> map)	API name: _meta
final IndexTemplate.Builder	priority(Long value)	The priority to determine index template precedence when a new data stream or index is created.
final IndexTemplate.Builder	template(Function<IndexTemplateSummary.Builder,ObjectBuilder<IndexTemplateSummary>> fn)	API name: template
final IndexTemplate.Builder	template(IndexTemplateSummary value)	API name: template
final IndexTemplate.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 IndexTemplate.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<IndexTemplate.Builder,IndexTemplate>

Returns:

a new builder instance.

allowAutoCreate

@Nonnull
public final IndexTemplate.Builder allowAutoCreate(@Nullable
 Boolean value)

Whether the template allows automatic index creation.

API name: allow_auto_create

composedOf

@Nonnull
public final IndexTemplate.Builder composedOf(List<String> list)

An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

Adds all elements of list to composedOf.

composedOf

@Nonnull
public final IndexTemplate.Builder composedOf(String value,
 String... values)

An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

Adds one or more values to composedOf.

dataStream

@Nonnull
public final IndexTemplate.Builder dataStream(@Nullable
 IndexTemplateDataStreamConfiguration value)

API name: data_stream

dataStream

@Nonnull
public final IndexTemplate.Builder dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)

API name: data_stream

indexPatterns

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

Required - API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

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

Required - API name: index_patterns

Adds one or more values to indexPatterns.

meta

@Nonnull
public final IndexTemplate.Builder meta(Map<String,JsonData> map)

API name: _meta

Adds all elements of map to meta.

meta

@Nonnull
public final IndexTemplate.Builder meta(String key,
 JsonData value)

API name: _meta

Adds an entry to meta.

priority

@Nonnull
public final IndexTemplate.Builder priority(@Nullable
 Long value)

The priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by OpenSearch.

API name: priority

template

@Nonnull
public final IndexTemplate.Builder template(@Nullable
 IndexTemplateSummary value)

API name: template

template

@Nonnull
public final IndexTemplate.Builder template(Function<IndexTemplateSummary.Builder,ObjectBuilder<IndexTemplateSummary>> fn)

API name: template

version

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

API name: version

build

@Nonnull
public IndexTemplate build()

Builds a IndexTemplate.

Specified by:

build in interface ObjectBuilder<IndexTemplate>

Throws:

NullPointerException - if some of the required fields are null.