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

All Implemented Interfaces:: Diffable<IndexMetaData>, Writeable, ToXContent, ToXContentFragment

public class IndexMetaData
extends Object
implements Diffable<IndexMetaData>, ToXContentFragment

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class IndexMetaData.Builder

static class IndexMetaData.State
- 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 MetaDataStateFormat<IndexMetaData>`	`FORMAT`	State format for `IndexMetaData` to write to and load from disk
`static Setting<AutoExpandReplicas>`	`INDEX_AUTO_EXPAND_REPLICAS_SETTING`
`static Setting<Boolean>`	`INDEX_BLOCKS_METADATA_SETTING`
`static Setting<Boolean>`	`INDEX_BLOCKS_READ_ONLY_ALLOW_DELETE_SETTING`
`static Setting<Boolean>`	`INDEX_BLOCKS_READ_SETTING`
`static Setting<Boolean>`	`INDEX_BLOCKS_WRITE_SETTING`
`static Setting<String>`	`INDEX_DATA_PATH_SETTING`
`static Setting<Integer>`	`INDEX_FORMAT_SETTING`
`static ClusterBlock`	`INDEX_METADATA_BLOCK`
`static Setting<Integer>`	`INDEX_NUMBER_OF_REPLICAS_SETTING`
`static Setting<Integer>`	`INDEX_NUMBER_OF_ROUTING_SHARDS_SETTING`
`static Setting<Integer>`	`INDEX_NUMBER_OF_SHARDS_SETTING`
`static Setting<Integer>`	`INDEX_PRIORITY_SETTING`
`static ClusterBlock`	`INDEX_READ_BLOCK`
`static ClusterBlock`	`INDEX_READ_ONLY_ALLOW_DELETE_BLOCK`
`static ClusterBlock`	`INDEX_READ_ONLY_BLOCK`
`static Setting<Boolean>`	`INDEX_READ_ONLY_SETTING`
`static Setting<String>`	`INDEX_RESIZE_SOURCE_NAME`
`static String`	`INDEX_RESIZE_SOURCE_NAME_KEY`
`static Setting<String>`	`INDEX_RESIZE_SOURCE_UUID`
`static String`	`INDEX_RESIZE_SOURCE_UUID_KEY`
`static String`	`INDEX_ROUTING_EXCLUDE_GROUP_PREFIX`
`static Setting.AffixSetting<String>`	`INDEX_ROUTING_EXCLUDE_GROUP_SETTING`
`static String`	`INDEX_ROUTING_INCLUDE_GROUP_PREFIX`
`static Setting.AffixSetting<String>`	`INDEX_ROUTING_INCLUDE_GROUP_SETTING`
`static Setting.AffixSetting<String>`	`INDEX_ROUTING_INITIAL_RECOVERY_GROUP_SETTING`
`static Setting<Integer>`	`INDEX_ROUTING_PARTITION_SIZE_SETTING`
`static String`	`INDEX_ROUTING_REQUIRE_GROUP_PREFIX`
`static Setting.AffixSetting<String>`	`INDEX_ROUTING_REQUIRE_GROUP_SETTING`
`static String`	`INDEX_SETTING_PREFIX`
`static String`	`INDEX_STATE_FILE_PREFIX`
`static String`	`INDEX_UUID_NA_VALUE`
`static ClusterBlock`	`INDEX_WRITE_BLOCK`
`static String`	`KEY_IN_SYNC_ALLOCATIONS`
`static String`	`KEY_PRIMARY_TERMS`
`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_PROVIDED_NAME`	The user provided name for an index.
`static String`	`SETTING_INDEX_UUID`
`static Setting<Version>`	`SETTING_INDEX_VERSION_CREATED`
`static String`	`SETTING_NUMBER_OF_REPLICAS`
`static String`	`SETTING_NUMBER_OF_SHARDS`
`static String`	`SETTING_PRIORITY`
`static String`	`SETTING_READ_ONLY`
`static String`	`SETTING_READ_ONLY_ALLOW_DELETE`
`static String`	`SETTING_ROUTING_PARTITION_SIZE`
`static String`	`SETTING_VERSION_CREATED`
`static String`	`SETTING_VERSION_CREATED_STRING`
`static String`	`SETTING_VERSION_UPGRADED`
`static String`	`SETTING_VERSION_UPGRADED_STRING`
`static Setting<ActiveShardCount>`	`SETTING_WAIT_FOR_ACTIVE_SHARDS`	The number of active shard copies to check for before proceeding with a write operation.

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static Settings`	`addHumanReadableSettings(Settings settings)`	Adds human readable version and creation date settings.
`static IndexMetaData.Builder`	`builder(String index)`
`static IndexMetaData.Builder`	`builder(IndexMetaData indexMetaData)`
`MappingMetaData`	`defaultMapping()`	Get the default mapping.
`Diff<IndexMetaData>`	`diff(IndexMetaData previousState)`	Returns serializable object representing differences between this and previousState
`boolean`	`equals(Object o)`
`DiscoveryNodeFilters`	`excludeFilters()`
`static IndexMetaData`	`fromXContent(XContentParser parser)`
`ImmutableOpenMap<String,AliasMetaData>`	`getAliases()`
`long`	`getAliasesVersion()`
`long`	`getCreationDate()`
`Version`	`getCreationVersion()`	Return the `Version` on which this index has been created.
`Map<String,String>`	`getCustomData(String key)`
`Index`	`getIndex()`
`String`	`getIndexUUID()`
`DiscoveryNodeFilters`	`getInitialRecoveryFilters()`
`ImmutableOpenIntMap<Set<String>>`	`getInSyncAllocationIds()`
`ImmutableOpenMap<String,MappingMetaData>`	`getMappings()`	Deprecated. Use `mapping()` instead now that indices have a single type
`long`	`getMappingVersion()`
`int`	`getNumberOfReplicas()`
`int`	`getNumberOfShards()`
`Index`	`getResizeSourceIndex()`
`ImmutableOpenMap<String,RolloverInfo>`	`getRolloverInfos()`
`int`	`getRoutingFactor()`	Returns the routing factor for this index.
`static int`	`getRoutingFactor(int sourceNumberOfShards, int targetNumberOfShards)`	Returns the routing factor for and shrunk index with the given number of target shards.
`int`	`getRoutingNumShards()`	Returns the number of shards that should be used for routing.
`int`	`getRoutingPartitionSize()`
`Settings`	`getSettings()`
`long`	`getSettingsVersion()`
`IndexMetaData.State`	`getState()`
`int`	`getTotalNumberOfShards()`
`Version`	`getUpgradedVersion()`	Return the `Version` on which this index has been upgraded.
`long`	`getVersion()`
`ActiveShardCount`	`getWaitForActiveShards()`	Returns the configured `SETTING_WAIT_FOR_ACTIVE_SHARDS`, which defaults to an active shard count of 1 if not specified.
`int`	`hashCode()`
`DiscoveryNodeFilters`	`includeFilters()`
`Set<String>`	`inSyncAllocationIds(int shardId)`
`boolean`	`isRoutingPartitionedIndex()`
`boolean`	`isSameUUID(String otherUUID)`	Test whether the current index UUID is the same as the given one.
`MappingMetaData`	`mapping()`	Return the concrete mapping for this index or `null` if this index has no mappings at all.
`MappingMetaData`	`mappingOrDefault()`	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.
`long`	`primaryTerm(int shardId)`	The term of the current selected primary.
`static Diff<IndexMetaData>`	`readDiffFrom(StreamInput in)`
`static IndexMetaData`	`readFrom(StreamInput in)`
`DiscoveryNodeFilters`	`requireFilters()`
`static ShardId`	`selectCloneShard(int shardId, IndexMetaData sourceIndexMetadata, int numTargetShards)`	Returns the source shard ID to clone the given target shard off
`static Set<ShardId>`	`selectRecoverFromShards(int shardId, IndexMetaData sourceIndexMetadata, int numTargetShards)`	Selects the source shards for a local shard recovery.
`static Set<ShardId>`	`selectShrinkShards(int shardId, IndexMetaData sourceIndexMetadata, int numTargetShards)`	Returns the source shard ids to shrink into the given shard id.
`static ShardId`	`selectSplitShard(int shardId, IndexMetaData sourceIndexMetadata, int numTargetShards)`	Returns the source shard ID to split the given target shard off
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`writeTo(StreamOutput out)`	Write this into the StreamOutput.

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

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

