IndexMetaData (Elasticsearch: Core 2.4.0 API)

java.lang.Object
- org.elasticsearch.cluster.metadata.IndexMetaData

All Implemented Interfaces:

Diffable<IndexMetaData>, StreamableReader<IndexMetaData>, Writeable<IndexMetaData>, FromXContentBuilder<IndexMetaData>, ToXContent
```
public class IndexMetaData
extends Object
implements Diffable<IndexMetaData>, FromXContentBuilder<IndexMetaData>, ToXContent
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IndexMetaData.Builder

static interface IndexMetaData.Custom

static class IndexMetaData.State
- Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested Classes
Modifier and Type	Class and Description
`static class`	`IndexMetaData.Builder`
`static interface`	`IndexMetaData.Custom`
`static class`	`IndexMetaData.State`

Field Summary

Fields
Modifier and Type	Field and Description
`static Map<String,IndexMetaData.Custom>`	`customPrototypes`
`static ClusterBlock`	`INDEX_METADATA_BLOCK`
`static ClusterBlock`	`INDEX_READ_BLOCK`
`static ClusterBlock`	`INDEX_READ_ONLY_BLOCK`
`static String`	`INDEX_SETTING_PREFIX`
`static String`	`INDEX_UUID_NA_VALUE`
`static ClusterBlock`	`INDEX_WRITE_BLOCK`
`static IndexMetaData`	`PROTO`
`static String`	`SETTING_AUTO_EXPAND_REPLICAS`
`static String`	`SETTING_BLOCKS_METADATA`
`static String`	`SETTING_BLOCKS_READ`
`static String`	`SETTING_BLOCKS_WRITE`
`static String`	`SETTING_CREATION_DATE`
`static String`	`SETTING_CREATION_DATE_STRING`
`static String`	`SETTING_DATA_PATH`
`static String`	`SETTING_INDEX_UUID`
`static String`	`SETTING_LEGACY_ROUTING_HASH_FUNCTION`
`static String`	`SETTING_LEGACY_ROUTING_USE_TYPE`
`static String`	`SETTING_NUMBER_OF_REPLICAS`
`static String`	`SETTING_NUMBER_OF_SHARDS`
`static String`	`SETTING_PRIORITY`
`static String`	`SETTING_READ_ONLY`
`static String`	`SETTING_SHADOW_REPLICAS`
`static String`	`SETTING_SHARED_FILESYSTEM`
`static String`	`SETTING_SHARED_FS_ALLOW_RECOVERY_ON_ANY_NODE`
`static String`	`SETTING_VERSION_CREATED`
`static String`	`SETTING_VERSION_CREATED_STRING`
`static String`	`SETTING_VERSION_MINIMUM_COMPATIBLE`
`static String`	`SETTING_VERSION_UPGRADED`
`static String`	`SETTING_VERSION_UPGRADED_STRING`

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

Method Summary

Methods
Modifier and Type	Method and Description
`static Settings`	`addHumanReadableSettings(Settings settings)` Adds human readable version and creation date settings.
`static IndexMetaData.Builder`	`builder(IndexMetaData indexMetaData)`
`static IndexMetaData.Builder`	`builder(String index)`
`<T extends IndexMetaData.Custom> T`	`custom(String type)`
`Diff<IndexMetaData>`	`diff(IndexMetaData previousState)` Returns serializable object representing differences between this and previousState
`boolean`	`equals(Object o)`
`DiscoveryNodeFilters`	`excludeFilters()`
`IndexMetaData`	`fromXContent(XContentParser parser, ParseFieldMatcher parseFieldMatcher)` Parses an object with the type T from parser
`ImmutableOpenMap<String,AliasMetaData>`	`getAliases()`
`long`	`getCreationDate()`
`Version`	`getCreationVersion()` Return the `Version` on which this index has been created.
`ImmutableOpenMap<String,IndexMetaData.Custom>`	`getCustoms()`
`String`	`getIndex()`
`String`	`getIndexUUID()`
`ImmutableOpenMap<String,MappingMetaData>`	`getMappings()`
`org.apache.lucene.util.Version`	`getMinimumCompatibleVersion()` Return the `Version` of the oldest lucene segment in the index
`int`	`getNumberOfReplicas()`
`int`	`getNumberOfShards()`
`HashFunction`	`getRoutingHashFunction()` Return the `HashFunction` that should be used for routing.
`boolean`	`getRoutingUseType()` Return whether routing should use the _type in addition to the _id in order to decide which shard a document should go to.
`Settings`	`getSettings()`
`IndexMetaData.State`	`getState()`
`int`	`getTotalNumberOfShards()`
`Version`	`getUpgradeVersion()` Return the `Version` on which this index has been upgraded.
`long`	`getVersion()`
`int`	`hashCode()`
`DiscoveryNodeFilters`	`includeFilters()`
`static boolean`	`isIndexUsingShadowReplicas(Settings settings)` Returns `true` iff the given settings indicate that the index associated with these settings uses shadow replicas.
`static boolean`	`isOnSharedFilesystem(Settings settings)` Returns `true` iff the given settings indicate that the index associated with these settings allocates it's shards on a shared filesystem.
`boolean`	`isSameUUID(String otherUUID)` Test whether the current index UUID is the same as the given one.
`static <T extends IndexMetaData.Custom> T`	`lookupPrototype(String type)`
`static <T extends IndexMetaData.Custom> T`	`lookupPrototypeSafe(String type)`
`MappingMetaData`	`mapping(String mappingType)`
`MappingMetaData`	`mappingOrDefault(String mappingType)` Sometimes, the default mapping exists and an actual mapping is not created yet (introduced), in this case, we want to return the default mapping in case it has some default mapping definitions.
`Diff<IndexMetaData>`	`readDiffFrom(StreamInput in)` Reads the `Diff` from StreamInput
`IndexMetaData`	`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, IndexMetaData.Custom proto)` Register a custom index meta data factory.
`DiscoveryNodeFilters`	`requireFilters()`
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`writeTo(StreamOutput out)` Writes the current object into the output stream out

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROTO
```
public static final IndexMetaData PROTO
```
  - customPrototypes
```
public static Map<String,IndexMetaData.Custom> customPrototypes
```
  - INDEX_READ_ONLY_BLOCK
```
public static final ClusterBlock INDEX_READ_ONLY_BLOCK
```
  - INDEX_READ_BLOCK
```
public static final ClusterBlock INDEX_READ_BLOCK
```
  - INDEX_WRITE_BLOCK
```
public static final ClusterBlock INDEX_WRITE_BLOCK
```
  - INDEX_METADATA_BLOCK
```
public static final ClusterBlock INDEX_METADATA_BLOCK
```
  - INDEX_SETTING_PREFIX
```
public static final String INDEX_SETTING_PREFIX
```
    See Also:
    Constant Field Values
  - SETTING_NUMBER_OF_SHARDS
```
public static final String SETTING_NUMBER_OF_SHARDS
```
    See Also:
    Constant Field Values
  - SETTING_NUMBER_OF_REPLICAS
```
public static final String SETTING_NUMBER_OF_REPLICAS
```
    See Also:
    Constant Field Values
  - SETTING_SHADOW_REPLICAS
```
public static final String SETTING_SHADOW_REPLICAS
```
    See Also:
    Constant Field Values
  - SETTING_SHARED_FILESYSTEM
```
public static final String SETTING_SHARED_FILESYSTEM
```
    See Also:
    Constant Field Values
  - SETTING_AUTO_EXPAND_REPLICAS
```
public static final String SETTING_AUTO_EXPAND_REPLICAS
```
    See Also:
    Constant Field Values
  - SETTING_READ_ONLY
```
public static final String SETTING_READ_ONLY
```
    See Also:
    Constant Field Values
  - SETTING_BLOCKS_READ
```
public static final String SETTING_BLOCKS_READ
```
    See Also:
    Constant Field Values
  - SETTING_BLOCKS_WRITE
```
public static final String SETTING_BLOCKS_WRITE
```
    See Also:
    Constant Field Values
  - SETTING_BLOCKS_METADATA
```
public static final String SETTING_BLOCKS_METADATA
```
    See Also:
    Constant Field Values
  - SETTING_VERSION_CREATED
```
public static final String SETTING_VERSION_CREATED
```
    See Also:
    Constant Field Values
  - SETTING_VERSION_CREATED_STRING
```
public static final String SETTING_VERSION_CREATED_STRING
```
    See Also:
    Constant Field Values
  - SETTING_VERSION_UPGRADED
```
public static final String SETTING_VERSION_UPGRADED
```
    See Also:
    Constant Field Values
  - SETTING_VERSION_UPGRADED_STRING
```
public static final String SETTING_VERSION_UPGRADED_STRING
```
    See Also:
    Constant Field Values
  - SETTING_VERSION_MINIMUM_COMPATIBLE
```
public static final String SETTING_VERSION_MINIMUM_COMPATIBLE
```
    See Also:
    Constant Field Values
  - SETTING_CREATION_DATE
```
public static final String SETTING_CREATION_DATE
```
    See Also:
    Constant Field Values
  - SETTING_PRIORITY
```
public static final String SETTING_PRIORITY
```
    See Also:
    Constant Field Values
  - SETTING_CREATION_DATE_STRING
```
public static final String SETTING_CREATION_DATE_STRING
```
    See Also:
    Constant Field Values
  - SETTING_INDEX_UUID
```
public static final String SETTING_INDEX_UUID
```
    See Also:
    Constant Field Values
  - SETTING_LEGACY_ROUTING_HASH_FUNCTION
```
public static final String SETTING_LEGACY_ROUTING_HASH_FUNCTION
```
    See Also:
    Constant Field Values
  - SETTING_LEGACY_ROUTING_USE_TYPE
```
public static final String SETTING_LEGACY_ROUTING_USE_TYPE
```
    See Also:
    Constant Field Values
  - SETTING_DATA_PATH
```
public static final String SETTING_DATA_PATH
```
    See Also:
    Constant Field Values
  - SETTING_SHARED_FS_ALLOW_RECOVERY_ON_ANY_NODE
```
public static final String SETTING_SHARED_FS_ALLOW_RECOVERY_ON_ANY_NODE
```
    See Also:
    Constant Field Values
  - INDEX_UUID_NA_VALUE
```
public static final String INDEX_UUID_NA_VALUE
```
    See Also:
    Constant Field Values
- Method Detail
  - registerPrototype
```
public static void registerPrototype(String type,
                     IndexMetaData.Custom proto)
