org.elasticsearch.cluster.metadata
Class MetaData

java.lang.Object
  org.elasticsearch.cluster.metadata.MetaData

All Implemented Interfaces:

Iterable<IndexMetaData>

public class MetaData
extends Object
implements Iterable<IndexMetaData>

Nested Class Summary

static class	MetaData.Builder
static interface	MetaData.Custom

Field Summary

static ClusterBlock	CLUSTER_READ_ONLY_BLOCK
static Map<String,MetaData.Custom.Factory>	customFactories
static MetaData	EMPTY_META_DATA
static String	SETTING_READ_ONLY

Method Summary

static void	addDynamicSettings(String... settings)
com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,AliasMetaData>>	aliases()
static MetaData.Builder	builder()
String[]	concreteAllIndices() Returns all the concrete indices.
com.google.common.collect.ImmutableSet<String>	concreteAllIndicesAsSet()
String[]	concreteAllOpenIndices()
String	concreteIndex(String index)
String[]	concreteIndices(String[] indices) Translates the provided indices (possibly aliased) into actual indices.
String[]	concreteIndices(String[] aliasesOrIndices, IgnoreIndices ignoreIndices, boolean allOnlyOpen) Translates the provided indices (possibly aliased) into actual indices.
String[]	concreteIndicesIgnoreMissing(String[] indices) Translates the provided indices (possibly aliased) into actual indices.
String[]	convertFromWildcards(String[] aliasesOrIndices, boolean wildcardOnlyOpen, IgnoreIndices ignoreIndices)
com.google.common.collect.ImmutableMap<String,MetaData.Custom>	customs()
static com.google.common.collect.ImmutableSet<String>	dynamicSettings()
String[]	filteringAliases(String index, String... indices) Iterates through the list of indices and selects the effective list of filtering aliases for the given index.
com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,AliasMetaData>>	getAliases()
String[]	getConcreteAllIndices()
String[]	getConcreteAllOpenIndices()
com.google.common.collect.ImmutableMap<String,MetaData.Custom>	getCustoms()
com.google.common.collect.ImmutableMap<String,IndexMetaData>	getIndices()
com.google.common.collect.ImmutableMap<String,IndexTemplateMetaData>	getTemplates()
int	getTotalNumberOfShards()
boolean	hasConcreteIndex(String index)
static boolean	hasDynamicSetting(String key)
boolean	hasIndex(String index)
IndexMetaData	index(String index)
com.google.common.collect.ImmutableMap<String,IndexMetaData>	indices()
static boolean	isGlobalStateEquals(MetaData metaData1, MetaData metaData2)
com.google.common.collect.UnmodifiableIterator<IndexMetaData>	iterator()
static <T extends MetaData.Custom> MetaData.Custom.Factory<T>	lookupFactory(String type)
static <T extends MetaData.Custom> MetaData.Custom.Factory<T>	lookupFactorySafe(String type)
static MetaData.Builder	newMetaDataBuilder()
Settings	persistentSettings()
static void	registerFactory(String type, MetaData.Custom.Factory factory) Register a custom index meta data factory.
String	resolveIndexRouting(String routing, String aliasOrIndex) Returns indexing routing for the given index.
Map<String,Set<String>>	resolveSearchRouting(String routing, String aliasOrIndex)
Map<String,Set<String>>	resolveSearchRouting(String routing, String[] aliasesOrIndices)
Settings	settings() Returns the merges transient and persistent settings.
com.google.common.collect.ImmutableMap<String,IndexTemplateMetaData>	templates()
int	totalNumberOfShards()
Settings	transientSettings()
long	version()

Methods inherited from class java.lang.Object

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

Field Detail

customFactories

public static Map<String,MetaData.Custom.Factory> customFactories

SETTING_READ_ONLY

public static final String SETTING_READ_ONLY

See Also:

Constant Field Values

CLUSTER_READ_ONLY_BLOCK

public static final ClusterBlock CLUSTER_READ_ONLY_BLOCK

EMPTY_META_DATA

public static final MetaData EMPTY_META_DATA

Method Detail

registerFactory

public static void registerFactory(String type,
                                   MetaData.Custom.Factory factory)

Register a custom index meta data factory. Make sure to call it from a static block.

lookupFactory

@Nullable
public static <T extends MetaData.Custom> MetaData.Custom.Factory<T> lookupFactory(String type)

lookupFactorySafe

