org.elasticsearch.cluster.metadata

Class MetaData

java.lang.Object

org.elasticsearch.cluster.metadata.MetaData

All Implemented Interfaces:

Iterable<IndexMetaData>, Diffable<MetaData>, StreamableReader<MetaData>, Writeable<MetaData>, FromXContentBuilder<MetaData>, ToXContent

public class MetaData
extends Object
implements Iterable<IndexMetaData>, Diffable<MetaData>, FromXContentBuilder<MetaData>, ToXContent

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL
static EnumSet<MetaData.XContentContext>	API_AND_GATEWAY
static EnumSet<MetaData.XContentContext>	API_AND_SNAPSHOT
static EnumSet<MetaData.XContentContext>	API_ONLY
static Set<String>	CLUSTER_BYTES_SIZE_SETTINGS All known byte-sized cluster settings.
static ClusterBlock	CLUSTER_READ_ONLY_BLOCK
static Set<String>	CLUSTER_TIME_SETTINGS All known time cluster settings.
static String	CONTEXT_MODE_GATEWAY
static String	CONTEXT_MODE_PARAM
static String	CONTEXT_MODE_SNAPSHOT
static Map<String,MetaData.Custom>	customPrototypes
static MetaData	EMPTY_META_DATA
static MetaData	PROTO
static String	SETTING_READ_ONLY

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

EMPTY_PARAMS

Method Summary

Methods

