org.elasticsearch.cluster.metadata
Class MetaData

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

All Implemented Interfaces:

java.lang.Iterable<IndexMetaData>

@Immutable
public class MetaData
extends java.lang.Object
implements java.lang.Iterable<IndexMetaData>

Nested Class Summary

static class

MetaData.Builder

Field Summary

static MetaData

EMPTY_META_DATA

Method Summary

static void	addDynamicSettings(java.lang.String... settings)
org.elasticsearch.common.collect.ImmutableMap<java.lang.String,org.elasticsearch.common.collect.ImmutableMap<java.lang.String,AliasMetaData>>	aliases()
static MetaData.Builder	builder()
java.lang.String[]	concreteAllIndices() Returns all the concrete indices.
java.lang.String[]	concreteAllOpenIndices()
java.lang.String	concreteIndex(java.lang.String index)
java.lang.String[]	concreteIndices(java.lang.String[] indices) Translates the provided indices (possibly aliased) into actual indices.
java.lang.String[]	concreteIndices(java.lang.String[] indices, boolean ignoreMissing, boolean allOnlyOpen) Translates the provided indices (possibly aliased) into actual indices.
java.lang.String[]	concreteIndicesIgnoreMissing(java.lang.String[] indices) Translates the provided indices (possibly aliased) into actual indices.
static org.elasticsearch.common.collect.ImmutableSet<java.lang.String>	dynamicSettings()
java.lang.String[]	filteringAliases(java.lang.String index, java.lang.String... indices) Iterates through the list of indices and selects the effective list of filtering aliases for the given index.
org.elasticsearch.common.collect.ImmutableMap<java.lang.String,org.elasticsearch.common.collect.ImmutableMap<java.lang.String,AliasMetaData>>	getAliases()
java.lang.String[]	getConcreteAllIndices()
java.lang.String[]	getConcreteAllOpenIndices()
org.elasticsearch.common.collect.ImmutableMap<java.lang.String,IndexMetaData>	getIndices()
org.elasticsearch.common.collect.ImmutableMap<java.lang.String,IndexTemplateMetaData>	getTemplates()
int	getTotalNumberOfShards()
boolean	hasConcreteIndex(java.lang.String index)
static boolean	hasDynamicSetting(java.lang.String key)
boolean	hasIndex(java.lang.String index)
IndexMetaData	index(java.lang.String index)
org.elasticsearch.common.collect.ImmutableMap<java.lang.String,IndexMetaData>	indices()
org.elasticsearch.common.collect.UnmodifiableIterator<IndexMetaData>	iterator()
static MetaData.Builder	newMetaDataBuilder()
Settings	persistentSettings()
java.lang.String	resolveIndexRouting(java.lang.String routing, java.lang.String aliasOrIndex) Returns indexing routing for the given index.
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	resolveSearchRouting(java.lang.String routing, java.lang.String aliasOrIndex)
java.util.Map<java.lang.String,java.util.Set<java.lang.String>>	resolveSearchRouting(java.lang.String routing, java.lang.String[] aliasesOrIndices)
Settings	settings() Returns the merges transient and persistent settings.
org.elasticsearch.common.collect.ImmutableMap<java.lang.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

EMPTY_META_DATA

public static final MetaData EMPTY_META_DATA

Method Detail

dynamicSettings

public static org.elasticsearch.common.collect.ImmutableSet<java.lang.String> dynamicSettings()

hasDynamicSetting

public static boolean hasDynamicSetting(java.lang.String key)

addDynamicSettings

public static void addDynamicSettings(java.lang.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 org.elasticsearch.common.collect.ImmutableMap<java.lang.String,org.elasticsearch.common.collect.ImmutableMap<java.lang.String,AliasMetaData>> aliases()

getAliases

public org.elasticsearch.common.collect.ImmutableMap<java.lang.String,org.elasticsearch.common.collect.ImmutableMap<java.lang.String,AliasMetaData>> getAliases()

concreteAllIndices

public java.lang.String[] concreteAllIndices()

Returns all the concrete indices.

getConcreteAllIndices

public java.lang.String[] getConcreteAllIndices()

concreteAllOpenIndices

public java.lang.String[] concreteAllOpenIndices()

getConcreteAllOpenIndices

public java.lang.String[] getConcreteAllOpenIndices()

concreteIndices

public java.lang.String[] concreteIndices(java.lang.String[] indices)
                                   throws IndexMissingException

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

Throws:

IndexMissingException

concreteIndicesIgnoreMissing

public java.lang.String[] concreteIndicesIgnoreMissing(java.lang.String[] indices)

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

resolveIndexRouting

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

Returns indexing routing for the given index.

resolveSearchRouting

public java.util.Map<java.lang.String,java.util.Set<java.lang.String>> resolveSearchRouting(@Nullable
                                                                                            java.lang.String routing,
                                                                                            java.lang.String aliasOrIndex)

resolveSearchRouting

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

concreteIndices

public java.lang.String[] concreteIndices(java.lang.String[] indices,
                                          boolean ignoreMissing,
                                          boolean allOnlyOpen)
                                   throws IndexMissingException

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

Throws:

IndexMissingException

concreteIndex

public java.lang.String concreteIndex(java.lang.String index)
                               throws IndexMissingException,
                                      ElasticSearchIllegalArgumentException

Throws:

IndexMissingException

ElasticSearchIllegalArgumentException

hasIndex

public boolean hasIndex(java.lang.String index)

hasConcreteIndex

public boolean hasConcreteIndex(java.lang.String index)

index

public IndexMetaData index(java.lang.String index)

indices

public org.elasticsearch.common.collect.ImmutableMap<java.lang.String,IndexMetaData> indices()

getIndices

public org.elasticsearch.common.collect.ImmutableMap<java.lang.String,IndexMetaData> getIndices()

templates

public org.elasticsearch.common.collect.ImmutableMap<java.lang.String,IndexTemplateMetaData> templates()

getTemplates

public org.elasticsearch.common.collect.ImmutableMap<java.lang.String,IndexTemplateMetaData> getTemplates()

totalNumberOfShards

public int totalNumberOfShards()

getTotalNumberOfShards

public int getTotalNumberOfShards()

filteringAliases

public java.lang.String[] filteringAliases(java.lang.String index,
                                           java.lang.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 org.elasticsearch.common.collect.UnmodifiableIterator<IndexMetaData> iterator()

Specified by:

iterator in interface java.lang.Iterable<IndexMetaData>

builder

public static MetaData.Builder builder()

newMetaDataBuilder

public static MetaData.Builder newMetaDataBuilder()