- Field Detail
  - 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_READ_ONLY_ALLOW_DELETE_BLOCK
```
public static final ClusterBlock INDEX_READ_ONLY_ALLOW_DELETE_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
  - INDEX_NUMBER_OF_SHARDS_SETTING
```
public static final Setting<Integer> INDEX_NUMBER_OF_SHARDS_SETTING
```
  - SETTING_NUMBER_OF_REPLICAS
```
public static final String SETTING_NUMBER_OF_REPLICAS
```
    See Also:
    
    Constant Field Values
  - INDEX_NUMBER_OF_REPLICAS_SETTING
```
public static final Setting<Integer> INDEX_NUMBER_OF_REPLICAS_SETTING
```
  - SETTING_ROUTING_PARTITION_SIZE
```
public static final String SETTING_ROUTING_PARTITION_SIZE
```
    See Also:
    
    Constant Field Values
  - INDEX_ROUTING_PARTITION_SIZE_SETTING
```
public static final Setting<Integer> INDEX_ROUTING_PARTITION_SIZE_SETTING
```
  - INDEX_NUMBER_OF_ROUTING_SHARDS_SETTING
```
public static final Setting<Integer> INDEX_NUMBER_OF_ROUTING_SHARDS_SETTING
```
  - SETTING_AUTO_EXPAND_REPLICAS
```
public static final String SETTING_AUTO_EXPAND_REPLICAS
```
    See Also:
    
    Constant Field Values
  - INDEX_AUTO_EXPAND_REPLICAS_SETTING
```
public static final Setting<AutoExpandReplicas> INDEX_AUTO_EXPAND_REPLICAS_SETTING
```
  - SETTING_READ_ONLY
```
public static final String SETTING_READ_ONLY
```
    See Also:
    
    Constant Field Values
  - INDEX_READ_ONLY_SETTING
```
public static final Setting<Boolean> INDEX_READ_ONLY_SETTING
```
  - SETTING_BLOCKS_READ
```
public static final String SETTING_BLOCKS_READ
```
    See Also:
    
    Constant Field Values
  - INDEX_BLOCKS_READ_SETTING
```
public static final Setting<Boolean> INDEX_BLOCKS_READ_SETTING
```
  - SETTING_BLOCKS_WRITE
```
public static final String SETTING_BLOCKS_WRITE
```
    See Also:
    
    Constant Field Values
  - INDEX_BLOCKS_WRITE_SETTING
```
public static final Setting<Boolean> INDEX_BLOCKS_WRITE_SETTING
```
  - SETTING_BLOCKS_METADATA
```
public static final String SETTING_BLOCKS_METADATA
```
    See Also:
    
    Constant Field Values
  - INDEX_BLOCKS_METADATA_SETTING
```
public static final Setting<Boolean> INDEX_BLOCKS_METADATA_SETTING
```
  - SETTING_READ_ONLY_ALLOW_DELETE
```
public static final String SETTING_READ_ONLY_ALLOW_DELETE
```
    See Also:
    
    Constant Field Values
  - INDEX_BLOCKS_READ_ONLY_ALLOW_DELETE_SETTING
```
public static final Setting<Boolean> INDEX_BLOCKS_READ_ONLY_ALLOW_DELETE_SETTING
```
  - SETTING_VERSION_CREATED
```
public static final String SETTING_VERSION_CREATED
```
    See Also:
    
    Constant Field Values
  - SETTING_INDEX_VERSION_CREATED
```
public static final Setting<Version> SETTING_INDEX_VERSION_CREATED
```
  - 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_CREATION_DATE
```
public static final String SETTING_CREATION_DATE
```
    See Also:
    
    Constant Field Values
  - SETTING_INDEX_PROVIDED_NAME
```
public static final String SETTING_INDEX_PROVIDED_NAME
```
    The user provided name for an index. This is the plain string provided by the user when the index was created. It might still contain date math expressions etc. (added in 5.0)
    
    See Also:
    
    Constant Field Values
  - SETTING_PRIORITY
```
public static final String SETTING_PRIORITY
```
    See Also:
    
    Constant Field Values
  - INDEX_PRIORITY_SETTING
```
public static final Setting<Integer> INDEX_PRIORITY_SETTING
```
  - 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_DATA_PATH
```
public static final String SETTING_DATA_PATH
```
    See Also:
    
    Constant Field Values
  - INDEX_DATA_PATH_SETTING
```
public static final Setting<String> INDEX_DATA_PATH_SETTING
```
  - INDEX_UUID_NA_VALUE
```
public static final String INDEX_UUID_NA_VALUE
```
    See Also:
    
    Constant Field Values
  - INDEX_ROUTING_REQUIRE_GROUP_PREFIX
```
public static final String INDEX_ROUTING_REQUIRE_GROUP_PREFIX
```
    See Also:
    
    Constant Field Values
  - INDEX_ROUTING_INCLUDE_GROUP_PREFIX
```
public static final String INDEX_ROUTING_INCLUDE_GROUP_PREFIX
```
    See Also:
    
    Constant Field Values
  - INDEX_ROUTING_EXCLUDE_GROUP_PREFIX
```
public static final String INDEX_ROUTING_EXCLUDE_GROUP_PREFIX
```
    See Also:
    
    Constant Field Values
  - INDEX_ROUTING_REQUIRE_GROUP_SETTING
```
public static final Setting.AffixSetting<String> INDEX_ROUTING_REQUIRE_GROUP_SETTING
```
  - INDEX_ROUTING_INCLUDE_GROUP_SETTING
```
public static final Setting.AffixSetting<String> INDEX_ROUTING_INCLUDE_GROUP_SETTING
```
  - INDEX_ROUTING_EXCLUDE_GROUP_SETTING
```
public static final Setting.AffixSetting<String> INDEX_ROUTING_EXCLUDE_GROUP_SETTING
```
  - INDEX_ROUTING_INITIAL_RECOVERY_GROUP_SETTING
```
public static final Setting.AffixSetting<String> INDEX_ROUTING_INITIAL_RECOVERY_GROUP_SETTING
```
  - SETTING_WAIT_FOR_ACTIVE_SHARDS
```
public static final Setting<ActiveShardCount> SETTING_WAIT_FOR_ACTIVE_SHARDS
```
    The number of active shard copies to check for before proceeding with a write operation.
  - INDEX_FORMAT_SETTING
```
public static final Setting<Integer> INDEX_FORMAT_SETTING
```
  - KEY_IN_SYNC_ALLOCATIONS
```
public static final String KEY_IN_SYNC_ALLOCATIONS
```
    See Also:
    
    Constant Field Values
  - KEY_PRIMARY_TERMS
```
public static final String KEY_PRIMARY_TERMS
```
    See Also:
    
    Constant Field Values
  - INDEX_STATE_FILE_PREFIX
```
public static final String INDEX_STATE_FILE_PREFIX
```
    See Also:
    
    Constant Field Values
  - INDEX_RESIZE_SOURCE_UUID_KEY
```
public static final String INDEX_RESIZE_SOURCE_UUID_KEY
```
    See Also:
    
    Constant Field Values
  - INDEX_RESIZE_SOURCE_NAME_KEY
```
public static final String INDEX_RESIZE_SOURCE_NAME_KEY
```
    See Also:
    
    Constant Field Values
  - INDEX_RESIZE_SOURCE_UUID
```
public static final Setting<String> INDEX_RESIZE_SOURCE_UUID
```
  - INDEX_RESIZE_SOURCE_NAME
```
public static final Setting<String> INDEX_RESIZE_SOURCE_NAME
```
  - FORMAT
```
public static final MetaDataStateFormat<IndexMetaData> FORMAT
```
    State format for IndexMetaData to write to and load from disk
- Method Detail
  - getIndex
```
public Index 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()
```
  - getMappingVersion
```
public long getMappingVersion()
```
  - getSettingsVersion
```
public long getSettingsVersion()
```
  - getAliasesVersion
```
public long getAliasesVersion()
```
  - primaryTerm
```
public long primaryTerm(int shardId)
```
    The term of the current selected primary. This is a non-negative number incremented when a primary shard is assigned after a full cluster restart or a replica shard is promoted to a primary. Note: since we increment the term every time a shard is assigned, the term for any operational shard (i.e., a shard that can be indexed into) is larger than 0. See IndexMetaDataUpdater.applyChanges(org.elasticsearch.cluster.metadata.MetaData, org.elasticsearch.cluster.routing.RoutingTable).
  - getCreationVersion
```
public Version getCreationVersion()
```
    Return the Version on which this index has been created. This information is typically useful for backward compatibility.
  - getUpgradedVersion
```
public Version getUpgradedVersion()
```
    Return the Version on which this index has been upgraded. This information is typically useful for backward compatibility.
  - getCreationDate
```
public long getCreationDate()
```
  - getState
```
public IndexMetaData.State getState()
```
  - getNumberOfShards
```
public int getNumberOfShards()
```
  - getNumberOfReplicas
```
public int getNumberOfReplicas()
```
  - getRoutingPartitionSize
```
public int getRoutingPartitionSize()
```
  - isRoutingPartitionedIndex
```
public boolean isRoutingPartitionedIndex()
```
  - getTotalNumberOfShards
```
public int getTotalNumberOfShards()
```
  - getWaitForActiveShards
```
public ActiveShardCount getWaitForActiveShards()
```
    Returns the configured SETTING_WAIT_FOR_ACTIVE_SHARDS, which defaults to an active shard count of 1 if not specified.
  - getSettings
```
public Settings getSettings()
```
  - getAliases
```
public ImmutableOpenMap<String,AliasMetaData> getAliases()
```
  - getMappings
```
@Deprecated
public ImmutableOpenMap<String,MappingMetaData> getMappings()
```
    Deprecated.
    Use mapping() instead now that indices have a single type
    
    Return an object that maps each type to the associated mappings. The return value is never null but may be empty if the index has no mappings.
  - mapping
```
@Nullable
public MappingMetaData mapping()
```
    Return the concrete mapping for this index or null if this index has no mappings at all.
  - defaultMapping
```
@Nullable
public MappingMetaData defaultMapping()
```
    Get the default mapping. NOTE: this is always null for 7.x indices which are disallowed to have a default mapping.
  - getResizeSourceIndex
```
public Index getResizeSourceIndex()
```
  - mappingOrDefault
```
@Nullable
public MappingMetaData mappingOrDefault()
```
    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.
  - getCustomData
```
public Map<String,String> getCustomData(String key)
```
  - getInSyncAllocationIds
```
public ImmutableOpenIntMap<Set<String>> getInSyncAllocationIds()
```
  - getRolloverInfos
```
public ImmutableOpenMap<String,RolloverInfo> getRolloverInfos()
```
  - inSyncAllocationIds
```
public Set<String> inSyncAllocationIds(int shardId)
```
  - requireFilters
```
@Nullable
public DiscoveryNodeFilters requireFilters()
```
  - getInitialRecoveryFilters
```
@Nullable
public DiscoveryNodeFilters getInitialRecoveryFilters()
```
  - 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 static Diff<IndexMetaData> readDiffFrom(StreamInput in)
                                        throws IOException
```
    Throws:
    
    IOException
  - fromXContent
