Package org.elasticsearch.cluster.metadata

Class Metadata

java.lang.Object

org.elasticsearch.cluster.metadata.Metadata

All Implemented Interfaces:

java.lang.Iterable<IndexMetadata>, Diffable<Metadata>, Writeable, ToXContent, ToXContentFragment

public class Metadata
extends java.lang.Object
implements java.lang.Iterable<IndexMetadata>, Diffable<Metadata>, ToXContentFragment

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Metadata.Builder
static interface	Metadata.Custom
static class	Metadata.XContentContext

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ALL
static java.util.EnumSet<Metadata.XContentContext>	ALL_CONTEXTS	Indicates that this custom metadata will be returned as part of an API call, stored as a part of a snapshot global state, and will be persisted between node restarts
static java.util.EnumSet<Metadata.XContentContext>	API_AND_GATEWAY	Indicates that this custom metadata will be returned as part of an API call and will be persisted between node restarts, but will not be a part of a snapshot global state
static java.util.EnumSet<Metadata.XContentContext>	API_AND_SNAPSHOT	Indicates that this custom metadata will be returned as part of an API call and stored as a part of a snapshot global state, but will not be persisted between node restarts
static java.util.EnumSet<Metadata.XContentContext>	API_ONLY	Indicates that this custom metadata will be returned as part of an API call but will not be persisted
static ClusterBlock	CLUSTER_READ_ONLY_ALLOW_DELETE_BLOCK
static ClusterBlock	CLUSTER_READ_ONLY_BLOCK
static java.lang.String	CONTEXT_MODE_API
static java.lang.String	CONTEXT_MODE_GATEWAY
static java.lang.String	CONTEXT_MODE_PARAM
static java.lang.String	CONTEXT_MODE_SNAPSHOT
static Metadata	EMPTY_METADATA
static MetadataStateFormat<Metadata>	FORMAT	State format for Metadata to write to and load from disk
static java.lang.String	GLOBAL_STATE_FILE_PREFIX
static Setting<java.lang.Integer>	SETTING_CLUSTER_MAX_SHARDS_PER_NODE
static Setting<java.lang.Boolean>	SETTING_READ_ONLY_ALLOW_DELETE_SETTING
static Setting<java.lang.Boolean>	SETTING_READ_ONLY_SETTING
static java.lang.String	UNKNOWN_CLUSTER_UUID

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static Metadata.Builder	builder()
static Metadata.Builder	builder(Metadata metadata)
java.lang.String	clusterUUID()
boolean	clusterUUIDCommitted()	Whether the current node with the given cluster state is locked into the cluster with the UUID returned by clusterUUID(), meaning that it will not accept any cluster state with a different clusterUUID.
java.util.Map<java.lang.String,ComponentTemplate>	componentTemplates()
CoordinationMetadata	coordinationMetadata()
<T extends Metadata.Custom> T	custom(java.lang.String type)
ImmutableOpenMap<java.lang.String,Metadata.Custom>	customs()
java.util.Map<java.lang.String,DataStream>	dataStreams()
Diff<Metadata>	diff(Metadata previousState)	Returns serializable object representing differences between this and previousState
boolean	equalsAliases(Metadata other)
ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>>	findAliases(AliasesRequest aliasesRequest, java.lang.String[] concreteIndices)	Finds the specific index aliases that match with the specified aliases directly or partially via wildcards, and that point to the specified concrete indices (directly or matching indices via wildcards).
ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>>	findAllAliases(java.lang.String[] concreteIndices)	Finds the specific index aliases that point to the requested concrete indices directly or that match with the indices via wildcards.
ImmutableOpenMap<java.lang.String,IndexAbstraction.DataStream>	findDataStreams(java.lang.String[] concreteIndices)	Finds the parent data streams, if any, for the specified concrete indices.
ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>>	findMappings(java.lang.String[] concreteIndices, java.lang.String[] types, java.util.function.Function<java.lang.String,java.util.function.Predicate<java.lang.String>> fieldFilter)	Finds all mappings for types and concrete indices.
static Metadata	fromXContent(XContentParser parser)
java.lang.String[]	getConcreteAllClosedIndices()	Returns all of the concrete indices that are closed.
java.lang.String[]	getConcreteAllIndices()	Returns all the concrete indices.
java.lang.String[]	getConcreteAllOpenIndices()	Returns all of the concrete indices that are open.
java.lang.String[]	getConcreteVisibleClosedIndices()	Returns all of the concrete indices that are closed and not hidden.
java.lang.String[]	getConcreteVisibleIndices()	Returns all the concrete indices that are not hidden.
java.lang.String[]	getConcreteVisibleOpenIndices()	Returns all of the concrete indices that are open and not hidden.
ImmutableOpenMap<java.lang.String,Metadata.Custom>	getCustoms()
IndexMetadata	getIndexSafe(Index index)	Returns the IndexMetadata for this index.
ImmutableOpenMap<java.lang.String,IndexMetadata>	getIndices()
java.util.SortedMap<java.lang.String,IndexAbstraction>	getIndicesLookup()
ImmutableOpenMap<java.lang.String,IndexTemplateMetadata>	getTemplates()
int	getTotalNumberOfShards()	Gets the total number of shards from all indices, including replicas and closed indices.
int	getTotalOpenIndexShards()	Gets the total number of open shards from all indices.
boolean	hasAlias(java.lang.String alias)
boolean	hasAliases(java.lang.String[] aliases, java.lang.String[] concreteIndices)	Checks if at least one of the specified aliases exists in the specified concrete indices.
boolean	hasConcreteIndex(java.lang.String index)
java.util.Map<java.lang.String,java.lang.String>	hashesOfConsistentSettings()
boolean	hasIndex(java.lang.String index)
boolean	hasIndexMetadata(IndexMetadata indexMetadata)	Returns true iff existing index has the same IndexMetadata instance
IndexMetadata	index(java.lang.String index)
IndexMetadata	index(Index index)
IndexGraveyard	indexGraveyard()	The collection of index deletions in the cluster.
ImmutableOpenMap<java.lang.String,IndexMetadata>	indices()
static boolean	isAllTypes(java.lang.String[] types)	Identifies whether the array containing type names given as argument refers to all types The empty or null array identifies all types
static boolean	isExplicitAllType(java.lang.String[] types)	Identifies whether the array containing type names given as argument explicitly refers to all types The empty or null array doesn't explicitly map to all types
static boolean	isGlobalStateEquals(Metadata metadata1, Metadata metadata2)
java.util.Iterator<IndexMetadata>	iterator()
Settings	persistentSettings()
static Diff<Metadata>	readDiffFrom(StreamInput in)
static Metadata	readFrom(StreamInput in)
java.lang.String	resolveIndexRouting(java.lang.String routing, java.lang.String aliasOrIndex)	Returns indexing routing for the given index.
java.lang.String	resolveWriteIndexRouting(java.lang.String routing, java.lang.String aliasOrIndex)	Returns indexing routing for the given aliasOrIndex.
boolean	routingRequired(java.lang.String concreteIndex)
Settings	settings()	Returns the merged transient and persistent settings.
ImmutableOpenMap<java.lang.String,IndexTemplateMetadata>	templates()
java.util.Map<java.lang.String,ComposableIndexTemplate>	templatesV2()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Settings	transientSettings()
long	version()
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