Modifier and Type	Method and Description
static MetaData	addDefaultUnitsIfNeeded(ESLogger logger, MetaData metaData) As of 2.0 we require units for time and byte-sized settings.
static Settings	addDefaultUnitsIfNeeded(Set<String> timeSettings, Set<String> byteSettings, ESLogger logger, Settings settings) As of 2.0 we require units for time and byte-sized settings.
static MetaData.Builder	builder()
static MetaData.Builder	builder(MetaData metaData)
String	clusterUUID()
String[]	concreteAllClosedIndices()
String[]	concreteAllIndices() Returns all the concrete indices.
String[]	concreteAllOpenIndices()
<T extends MetaData.Custom> T	custom(String type)
ImmutableOpenMap<String,MetaData.Custom>	customs()
Diff<MetaData>	diff(MetaData previousState) Returns serializable object representing differences between this and previousState
boolean	equalsAliases(MetaData other)
ImmutableOpenMap<String,List<AliasMetaData>>	findAliases(String[] aliases, 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 or match partially with the indices via wildcards.
ImmutableOpenMap<String,ImmutableOpenMap<String,MappingMetaData>>	findMappings(String[] concreteIndices, String[] types)
ImmutableOpenMap<String,List<IndexWarmersMetaData.Entry>>	findWarmers(String[] concreteIndices, String[] types, String[] uncheckedWarmers)
MetaData	fromXContent(XContentParser parser, ParseFieldMatcher parseFieldMatcher) Parses an object with the type T from parser
SortedMap<String,AliasOrIndex>	getAliasAndIndexLookup()
String[]	getConcreteAllClosedIndices()
String[]	getConcreteAllIndices()
String[]	getConcreteAllOpenIndices()
ImmutableOpenMap<String,MetaData.Custom>	getCustoms()
ImmutableOpenMap<String,IndexMetaData>	getIndices()
int	getNumberOfShards()
ImmutableOpenMap<String,IndexTemplateMetaData>	getTemplates()
int	getTotalNumberOfShards()
boolean	hasAlias(String alias)
boolean	hasAliases(String[] aliases, String[] concreteIndices) Checks if at least one of the specified aliases exists in the specified concrete indices.
boolean	hasConcreteIndex(String index)
boolean	hasIndex(String index)
IndexMetaData	index(String index)
ImmutableOpenMap<String,IndexMetaData>	indices()
static boolean	isAllTypes(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(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)
com.google.common.collect.UnmodifiableIterator<IndexMetaData>	iterator()
static <T extends MetaData.Custom> T	lookupPrototype(String type)
static <T extends MetaData.Custom> T	lookupPrototypeSafe(String type)
int	numberOfShards()
Settings	persistentSettings()
Diff<MetaData>	readDiffFrom(StreamInput in) Reads the Diff from StreamInput
MetaData	readFrom(StreamInput in) Reads a copy of an object with the same type form the stream input The caller object remains unchanged.
static void	registerPrototype(String type, MetaData.Custom proto) Register a custom index meta data factory.
String	resolveIndexRouting(String routing, String aliasOrIndex) Returns indexing routing for the given index.
boolean	routingRequired(String concreteIndex, String type)
Settings	settings() Returns the merged transient and persistent settings.
ImmutableOpenMap<String,IndexTemplateMetaData>	templates()
int	totalNumberOfShards()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
Settings	transientSettings()
long	version()
void	writeTo(StreamOutput out) Writes the current object into the output stream out

Methods inherited from class java.lang.Object

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

Field Detail

PROTO

public static final MetaData PROTO

ALL

public static final String ALL

See Also:

Constant Field Values

API_ONLY

public static EnumSet<MetaData.XContentContext> API_ONLY

API_AND_GATEWAY

public static EnumSet<MetaData.XContentContext> API_AND_GATEWAY

API_AND_SNAPSHOT

public static EnumSet<MetaData.XContentContext> API_AND_SNAPSHOT

customPrototypes

public static Map<String,MetaData.Custom> customPrototypes

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

CONTEXT_MODE_PARAM

public static final String CONTEXT_MODE_PARAM

See Also:

Constant Field Values

CONTEXT_MODE_SNAPSHOT

public static final String CONTEXT_MODE_SNAPSHOT

CONTEXT_MODE_GATEWAY

public static final String CONTEXT_MODE_GATEWAY

CLUSTER_BYTES_SIZE_SETTINGS

public static final Set<String> CLUSTER_BYTES_SIZE_SETTINGS

All known byte-sized cluster settings.

CLUSTER_TIME_SETTINGS

public static final Set<String> CLUSTER_TIME_SETTINGS

All known time cluster settings.

Method Detail

registerPrototype

public static void registerPrototype(String type,
                     MetaData.Custom proto)

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

lookupPrototype

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

lookupPrototypeSafe

public static <T extends MetaData.Custom> T lookupPrototypeSafe(String type)

version

public long version()

clusterUUID

public String clusterUUID()

settings

public Settings settings()

Returns the merged transient and persistent settings.

transientSettings

public Settings transientSettings()

persistentSettings

public Settings persistentSettings()

hasAlias

public boolean hasAlias(String alias)

equalsAliases

public boolean equalsAliases(MetaData other)

getAliasAndIndexLookup

public SortedMap<String,AliasOrIndex> getAliasAndIndexLookup()

findAliases

public ImmutableOpenMap<String,List<AliasMetaData>> findAliases(String[] aliases,
                                                       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 or match partially with the indices via wildcards.

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:

the found index aliases grouped by index

hasAliases

public boolean hasAliases(String[] aliases,
                 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<String,ImmutableOpenMap<String,MappingMetaData>> findMappings(String[] concreteIndices,
                                                                             String[] types)

findWarmers

public ImmutableOpenMap<String,List<IndexWarmersMetaData.Entry>> findWarmers(String[] concreteIndices,
                                                                    String[] types,
                                                                    String[] uncheckedWarmers)

concreteAllIndices

public String[] concreteAllIndices()

Returns all the concrete indices.

getConcreteAllIndices

public String[] getConcreteAllIndices()

concreteAllOpenIndices

public String[] concreteAllOpenIndices()

getConcreteAllOpenIndices

public String[] getConcreteAllOpenIndices()

concreteAllClosedIndices

public String[] concreteAllClosedIndices()

getConcreteAllClosedIndices

public String[] getConcreteAllClosedIndices()

resolveIndexRouting

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

Returns indexing routing for the given index.

hasIndex

public boolean hasIndex(String index)

hasConcreteIndex

public boolean hasConcreteIndex(String index)

index

public IndexMetaData index(String index)

indices

public ImmutableOpenMap<String,IndexMetaData> indices()

getIndices

public ImmutableOpenMap<String,IndexMetaData> getIndices()

templates

public ImmutableOpenMap<String,IndexTemplateMetaData> templates()

getTemplates

public ImmutableOpenMap<String,IndexTemplateMetaData> getTemplates()

customs

public ImmutableOpenMap<String,MetaData.Custom> customs()

getCustoms

public ImmutableOpenMap<String,MetaData.Custom> getCustoms()

custom

public <T extends MetaData.Custom> T custom(String type)

totalNumberOfShards

public int totalNumberOfShards()

getTotalNumberOfShards

public int getTotalNumberOfShards()

numberOfShards

public int numberOfShards()

getNumberOfShards

public int getNumberOfShards()

isAllTypes

public static boolean isAllTypes(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(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(String concreteIndex,
                      String type)

Parameters:

concreteIndex - The concrete index to check if routing is required

type - The type to check if routing is required

Returns:

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

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)

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 Diff<MetaData> readDiffFrom(StreamInput in)
                            throws IOException

Description copied from interface: Diffable

Reads the Diff from StreamInput

Specified by:

readDiffFrom in interface Diffable<MetaData>

Throws:

IOException

fromXContent

public MetaData fromXContent(XContentParser parser,
                    ParseFieldMatcher parseFieldMatcher)
                      throws IOException

Description copied from interface: FromXContentBuilder

Parses an object with the type T from parser

Specified by:

fromXContent in interface FromXContentBuilder<MetaData>

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

readFrom

public MetaData readFrom(StreamInput in)
                  throws IOException

Description copied from interface: StreamableReader

Reads a copy of an object with the same type form the stream input The caller object remains unchanged.

Specified by:

readFrom in interface StreamableReader<MetaData>

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Writes the current object into the output stream out

Specified by:

writeTo in interface Writeable<MetaData>

Throws:

IOException

builder

public static MetaData.Builder builder()

builder

public static MetaData.Builder builder(MetaData metaData)

addDefaultUnitsIfNeeded

@Nullable
public static Settings addDefaultUnitsIfNeeded(Set<String> timeSettings,
                                        Set<String> byteSettings,
                                        ESLogger logger,
                                        Settings settings)

As of 2.0 we require units for time and byte-sized settings. This methods adds default units to any settings that are part of timeSettings or byteSettings and don't specify a unit.

addDefaultUnitsIfNeeded

public static MetaData addDefaultUnitsIfNeeded(ESLogger logger,
                               MetaData metaData)

As of 2.0 we require units for time and byte-sized settings. This methods adds default units to any persistent settings and template settings that don't specify a unit.