```
public static IndexMetaData fromXContent(XContentParser parser)
                                  throws IOException
```
    Throws:
    
    IOException
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
    Specified by:
    
    toXContent in interface ToXContent
    
    Throws:
    
    IOException
  - readFrom
```
public static IndexMetaData readFrom(StreamInput in)
                              throws IOException
```
    Throws:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    Description copied from interface: Writeable
    
    Write this into the StreamOutput.
    
    Specified by:
    
    writeTo in interface Writeable
    
    Throws:
    
    IOException
  - builder
```
public static IndexMetaData.Builder builder(String index)
```
  - builder
```
public static IndexMetaData.Builder builder(IndexMetaData indexMetaData)
```
  - 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
  - getRoutingNumShards
```
public int getRoutingNumShards()
```
    Returns the number of shards that should be used for routing. This basically defines the hash space we use in OperationRouting.generateShardId(IndexMetaData, String, String) to route documents to shards based on their ID or their specific routing value. The default value is getNumberOfShards(). This value only changes if and index is shrunk.
  - getRoutingFactor
```
public int getRoutingFactor()
```
    Returns the routing factor for this index. The default is 1.
    
    See Also:
    
    for details
  - selectSplitShard
```
public static ShardId selectSplitShard(int shardId,
                                       IndexMetaData sourceIndexMetadata,
                                       int numTargetShards)
```
    Returns the source shard ID to split the given target shard off
    
    Parameters:
    
    shardId - the id of the target shard to split into
    
    sourceIndexMetadata - the source index metadata
    
    numTargetShards - the total number of shards in the target index
    
    Returns:
    
    a the source shard ID to split off from
  - selectCloneShard