ALL

public static final java.lang.String ALL

See Also:

Constant Field Values

UNKNOWN_CLUSTER_UUID

public static final java.lang.String UNKNOWN_CLUSTER_UUID

See Also:

Constant Field Values

API_ONLY

public static java.util.EnumSet<Metadata.XContentContext> API_ONLY

Indicates that this custom metadata will be returned as part of an API call but will not be persisted

API_AND_GATEWAY

public static java.util.EnumSet<Metadata.XContentContext> API_AND_GATEWAY

Indicates that this custom metadata will be returned as part of an API call and will be persisted between node restarts, but will not be a part of a snapshot global state

API_AND_SNAPSHOT

public static java.util.EnumSet<Metadata.XContentContext> API_AND_SNAPSHOT

Indicates that this custom metadata will be returned as part of an API call and stored as a part of a snapshot global state, but will not be persisted between node restarts

ALL_CONTEXTS

public static java.util.EnumSet<Metadata.XContentContext> ALL_CONTEXTS

Indicates that this custom metadata will be returned as part of an API call, stored as a part of a snapshot global state, and will be persisted between node restarts

SETTING_CLUSTER_MAX_SHARDS_PER_NODE

public static final Setting<java.lang.Integer> SETTING_CLUSTER_MAX_SHARDS_PER_NODE

SETTING_READ_ONLY_SETTING

public static final Setting<java.lang.Boolean> SETTING_READ_ONLY_SETTING

CLUSTER_READ_ONLY_BLOCK

public static final ClusterBlock CLUSTER_READ_ONLY_BLOCK

SETTING_READ_ONLY_ALLOW_DELETE_SETTING