```
    Register a custom index meta data factory. Make sure to call it from a static block.
  - lookupPrototype
```
@Nullable
public static <T extends IndexMetaData.Custom> T lookupPrototype(String type)
```
  - lookupPrototypeSafe
```
public static <T extends IndexMetaData.Custom> T lookupPrototypeSafe(String type)
```
  - getIndex
```
public String getIndex()
```
  - getIndexUUID
```
public String getIndexUUID()
```
  - isSameUUID
```
public boolean isSameUUID(String otherUUID)
```
    Test whether the current index UUID is the same as the given one. Returns true if either are _na_
  - getVersion
```
public long getVersion()
```
  - getCreationVersion
```
public Version getCreationVersion()
```
    Return the Version on which this index has been created. This information is typically useful for backward compatibility.
  - getUpgradeVersion
```
public Version getUpgradeVersion()
```
    Return the Version on which this index has been upgraded. This information is typically useful for backward compatibility.
  - getMinimumCompatibleVersion
```
public org.apache.lucene.util.Version getMinimumCompatibleVersion()
```
    Return the Version of the oldest lucene segment in the index
  - getRoutingHashFunction
```
public HashFunction getRoutingHashFunction()
```
    Return the HashFunction that should be used for routing.
  - getRoutingUseType
```
public boolean getRoutingUseType()
```
    Return whether routing should use the _type in addition to the _id in order to decide which shard a document should go to.
  - getCreationDate
```
public long getCreationDate()
```
  - getState
```
public IndexMetaData.State getState()
```
  - getNumberOfShards
```
public int getNumberOfShards()
```
  - getNumberOfReplicas
```
public int getNumberOfReplicas()
```
  - getTotalNumberOfShards
```
public int getTotalNumberOfShards()
```
  - getSettings
```
public Settings getSettings()
```
  - getAliases
```
public ImmutableOpenMap<String,AliasMetaData> getAliases()
```
  - getMappings
```
public ImmutableOpenMap<String,MappingMetaData> getMappings()
```
  - mapping
```
@Nullable
public MappingMetaData mapping(String mappingType)
```
  - mappingOrDefault
```
@Nullable
public MappingMetaData mappingOrDefault(String mappingType)
```
    Sometimes, the default mapping exists and an actual mapping is not created yet (introduced), in this case, we want to return the default mapping in case it has some default mapping definitions.
    Note, once the mapping type is introduced, the default mapping is applied on the actual typed MappingMetaData, setting its routing, timestamp, and so on if needed.
  - getCustoms
```
public ImmutableOpenMap<String,IndexMetaData.Custom> getCustoms()
```
  - custom
```
public <T extends IndexMetaData.Custom> T custom(String type)
```
  - requireFilters
```
@Nullable
public DiscoveryNodeFilters requireFilters()
```
  - includeFilters
```
@Nullable
public DiscoveryNodeFilters includeFilters()
```
  - excludeFilters
```
@Nullable
public DiscoveryNodeFilters excludeFilters()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - diff
```
public Diff<IndexMetaData> diff(IndexMetaData previousState)
```
    Description copied from interface: Diffable
    
    Returns serializable object representing differences between this and previousState
    
    Specified by:
    
    diff in interface Diffable<IndexMetaData>
  - readDiffFrom