```
public static ShardId selectCloneShard(int shardId,
                                       IndexMetaData sourceIndexMetadata,
                                       int numTargetShards)
```
    Returns the source shard ID to clone the given target shard off
    
    Parameters:
    
    shardId - the id of the target shard to clone into
    
    sourceIndexMetadata - the source index metadata
    
    numTargetShards - the total number of shards in the target index
    
    Returns:
    
    a the source shard ID to clone from
  - selectRecoverFromShards
```
public static Set<ShardId> selectRecoverFromShards(int shardId,
                                                   IndexMetaData sourceIndexMetadata,
                                                   int numTargetShards)
```
    Selects the source shards for a local shard recovery. This might either be a split or a shrink operation.
    
    Parameters:
    
    shardId - the target shard ID to select the source shards for
    
    sourceIndexMetadata - the source metadata
    
    numTargetShards - the number of target shards
  - selectShrinkShards
```
public static Set<ShardId> selectShrinkShards(int shardId,
                                              IndexMetaData sourceIndexMetadata,
                                              int numTargetShards)
```
    Returns the source shard ids to shrink into the given shard id.
    
    Parameters:
    
    shardId - the id of the target shard to shrink to
    
    sourceIndexMetadata - the source index metadata
    
    numTargetShards - the total number of shards in the target index
    
    Returns:
    
    a set of shard IDs to shrink into the given shard ID.
  - getRoutingFactor