public static final Setting<java.lang.Boolean> SETTING_READ_ONLY_ALLOW_DELETE_SETTING

CLUSTER_READ_ONLY_ALLOW_DELETE_BLOCK

public static final ClusterBlock CLUSTER_READ_ONLY_ALLOW_DELETE_BLOCK

EMPTY_METADATA

public static final Metadata EMPTY_METADATA

CONTEXT_MODE_PARAM

public static final java.lang.String CONTEXT_MODE_PARAM

See Also:

Constant Field Values

CONTEXT_MODE_SNAPSHOT

public static final java.lang.String CONTEXT_MODE_SNAPSHOT

CONTEXT_MODE_GATEWAY

public static final java.lang.String CONTEXT_MODE_GATEWAY

CONTEXT_MODE_API

public static final java.lang.String CONTEXT_MODE_API

GLOBAL_STATE_FILE_PREFIX

public static final java.lang.String GLOBAL_STATE_FILE_PREFIX

See Also:

Constant Field Values

FORMAT

public static final MetadataStateFormat<Metadata> FORMAT

State format for Metadata to write to and load from disk

Method Details

version

public long version()

clusterUUID

public java.lang.String clusterUUID()

clusterUUIDCommitted

public boolean clusterUUIDCommitted()

Whether the current node with the given cluster state is locked into the cluster with the UUID returned by clusterUUID(), meaning that it will not accept any cluster state with a different clusterUUID.

settings

public Settings settings()

Returns the merged transient and persistent settings.

transientSettings

public Settings transientSettings()

persistentSettings

public Settings persistentSettings()

hashesOfConsistentSettings

public java.util.Map<java.lang.String,java.lang.String> hashesOfConsistentSettings()

coordinationMetadata

public CoordinationMetadata coordinationMetadata()

hasAlias

public boolean hasAlias(java.lang.String alias)

equalsAliases

public boolean equalsAliases(Metadata other)

getIndicesLookup

public java.util.SortedMap<java.lang.String,IndexAbstraction> getIndicesLookup()

findAllAliases

public ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>> findAllAliases(java.lang.String[] concreteIndices)

Finds the specific index aliases that point to the requested concrete indices directly or that match with the indices via wildcards.

Parameters:

concreteIndices - The concrete indices that the aliases must point to in order to be returned.

Returns:

A map of index name to the list of aliases metadata. If a concrete index does not have matching aliases then the result will not include the index's key.

findAliases

public ImmutableOpenMap<java.lang.String,java.util.List<AliasMetadata>> findAliases(AliasesRequest aliasesRequest, java.lang.String[] concreteIndices)

Finds the specific index aliases that match with the specified aliases directly or partially via wildcards, and that point to the specified concrete indices (directly or matching indices via wildcards).

Parameters:

aliasesRequest - The request to find aliases for

concreteIndices - The concrete indices that the aliases must point to in order to be returned.

Returns:

A map of index name to the list of aliases metadata. If a concrete index does not have matching aliases then the result will not include the index's key.

hasAliases

public boolean hasAliases(java.lang.String[] aliases, java.lang.String[] concreteIndices)

Checks if at least one of the specified aliases exists in the specified concrete indices. Wildcards are supported in the alias names for partial matches.

Parameters:

aliases - The names of the index aliases to find

concreteIndices - The concrete indexes the index aliases must point to order to be returned.

Returns:

whether at least one of the specified aliases exists in one of the specified concrete indices.

findMappings

public ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetadata>> findMappings(java.lang.String[] concreteIndices, java.lang.String[] types, java.util.function.Function<java.lang.String,java.util.function.Predicate<java.lang.String>> fieldFilter) throws java.io.IOException

Finds all mappings for types and concrete indices. Types are expanded to include all types that match the glob patterns in the types array. Empty types array, null or {"_all"} will be expanded to all types available for the given indices. Only fields that match the provided field filter will be returned (default is a predicate that always returns true, which can be overridden via plugins)

Throws:

java.io.IOException

See Also:

MapperPlugin.getFieldFilter()

findDataStreams

public ImmutableOpenMap<java.lang.String,IndexAbstraction.DataStream> findDataStreams(java.lang.String[] concreteIndices)

Finds the parent data streams, if any, for the specified concrete indices.

getConcreteAllIndices

public java.lang.String[] getConcreteAllIndices()

Returns all the concrete indices.

getConcreteVisibleIndices

public java.lang.String[] getConcreteVisibleIndices()

Returns all the concrete indices that are not hidden.