```
public Diff<IndexMetaData> readDiffFrom(StreamInput in)
                                 throws IOException
```
    Description copied from interface: Diffable
    
    Reads the Diff from StreamInput
    
    Specified by:
    
    readDiffFrom in interface Diffable<IndexMetaData>
    
    Throws:
    
    IOException
  - fromXContent
```
public IndexMetaData 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<IndexMetaData>
    
    Throws:
    
    IOException
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                         ToXContent.Params params)
                           throws IOException
```
    Specified by:
    
    toXContent in interface ToXContent
    
    Throws:
    
    IOException
  - readFrom
```
public IndexMetaData 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<IndexMetaData>
    
    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<IndexMetaData>
    
    Throws:
    
    IOException
  - builder
```
public static IndexMetaData.Builder builder(String index)
```
  - builder
```
public static IndexMetaData.Builder builder(IndexMetaData indexMetaData)
```
  - isOnSharedFilesystem
```
public static boolean isOnSharedFilesystem(Settings settings)
```
    Returns true iff the given settings indicate that the index associated with these settings allocates it's shards on a shared filesystem. Otherwise false. The default setting for this is the returned value from isIndexUsingShadowReplicas(org.elasticsearch.common.settings.Settings).
  - isIndexUsingShadowReplicas
```
public static boolean isIndexUsingShadowReplicas(Settings settings)
```
    Returns true iff the given settings indicate that the index associated with these settings uses shadow replicas. Otherwise false. The default setting for this is false.
  - addHumanReadableSettings
```
public static Settings addHumanReadableSettings(Settings settings)
```
    Adds human readable version and creation date settings. This method is used to display the settings in a human readable format in REST API

Class IndexMetaData

Nested Class Summary

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

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROTO

customPrototypes

INDEX_READ_ONLY_BLOCK

INDEX_READ_BLOCK

INDEX_WRITE_BLOCK

INDEX_METADATA_BLOCK

INDEX_SETTING_PREFIX

SETTING_NUMBER_OF_SHARDS

SETTING_NUMBER_OF_REPLICAS

SETTING_SHADOW_REPLICAS

SETTING_SHARED_FILESYSTEM

SETTING_AUTO_EXPAND_REPLICAS

SETTING_READ_ONLY

SETTING_BLOCKS_READ

SETTING_BLOCKS_WRITE

SETTING_BLOCKS_METADATA

SETTING_VERSION_CREATED

SETTING_VERSION_CREATED_STRING

SETTING_VERSION_UPGRADED

SETTING_VERSION_UPGRADED_STRING

SETTING_VERSION_MINIMUM_COMPATIBLE

SETTING_CREATION_DATE

SETTING_PRIORITY

SETTING_CREATION_DATE_STRING

SETTING_INDEX_UUID

SETTING_LEGACY_ROUTING_HASH_FUNCTION

SETTING_LEGACY_ROUTING_USE_TYPE

SETTING_DATA_PATH

SETTING_SHARED_FS_ALLOW_RECOVERY_ON_ANY_NODE

INDEX_UUID_NA_VALUE

Method Detail

registerPrototype

lookupPrototype

lookupPrototypeSafe

getIndex

getIndexUUID

isSameUUID

getVersion

getCreationVersion

getUpgradeVersion

getMinimumCompatibleVersion

getRoutingHashFunction

getRoutingUseType

getCreationDate

getState

getNumberOfShards

getNumberOfReplicas

getTotalNumberOfShards

getSettings

getAliases

getMappings

mapping

mappingOrDefault

getCustoms

custom

requireFilters

includeFilters

excludeFilters

equals

hashCode

diff

readDiffFrom

fromXContent

toXContent

readFrom

writeTo

builder

builder

isOnSharedFilesystem

isIndexUsingShadowReplicas

addHumanReadableSettings