```
public static int getRoutingFactor(int sourceNumberOfShards,
                                   int targetNumberOfShards)
```
    Returns the routing factor for and shrunk index with the given number of target shards. This factor is used in the hash function in OperationRouting.generateShardId(IndexMetaData, String, String) to guarantee consistent hashing / routing of documents even if the number of shards changed (ie. a shrunk index).
    
    Parameters:
    
    sourceNumberOfShards - the total number of shards in the source index
    
    targetNumberOfShards - the total number of shards in the target index
    
    Returns:
    
    the routing factor for and shrunk index with the given number of target shards.
    
    Throws:
    
    IllegalArgumentException - if the number of source shards is less than the number of target shards or if the source shards are not divisible by the number of target shards.

Modifier and Type	Class	Description
`static class`	`IndexMetaData.Builder`
`static class`	`IndexMetaData.State`

Class IndexMetaData

Nested Class Summary

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

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

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_READ_ONLY_BLOCK

INDEX_READ_BLOCK

INDEX_WRITE_BLOCK

INDEX_METADATA_BLOCK

INDEX_READ_ONLY_ALLOW_DELETE_BLOCK

INDEX_SETTING_PREFIX

SETTING_NUMBER_OF_SHARDS

INDEX_NUMBER_OF_SHARDS_SETTING