getConcreteAllOpenIndices

public java.lang.String[] getConcreteAllOpenIndices()

Returns all of the concrete indices that are open.

getConcreteVisibleOpenIndices

public java.lang.String[] getConcreteVisibleOpenIndices()

Returns all of the concrete indices that are open and not hidden.

getConcreteAllClosedIndices

public java.lang.String[] getConcreteAllClosedIndices()

Returns all of the concrete indices that are closed.

getConcreteVisibleClosedIndices

public java.lang.String[] getConcreteVisibleClosedIndices()

Returns all of the concrete indices that are closed and not hidden.

resolveWriteIndexRouting

public java.lang.String resolveWriteIndexRouting(@Nullable java.lang.String routing, java.lang.String aliasOrIndex)

Returns indexing routing for the given aliasOrIndex. Resolves routing from the alias metadata used in the write index.

resolveIndexRouting

public java.lang.String resolveIndexRouting(@Nullable java.lang.String routing, java.lang.String aliasOrIndex)

Returns indexing routing for the given index.

hasIndex

public boolean hasIndex(java.lang.String index)

hasConcreteIndex

public boolean hasConcreteIndex(java.lang.String index)

index

public IndexMetadata index(java.lang.String index)

index

public IndexMetadata index(Index index)

hasIndexMetadata

public boolean hasIndexMetadata(IndexMetadata indexMetadata)

Returns true iff existing index has the same IndexMetadata instance

getIndexSafe

public IndexMetadata getIndexSafe(Index index)

Returns the IndexMetadata for this index.

Throws:

IndexNotFoundException - if no metadata for this index is found

indices

public ImmutableOpenMap<java.lang.String,IndexMetadata> indices()

getIndices

public ImmutableOpenMap<java.lang.String,IndexMetadata> getIndices()

templates

public ImmutableOpenMap<java.lang.String,IndexTemplateMetadata> templates()

getTemplates

public ImmutableOpenMap<java.lang.String,IndexTemplateMetadata> getTemplates()

componentTemplates

public java.util.Map<java.lang.String,ComponentTemplate> componentTemplates()

templatesV2

public java.util.Map<java.lang.String,ComposableIndexTemplate> templatesV2()

dataStreams

public java.util.Map<java.lang.String,DataStream> dataStreams()

customs

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

getCustoms

public ImmutableOpenMap<java.lang.String,Metadata.Custom> getCustoms()

indexGraveyard

public IndexGraveyard indexGraveyard()

The collection of index deletions in the cluster.

custom

public <T extends Metadata.Custom> T custom(java.lang.String type)

getTotalNumberOfShards

public int getTotalNumberOfShards()

Gets the total number of shards from all indices, including replicas and closed indices.

Returns:

The total number shards from all indices.

getTotalOpenIndexShards

public int getTotalOpenIndexShards()

Gets the total number of open shards from all indices. Includes replicas, but does not include shards that are part of closed indices.

Returns:

The total number of open shards from all indices.

isAllTypes

public static boolean isAllTypes(java.lang.String[] types)

Identifies whether the array containing type names given as argument refers to all types The empty or null array identifies all types

Parameters:

types - the array containing types

Returns:

true if the provided array maps to all types, false otherwise

isExplicitAllType

public static boolean isExplicitAllType(java.lang.String[] types)

Identifies whether the array containing type names given as argument explicitly refers to all types The empty or null array doesn't explicitly map to all types

Parameters:

types - the array containing index names

Returns:

true if the provided array explicitly maps to all types, false otherwise

routingRequired

public boolean routingRequired(java.lang.String concreteIndex)

Parameters:

concreteIndex - The concrete index to check if routing is required

Returns:

Whether routing is required according to the mapping for the specified index and type

iterator

public java.util.Iterator<IndexMetadata> iterator()

Specified by:

iterator in interface java.lang.Iterable<IndexMetadata>

isGlobalStateEquals

public static boolean isGlobalStateEquals(Metadata metadata1, Metadata metadata2)

diff

public Diff<Metadata> diff(Metadata previousState)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<Metadata>

readDiffFrom

public static Diff<Metadata> readDiffFrom(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

fromXContent

public static Metadata fromXContent(XContentParser parser) throws java.io.IOException

Throws:

java.io.IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readFrom

public static Metadata readFrom(StreamInput in) throws java.io.IOException

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out) throws java.io.IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

java.io.IOException

builder

public static Metadata.Builder builder()

builder

public static Metadata.Builder builder(Metadata metadata)