public static <T extends MetaData.Custom> MetaData.Custom.Factory<T> lookupFactorySafe(String type)
                                                                            throws ElasticSearchIllegalArgumentException

Throws:

ElasticSearchIllegalArgumentException

dynamicSettings

public static com.google.common.collect.ImmutableSet<String> dynamicSettings()

hasDynamicSetting

public static boolean hasDynamicSetting(String key)

addDynamicSettings

public static void addDynamicSettings(String... settings)

version

public long version()

settings

public Settings settings()

Returns the merges transient and persistent settings.

transientSettings

public Settings transientSettings()

persistentSettings

public Settings persistentSettings()

aliases

public com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,AliasMetaData>> aliases()

getAliases

public com.google.common.collect.ImmutableMap<String,com.google.common.collect.ImmutableMap<String,AliasMetaData>> getAliases()

concreteAllIndices

public String[] concreteAllIndices()

Returns all the concrete indices.

concreteAllIndicesAsSet

public com.google.common.collect.ImmutableSet<String> concreteAllIndicesAsSet()

getConcreteAllIndices

public String[] getConcreteAllIndices()

concreteAllOpenIndices

public String[] concreteAllOpenIndices()

getConcreteAllOpenIndices

public String[] getConcreteAllOpenIndices()

resolveIndexRouting

public String resolveIndexRouting(@Nullable
                                  String routing,
                                  String aliasOrIndex)

Returns indexing routing for the given index.

resolveSearchRouting

public Map<String,Set<String>> resolveSearchRouting(@Nullable
                                                    String routing,
                                                    String aliasOrIndex)

resolveSearchRouting

public Map<String,Set<String>> resolveSearchRouting(@Nullable
                                                    String routing,
                                                    String[] aliasesOrIndices)

concreteIndices

public String[] concreteIndices(String[] indices)
                         throws IndexMissingException

Translates the provided indices (possibly aliased) into actual indices.

Throws:

IndexMissingException

concreteIndicesIgnoreMissing

public String[] concreteIndicesIgnoreMissing(String[] indices)

Translates the provided indices (possibly aliased) into actual indices.

concreteIndices

public String[] concreteIndices(String[] aliasesOrIndices,
                                IgnoreIndices ignoreIndices,
                                boolean allOnlyOpen)
                         throws IndexMissingException

Translates the provided indices (possibly aliased) into actual indices.

Throws:

IndexMissingException

concreteIndex

public String concreteIndex(String index)
                     throws IndexMissingException,
                            ElasticSearchIllegalArgumentException

Throws:

IndexMissingException

ElasticSearchIllegalArgumentException

convertFromWildcards

public String[] convertFromWildcards(String[] aliasesOrIndices,
                                     boolean wildcardOnlyOpen,
                                     IgnoreIndices ignoreIndices)

hasIndex

public boolean hasIndex(String index)

hasConcreteIndex

public boolean hasConcreteIndex(String index)

index

public IndexMetaData index(String index)

indices

public com.google.common.collect.ImmutableMap<String,IndexMetaData> indices()

getIndices

public com.google.common.collect.ImmutableMap<String,IndexMetaData> getIndices()

templates

public com.google.common.collect.ImmutableMap<String,IndexTemplateMetaData> templates()

getTemplates

public com.google.common.collect.ImmutableMap<String,IndexTemplateMetaData> getTemplates()

customs

public com.google.common.collect.ImmutableMap<String,MetaData.Custom> customs()

getCustoms

public com.google.common.collect.ImmutableMap<String,MetaData.Custom> getCustoms()

totalNumberOfShards

public int totalNumberOfShards()

getTotalNumberOfShards

public int getTotalNumberOfShards()

filteringAliases

public String[] filteringAliases(String index,
                                 String... indices)

Iterates through the list of indices and selects the effective list of filtering aliases for the given index.

Only aliases with filters are returned. If the indices list contains a non-filtering reference to the index itself - null is returned. Returns null if no filtering is required.

iterator

public com.google.common.collect.UnmodifiableIterator<IndexMetaData> iterator()

Specified by:

iterator in interface Iterable<IndexMetaData>

isGlobalStateEquals

public static boolean isGlobalStateEquals(MetaData metaData1,
                                          MetaData metaData2)

builder

public static MetaData.Builder builder()

newMetaDataBuilder

public static MetaData.Builder newMetaDataBuilder()