Package org.opensearch.cluster.metadata

Class IndexTemplateMetadata.Builder

java.lang.Object

org.opensearch.cluster.metadata.IndexTemplateMetadata.Builder

Enclosing class:

IndexTemplateMetadata

@PublicApi(since="1.0.0")
public static class IndexTemplateMetadata.Builder
extends Object

Builder of index template metadata.

Opensearch.api:

Constructor Summary

Constructors

Constructor	Description
Builder(String name)
Builder(IndexTemplateMetadata indexTemplateMetadata)

Method Summary

Modifier and Type	Method	Description
IndexTemplateMetadata	build()
static IndexTemplateMetadata	fromXContent(org.opensearch.core.xcontent.XContentParser parser, String templateName)
IndexTemplateMetadata.Builder	order(int order)
IndexTemplateMetadata.Builder	patterns(List<String> indexPatterns)
IndexTemplateMetadata.Builder	putAlias(AliasMetadata aliasMetadata)
IndexTemplateMetadata.Builder	putAlias(AliasMetadata.Builder aliasMetadata)
IndexTemplateMetadata.Builder	putMapping(String mappingType, String mappingSource)
IndexTemplateMetadata.Builder	putMapping(String mappingType, CompressedXContent mappingSource)
IndexTemplateMetadata.Builder	settings(Settings settings)
IndexTemplateMetadata.Builder	settings(Settings.Builder settings)
static void	toXContent(IndexTemplateMetadata indexTemplateMetadata, org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)	Serializes the template to xContent, making sure not to nest mappings under the type name.
static void	toXContentWithTypes(IndexTemplateMetadata indexTemplateMetadata, org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)	Serializes the template to xContent, using the legacy format where the mappings are nested under the type name.
IndexTemplateMetadata.Builder	version(Integer version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder(String name)

Builder

public Builder(IndexTemplateMetadata indexTemplateMetadata)

Method Details

order

public IndexTemplateMetadata.Builder order(int order)

version

public IndexTemplateMetadata.Builder version(Integer version)

patterns

public IndexTemplateMetadata.Builder patterns(List<String> indexPatterns)

settings

public IndexTemplateMetadata.Builder settings(Settings.Builder settings)

settings

public IndexTemplateMetadata.Builder settings(Settings settings)

putMapping

public IndexTemplateMetadata.Builder putMapping(String mappingType,
 CompressedXContent mappingSource)

putMapping

public IndexTemplateMetadata.Builder putMapping(String mappingType,
 String mappingSource)
                                         throws IOException

Throws:

IOException

putAlias

public IndexTemplateMetadata.Builder putAlias(AliasMetadata aliasMetadata)

putAlias

public IndexTemplateMetadata.Builder putAlias(AliasMetadata.Builder aliasMetadata)

build

public IndexTemplateMetadata build()

toXContentWithTypes

public static void toXContentWithTypes(IndexTemplateMetadata indexTemplateMetadata,
 org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                throws IOException

Serializes the template to xContent, using the legacy format where the mappings are nested under the type name.

This method is used for serializing templates before storing them in the cluster metadata, and also in the REST layer when returning a deprecated typed response.

Throws:

IOException

toXContent

public static void toXContent(IndexTemplateMetadata indexTemplateMetadata,
 org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                       throws IOException

Serializes the template to xContent, making sure not to nest mappings under the type name.

Note that this method should currently only be used for creating REST responses, and not when directly updating stored templates. Index templates are still stored in the old, typed format, and have yet to be migrated to be typeless.

Throws:

IOException

fromXContent

public static IndexTemplateMetadata fromXContent(org.opensearch.core.xcontent.XContentParser parser,
 String templateName)
                                          throws IOException

Throws:

IOException