Module org.elasticsearch.server

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 skipNameCollisionChecks)
Metadata.Builder	clusterUUID(String clusterUUID)
Metadata.Builder	clusterUUIDCommitted(boolean clusterUUIDCommitted)
Metadata.Builder	componentTemplates(Map<String,ComponentTemplate> componentTemplates)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	coordinationMetadata(CoordinationMetadata coordinationMetadata)
Metadata.Builder	customs(Map<String,Metadata.ClusterCustom> clusterCustoms)
DataStream	dataStream(String dataStreamName)	Deprecated, for removal: This API element is subject to removal in a future version.
DataStreamMetadata	dataStreamMetadata()	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	dataStreams(Map<String,DataStream> dataStreams, Map<String,DataStreamAlias> dataStreamAliases)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	forEachProject(UnaryOperator<ProjectMetadata.Builder> modifier)
static Metadata	fromXContent(XContentParser parser)
Metadata.Builder	generateClusterUuidIfNeeded()
IndexMetadata	get(String index)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.ClusterCustom	getCustom(String type)
ProjectMetadata.Builder	getProject(ProjectId projectId)
IndexMetadata	getSafe(Index index)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	hashesOfConsistentSettings(Map<String,String> hashesOfConsistentSettings)
Metadata.Builder	hashesOfConsistentSettings(DiffableStringMap hashesOfConsistentSettings)
Metadata.Builder	indexTemplates(Map<String,ComposableIndexTemplate> indexTemplates)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	indices(Map<String,IndexMetadata> indices)	Deprecated, for removal: This API element is subject to removal in a future version.
Settings	persistentSettings()
Metadata.Builder	persistentSettings(Settings settings)
Metadata.Builder	projectCustoms(Map<String,Metadata.ProjectCustom> projectCustoms)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	projectMetadata(Map<ProjectId,ProjectMetadata> projectMetadata)
boolean	put(String aliasName, String dataStream, Boolean isWriteDataStream, String filter)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(String name, ComponentTemplate componentTemplate)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(String name, ComposableIndexTemplate indexTemplate)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(Map<String,ReservedStateMetadata> reservedStateMetadata)	Adds a map of namespace to ReservedStateMetadata into the metadata builder
Metadata.Builder	put(DataStream dataStream)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(IndexMetadata.Builder indexMetadataBuilder)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(IndexMetadata indexMetadata, boolean incrementVersion)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(IndexTemplateMetadata template)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(IndexTemplateMetadata.Builder template)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	put(ProjectMetadata projectMetadata)
Metadata.Builder	put(ProjectMetadata.Builder projectMetadata)
Metadata.Builder	put(ReservedStateMetadata metadata)	Adds a ReservedStateMetadata for a given namespace to the metadata builder
Metadata.Builder	putCustom(String type, Metadata.ClusterCustom custom)
Metadata.Builder	putCustom(String type, Metadata.ProjectCustom custom)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	putProjectCustom(String type, Metadata.ProjectCustom custom)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	remove(String index)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	removeAllIndices()	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	removeComponentTemplate(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	removeCustom(String type)
Metadata.Builder	removeCustomIf(BiPredicate<String,? super Metadata.ClusterCustom> p)
Metadata.Builder	removeDataStream(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
boolean	removeDataStreamAlias(String aliasName, String dataStreamName, boolean mustExist)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	removeIndexTemplate(String name)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	removeProject(ProjectId projectId)
Metadata.Builder	removeReservedState(ReservedStateMetadata metadata)	Removes a ReservedStateMetadata for a given namespace
Metadata.Builder	removeTemplate(String templateName)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	templates(Map<String,IndexTemplateMetadata> templates)	Deprecated, for removal: This API element is subject to removal in a future version.
Settings	transientSettings()
Metadata.Builder	transientSettings(Settings settings)
Metadata.Builder	updateNumberOfReplicas(int numberOfReplicas, String[] indices)	Deprecated, for removal: This API element is subject to removal in a future version.
Metadata.Builder	updateSettings(Settings settings, String... indices)	Deprecated, for removal: This API element is subject to removal in a future version.
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

projectMetadata

public Metadata.Builder projectMetadata(Map<ProjectId,ProjectMetadata> projectMetadata)

put

public Metadata.Builder put(ProjectMetadata projectMetadata)

put

public Metadata.Builder put(ProjectMetadata.Builder projectMetadata)

removeProject

public Metadata.Builder removeProject(ProjectId projectId)

getProject

public ProjectMetadata.Builder getProject(ProjectId projectId)

forEachProject

public Metadata.Builder forEachProject(UnaryOperator<ProjectMetadata.Builder> modifier)

put

@Deprecated(forRemoval=true)
public Metadata.Builder put(IndexMetadata.Builder indexMetadataBuilder)

Deprecated, for removal: This API element is subject to removal in a future version.

put

@Deprecated(forRemoval=true)
public Metadata.Builder put(IndexMetadata indexMetadata,
 boolean incrementVersion)

Deprecated, for removal: This API element is subject to removal in a future version.

get

@Deprecated(forRemoval=true)
public IndexMetadata get(String index)

Deprecated, for removal: This API element is subject to removal in a future version.

getSafe

@Deprecated(forRemoval=true)
public IndexMetadata getSafe(Index index)

Deprecated, for removal: This API element is subject to removal in a future version.

remove

@Deprecated(forRemoval=true)
public Metadata.Builder remove(String index)

Deprecated, for removal: This API element is subject to removal in a future version.

removeAllIndices

@Deprecated(forRemoval=true)
public Metadata.Builder removeAllIndices()

Deprecated, for removal: This API element is subject to removal in a future version.

indices

@Deprecated(forRemoval=true)
public Metadata.Builder indices(Map<String,IndexMetadata> indices)

Deprecated, for removal: This API element is subject to removal in a future version.

put

@Deprecated(forRemoval=true)
public Metadata.Builder put(IndexTemplateMetadata.Builder template)

Deprecated, for removal: This API element is subject to removal in a future version.

put

@Deprecated(forRemoval=true)
public Metadata.Builder put(IndexTemplateMetadata template)

Deprecated, for removal: This API element is subject to removal in a future version.

removeTemplate

@Deprecated(forRemoval=true)
public Metadata.Builder removeTemplate(String templateName)

Deprecated, for removal: This API element is subject to removal in a future version.

templates

@Deprecated(forRemoval=true)
public Metadata.Builder templates(Map<String,IndexTemplateMetadata> templates)

Deprecated, for removal: This API element is subject to removal in a future version.

put

@Deprecated(forRemoval=true)
public Metadata.Builder put(String name,
 ComponentTemplate componentTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

removeComponentTemplate

@Deprecated(forRemoval=true)
public Metadata.Builder removeComponentTemplate(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

componentTemplates

@Deprecated(forRemoval=true)
public Metadata.Builder componentTemplates(Map<String,ComponentTemplate> componentTemplates)

Deprecated, for removal: This API element is subject to removal in a future version.

indexTemplates

@Deprecated(forRemoval=true)
public Metadata.Builder indexTemplates(Map<String,ComposableIndexTemplate> indexTemplates)

Deprecated, for removal: This API element is subject to removal in a future version.

put

@Deprecated(forRemoval=true)
public Metadata.Builder put(String name,
 ComposableIndexTemplate indexTemplate)

Deprecated, for removal: This API element is subject to removal in a future version.

removeIndexTemplate

@Deprecated(forRemoval=true)
public Metadata.Builder removeIndexTemplate(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

dataStream

@Deprecated(forRemoval=true)
public DataStream dataStream(String dataStreamName)

Deprecated, for removal: This API element is subject to removal in a future version.

dataStreams

@Deprecated(forRemoval=true)
public Metadata.Builder dataStreams(Map<String,DataStream> dataStreams,
 Map<String,DataStreamAlias> dataStreamAliases)

Deprecated, for removal: This API element is subject to removal in a future version.

put

@Deprecated(forRemoval=true)
public Metadata.Builder put(DataStream dataStream)

Deprecated, for removal: This API element is subject to removal in a future version.

dataStreamMetadata

@Deprecated(forRemoval=true)
public DataStreamMetadata dataStreamMetadata()

Deprecated, for removal: This API element is subject to removal in a future version.

put

@Deprecated(forRemoval=true)
public boolean put(String aliasName,
 String dataStream,
 Boolean isWriteDataStream,
 String filter)

Deprecated, for removal: This API element is subject to removal in a future version.

removeDataStream

@Deprecated(forRemoval=true)
public Metadata.Builder removeDataStream(String name)

Deprecated, for removal: This API element is subject to removal in a future version.

removeDataStreamAlias

@Deprecated(forRemoval=true)
public boolean removeDataStreamAlias(String aliasName,
 String dataStreamName,
 boolean mustExist)

Deprecated, for removal: This API element is subject to removal in a future version.

putCustom

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

putCustom

@Deprecated(forRemoval=true)
public Metadata.Builder putCustom(String type,
 Metadata.ProjectCustom custom)

Deprecated, for removal: This API element is subject to removal in a future version.

getCustom

public Metadata.ClusterCustom getCustom(String type)

removeCustom

public Metadata.Builder removeCustom(String type)

removeCustomIf

public Metadata.Builder removeCustomIf(BiPredicate<String,? super Metadata.ClusterCustom> p)

customs

public Metadata.Builder customs(Map<String,Metadata.ClusterCustom> clusterCustoms)

putProjectCustom

@Deprecated(forRemoval=true)
public Metadata.Builder putProjectCustom(String type,
 Metadata.ProjectCustom custom)

Deprecated, for removal: This API element is subject to removal in a future version.

projectCustoms

@Deprecated(forRemoval=true)
public Metadata.Builder projectCustoms(Map<String,Metadata.ProjectCustom> projectCustoms)

Deprecated, for removal: This API element is subject to removal in a future version.

put

public Metadata.Builder put(Map<String,ReservedStateMetadata> reservedStateMetadata)

Adds a map of namespace to ReservedStateMetadata into the metadata builder

Parameters:

reservedStateMetadata - a map of namespace to ReservedStateMetadata

Returns:

Metadata.Builder

put

public Metadata.Builder put(ReservedStateMetadata metadata)

Adds a ReservedStateMetadata for a given namespace to the metadata builder

Parameters:

metadata - a ReservedStateMetadata

Returns:

Metadata.Builder

removeReservedState

public Metadata.Builder removeReservedState(ReservedStateMetadata metadata)

Removes a ReservedStateMetadata for a given namespace

Parameters:

metadata - a ReservedStateMetadata

Returns:

Metadata.Builder

updateSettings

@Deprecated(forRemoval=true)
public Metadata.Builder updateSettings(Settings settings,
 String... indices)

Deprecated, for removal: This API element is subject to removal in a future version.

updateNumberOfReplicas

@Deprecated(forRemoval=true)
public Metadata.Builder updateNumberOfReplicas(int numberOfReplicas,
 String[] indices)

Deprecated, for removal: This API element is subject to removal in a future version.

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 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 skipNameCollisionChecks)

fromXContent

public static Metadata fromXContent(XContentParser parser)
                             throws IOException

Throws:

IOException