Package org.elasticsearch.cluster.metadata

Class Metadata.Builder

java.lang.Object

org.elasticsearch.cluster.metadata.Metadata.Builder

Enclosing class:

Metadata

public static class Metadata.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
Metadata	build()
Metadata	build(boolean builtIndicesLookupEagerly)
Metadata.Builder	clusterUUID(String clusterUUID)
Metadata.Builder	clusterUUIDCommitted(boolean clusterUUIDCommitted)
Metadata.Builder	componentTemplates(Map<String,ComponentTemplate> componentTemplates)
Metadata.Builder	coordinationMetadata(CoordinationMetadata coordinationMetadata)
Metadata.Builder	customs(ImmutableOpenMap<String,Metadata.Custom> customs)
DataStream	dataStream(String dataStreamName)
Metadata.Builder	dataStreams(Map<String,DataStream> dataStreams, Map<String,DataStreamAlias> dataStreamAliases)
static Metadata	fromXContent(org.elasticsearch.xcontent.XContentParser parser)
Metadata.Builder	generateClusterUuidIfNeeded()
IndexMetadata	get(String index)
Metadata.Custom	getCustom(String type)
IndexMetadata	getSafe(Index index)
DiffableStringMap	hashesOfConsistentSettings()
Metadata.Builder	hashesOfConsistentSettings(Map<String,String> hashesOfConsistentSettings)
Metadata.Builder	hashesOfConsistentSettings(DiffableStringMap hashesOfConsistentSettings)
IndexGraveyard	indexGraveyard()
Metadata.Builder	indexGraveyard(IndexGraveyard indexGraveyard)
Metadata.Builder	indexTemplates(Map<String,ComposableIndexTemplate> indexTemplates)
Metadata.Builder	indices(ImmutableOpenMap<String,IndexMetadata> indices)
Settings	persistentSettings()
Metadata.Builder	persistentSettings(Settings settings)
boolean	put(String aliasName, String dataStream, Boolean isWriteDataStream, String filter)
Metadata.Builder	put(String name, ComponentTemplate componentTemplate)
Metadata.Builder	put(String name, ComposableIndexTemplate indexTemplate)
Metadata.Builder	put(DataStream dataStream)
Metadata.Builder	put(IndexMetadata.Builder indexMetadataBuilder)
Metadata.Builder	put(IndexMetadata indexMetadata, boolean incrementVersion)
Metadata.Builder	put(IndexTemplateMetadata template)
Metadata.Builder	put(IndexTemplateMetadata.Builder template)
Metadata.Builder	putCustom(String type, Metadata.Custom custom)
Metadata.Builder	remove(String index)
Metadata.Builder	removeAllIndices()
Metadata.Builder	removeComponentTemplate(String name)
Metadata.Builder	removeCustom(String type)
Metadata.Builder	removeDataStream(String name)
boolean	removeDataStreamAlias(String aliasName, String dataStreamName, boolean mustExist)
Metadata.Builder	removeIndexTemplate(String name)
Metadata.Builder	removeTemplate(String templateName)
Metadata.Builder	templates(ImmutableOpenMap<String,IndexTemplateMetadata> templates)
static void	toXContent(Metadata metadata, org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
Settings	transientSettings()
Metadata.Builder	transientSettings(Settings settings)
Metadata.Builder	updateNumberOfReplicas(int numberOfReplicas, String[] indices)	Update the number of replicas for the specified indices.
Metadata.Builder	updateSettings(Settings settings, String... indices)
Metadata.Builder	version(long version)

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

put

public Metadata.Builder put(IndexMetadata.Builder indexMetadataBuilder)

put

public Metadata.Builder put(IndexMetadata indexMetadata,
 boolean incrementVersion)

get

public IndexMetadata get(String index)

getSafe

public IndexMetadata getSafe(Index index)

remove

public Metadata.Builder remove(String index)

removeAllIndices

public Metadata.Builder removeAllIndices()

indices

public Metadata.Builder indices(ImmutableOpenMap<String,IndexMetadata> indices)

put

public Metadata.Builder put(IndexTemplateMetadata.Builder template)

put

public Metadata.Builder put(IndexTemplateMetadata template)

removeTemplate

public Metadata.Builder removeTemplate(String templateName)

templates

public Metadata.Builder templates(ImmutableOpenMap<String,IndexTemplateMetadata> templates)

put

public Metadata.Builder put(String name,
 ComponentTemplate componentTemplate)

removeComponentTemplate

public Metadata.Builder removeComponentTemplate(String name)

componentTemplates

public Metadata.Builder componentTemplates(Map<String,ComponentTemplate> componentTemplates)

indexTemplates

public Metadata.Builder indexTemplates(Map<String,ComposableIndexTemplate> indexTemplates)

put

public Metadata.Builder put(String name,
 ComposableIndexTemplate indexTemplate)

removeIndexTemplate

public Metadata.Builder removeIndexTemplate(String name)

dataStream

public DataStream dataStream(String dataStreamName)

dataStreams

public Metadata.Builder dataStreams(Map<String,DataStream> dataStreams,
 Map<String,DataStreamAlias> dataStreamAliases)

put

public Metadata.Builder put(DataStream dataStream)

put

public boolean put(String aliasName,
 String dataStream,
 Boolean isWriteDataStream,
 String filter)

removeDataStream

public Metadata.Builder removeDataStream(String name)

removeDataStreamAlias

public boolean removeDataStreamAlias(String aliasName,
 String dataStreamName,
 boolean mustExist)

getCustom

public Metadata.Custom getCustom(String type)

putCustom

public Metadata.Builder putCustom(String type,
 Metadata.Custom custom)

removeCustom

public Metadata.Builder removeCustom(String type)

customs

public Metadata.Builder customs(ImmutableOpenMap<String,Metadata.Custom> customs)

indexGraveyard

public Metadata.Builder indexGraveyard(IndexGraveyard indexGraveyard)

indexGraveyard

public IndexGraveyard indexGraveyard()

updateSettings

public Metadata.Builder updateSettings(Settings settings,
 String... indices)

updateNumberOfReplicas

public Metadata.Builder updateNumberOfReplicas(int numberOfReplicas,
 String[] indices)

Update the number of replicas for the specified indices.

Parameters:

numberOfReplicas - the number of replicas

indices - the indices to update the number of replicas for

Returns:

the builder

coordinationMetadata

public Metadata.Builder coordinationMetadata(CoordinationMetadata coordinationMetadata)

transientSettings

public Settings transientSettings()

transientSettings

public Metadata.Builder transientSettings(Settings settings)

persistentSettings

public Settings persistentSettings()

persistentSettings

public Metadata.Builder persistentSettings(Settings settings)

hashesOfConsistentSettings

public DiffableStringMap hashesOfConsistentSettings()

hashesOfConsistentSettings

public Metadata.Builder hashesOfConsistentSettings(DiffableStringMap hashesOfConsistentSettings)

hashesOfConsistentSettings

public Metadata.Builder hashesOfConsistentSettings(Map<String,String> hashesOfConsistentSettings)

version

public Metadata.Builder version(long version)

clusterUUID

public Metadata.Builder clusterUUID(String clusterUUID)

clusterUUIDCommitted

public Metadata.Builder clusterUUIDCommitted(boolean clusterUUIDCommitted)

generateClusterUuidIfNeeded

public Metadata.Builder generateClusterUuidIfNeeded()

build

public Metadata build()

Returns:

a new Metadata instance

build

public Metadata build(boolean builtIndicesLookupEagerly)

Parameters:

builtIndicesLookupEagerly - Controls whether indices lookup should be build as part of the execution of this method or after when needed. Almost all of the time indices lookup should be built eagerly, however in certain cases when Metdata instances are build that are not published and many indices have been defined then it makes sense to skip building indices lookup.

Returns:

a new Metadata instance

toXContent

public static void toXContent(Metadata metadata,
 org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                       throws IOException

Throws:

IOException

fromXContent

public static Metadata fromXContent(org.elasticsearch.xcontent.XContentParser parser)
                             throws IOException

Throws:

IOException