SETTING_NUMBER_OF_REPLICAS

INDEX_NUMBER_OF_REPLICAS_SETTING

SETTING_ROUTING_PARTITION_SIZE

INDEX_ROUTING_PARTITION_SIZE_SETTING

INDEX_NUMBER_OF_ROUTING_SHARDS_SETTING

SETTING_AUTO_EXPAND_REPLICAS

INDEX_AUTO_EXPAND_REPLICAS_SETTING

SETTING_READ_ONLY

INDEX_READ_ONLY_SETTING

SETTING_BLOCKS_READ

INDEX_BLOCKS_READ_SETTING

SETTING_BLOCKS_WRITE

INDEX_BLOCKS_WRITE_SETTING

SETTING_BLOCKS_METADATA

INDEX_BLOCKS_METADATA_SETTING

SETTING_READ_ONLY_ALLOW_DELETE

INDEX_BLOCKS_READ_ONLY_ALLOW_DELETE_SETTING

SETTING_VERSION_CREATED

SETTING_INDEX_VERSION_CREATED

SETTING_VERSION_CREATED_STRING

SETTING_VERSION_UPGRADED

SETTING_VERSION_UPGRADED_STRING

SETTING_CREATION_DATE

SETTING_INDEX_PROVIDED_NAME

SETTING_PRIORITY

INDEX_PRIORITY_SETTING

SETTING_CREATION_DATE_STRING

SETTING_INDEX_UUID

SETTING_DATA_PATH

INDEX_DATA_PATH_SETTING

INDEX_UUID_NA_VALUE

INDEX_ROUTING_REQUIRE_GROUP_PREFIX

INDEX_ROUTING_INCLUDE_GROUP_PREFIX

INDEX_ROUTING_EXCLUDE_GROUP_PREFIX

INDEX_ROUTING_REQUIRE_GROUP_SETTING

INDEX_ROUTING_INCLUDE_GROUP_SETTING

INDEX_ROUTING_EXCLUDE_GROUP_SETTING

INDEX_ROUTING_INITIAL_RECOVERY_GROUP_SETTING

SETTING_WAIT_FOR_ACTIVE_SHARDS

INDEX_FORMAT_SETTING

KEY_IN_SYNC_ALLOCATIONS

KEY_PRIMARY_TERMS

INDEX_STATE_FILE_PREFIX

INDEX_RESIZE_SOURCE_UUID_KEY

INDEX_RESIZE_SOURCE_NAME_KEY

INDEX_RESIZE_SOURCE_UUID

INDEX_RESIZE_SOURCE_NAME

FORMAT

Method Detail

getIndex

getIndexUUID

isSameUUID

getVersion

getMappingVersion

getSettingsVersion

getAliasesVersion

primaryTerm

getCreationVersion

getUpgradedVersion

getCreationDate

getState

getNumberOfShards