public class MetaData extends java.lang.Object implements java.lang.Iterable<IndexMetaData>, Diffable<MetaData>, ToXContent
Modifier and Type | Class and Description |
---|---|
static class |
MetaData.Builder |
static interface |
MetaData.Custom |
static class |
MetaData.XContentContext |
Writeable.Reader<V>, Writeable.Writer<V>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ALL |
static java.util.EnumSet<MetaData.XContentContext> |
ALL_CONTEXTS
Indicates that this custom metadata will be returned as part of an API call, stored as a part of
a snapshot global state, and will be persisted between node restarts
|
static java.util.EnumSet<MetaData.XContentContext> |
API_AND_GATEWAY
Indicates that this custom metadata will be returned as part of an API call and will be persisted between
node restarts, but will not be a part of a snapshot global state
|
static java.util.EnumSet<MetaData.XContentContext> |
API_AND_SNAPSHOT
Indicates that this custom metadata will be returned as part of an API call and stored as a part of
a snapshot global state, but will not be persisted between node restarts
|
static java.util.EnumSet<MetaData.XContentContext> |
API_ONLY
Indicates that this custom metadata will be returned as part of an API call but will not be persisted
|
static java.util.Set<java.lang.String> |
CLUSTER_BYTES_SIZE_SETTINGS
All known byte-sized cluster settings.
|
static ClusterBlock |
CLUSTER_READ_ONLY_ALLOW_DELETE_BLOCK |
static ClusterBlock |
CLUSTER_READ_ONLY_BLOCK |
static java.util.Set<java.lang.String> |
CLUSTER_TIME_SETTINGS
All known time cluster settings.
|
static java.lang.String |
CONTEXT_MODE_GATEWAY |
static java.lang.String |
CONTEXT_MODE_PARAM |
static java.lang.String |
CONTEXT_MODE_SNAPSHOT |
static MetaData |
EMPTY_META_DATA |
static MetaDataStateFormat<MetaData> |
FORMAT
State format for
MetaData to write to and load from disk |
static java.lang.String |
GLOBAL_STATE_FILE_PREFIX |
static Setting<java.lang.Boolean> |
SETTING_READ_ONLY_ALLOW_DELETE_SETTING |
static Setting<java.lang.Boolean> |
SETTING_READ_ONLY_SETTING |
EMPTY_PARAMS
Modifier and Type | Method and Description |
---|---|
static MetaData |
addDefaultUnitsIfNeeded(org.apache.logging.log4j.Logger logger,
MetaData metaData)
As of 2.0 we require units for time and byte-sized settings.
|
static MetaData.Builder |
builder() |
static MetaData.Builder |
builder(MetaData metaData) |
java.lang.String |
clusterUUID() |
<T extends MetaData.Custom> |
custom(java.lang.String type) |
ImmutableOpenMap<java.lang.String,MetaData.Custom> |
customs() |
Diff<MetaData> |
diff(MetaData previousState)
Returns serializable object representing differences between this and previousState
|
boolean |
equalsAliases(MetaData other) |
ImmutableOpenMap<java.lang.String,java.util.List<AliasMetaData>> |
findAliases(java.lang.String[] aliases,
java.lang.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<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetaData>> |
findMappings(java.lang.String[] concreteIndices,
java.lang.String[] types) |
static MetaData |
fromXContent(XContentParser parser) |
java.util.SortedMap<java.lang.String,AliasOrIndex> |
getAliasAndIndexLookup() |
java.lang.String[] |
getConcreteAllClosedIndices() |
java.lang.String[] |
getConcreteAllIndices()
Returns all the concrete indices.
|
java.lang.String[] |
getConcreteAllOpenIndices() |
ImmutableOpenMap<java.lang.String,MetaData.Custom> |
getCustoms() |
IndexMetaData |
getIndexSafe(Index index)
Returns the
IndexMetaData for this index. |
ImmutableOpenMap<java.lang.String,IndexMetaData> |
getIndices() |
int |
getNumberOfShards() |
ImmutableOpenMap<java.lang.String,IndexTemplateMetaData> |
getTemplates() |
int |
getTotalNumberOfShards() |
boolean |
hasAlias(java.lang.String alias) |
boolean |
hasAliases(java.lang.String[] aliases,
java.lang.String[] concreteIndices)
Checks if at least one of the specified aliases exists in the specified concrete indices.
|
boolean |
hasConcreteIndex(java.lang.String index) |
boolean |
hasIndex(java.lang.String index) |
boolean |
hasIndexMetaData(IndexMetaData indexMetaData)
Returns true iff existing index has the same
IndexMetaData instance |
IndexMetaData |
index(Index index) |
IndexMetaData |
index(java.lang.String index) |
IndexGraveyard |
indexGraveyard()
The collection of index deletions in the cluster.
|
ImmutableOpenMap<java.lang.String,IndexMetaData> |
indices() |
static boolean |
isAllTypes(java.lang.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(java.lang.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) |
java.util.Iterator<IndexMetaData> |
iterator() |
Settings |
persistentSettings() |
static Diff<MetaData> |
readDiffFrom(StreamInput in) |
static MetaData |
readFrom(StreamInput in) |
java.lang.String |
resolveIndexRouting(java.lang.String parent,
java.lang.String routing,
java.lang.String aliasOrIndex)
Returns indexing routing for the given index.
|
boolean |
routingRequired(java.lang.String concreteIndex,
java.lang.String type) |
Settings |
settings()
Returns the merged transient and persistent settings.
|
ImmutableOpenMap<java.lang.String,IndexTemplateMetaData> |
templates() |
XContentBuilder |
toXContent(XContentBuilder builder,
ToXContent.Params params) |
Settings |
transientSettings() |
long |
version() |
void |
writeTo(StreamOutput out)
Write this into the StreamOutput.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
isFragment
public static final java.lang.String ALL
public static java.util.EnumSet<MetaData.XContentContext> API_ONLY
public static java.util.EnumSet<MetaData.XContentContext> API_AND_GATEWAY
public static java.util.EnumSet<MetaData.XContentContext> API_AND_SNAPSHOT
public static java.util.EnumSet<MetaData.XContentContext> ALL_CONTEXTS
public static final Setting<java.lang.Boolean> SETTING_READ_ONLY_SETTING
public static final ClusterBlock CLUSTER_READ_ONLY_BLOCK
public static final Setting<java.lang.Boolean> SETTING_READ_ONLY_ALLOW_DELETE_SETTING
public static final ClusterBlock CLUSTER_READ_ONLY_ALLOW_DELETE_BLOCK
public static final MetaData EMPTY_META_DATA
public static final java.lang.String CONTEXT_MODE_PARAM
public static final java.lang.String CONTEXT_MODE_SNAPSHOT
public static final java.lang.String CONTEXT_MODE_GATEWAY
public static final java.lang.String GLOBAL_STATE_FILE_PREFIX
public static final java.util.Set<java.lang.String> CLUSTER_BYTES_SIZE_SETTINGS
public static final java.util.Set<java.lang.String> CLUSTER_TIME_SETTINGS
public static final MetaDataStateFormat<MetaData> FORMAT
MetaData
to write to and load from diskpublic long version()
public java.lang.String clusterUUID()
public Settings settings()
public Settings transientSettings()
public Settings persistentSettings()
public boolean hasAlias(java.lang.String alias)
public boolean equalsAliases(MetaData other)
public java.util.SortedMap<java.lang.String,AliasOrIndex> getAliasAndIndexLookup()
public ImmutableOpenMap<java.lang.String,java.util.List<AliasMetaData>> findAliases(java.lang.String[] aliases, java.lang.String[] concreteIndices)
aliases
- The names of the index aliases to findconcreteIndices
- The concrete indexes the index aliases must point to order to be returned.public boolean hasAliases(java.lang.String[] aliases, java.lang.String[] concreteIndices)
aliases
- The names of the index aliases to findconcreteIndices
- The concrete indexes the index aliases must point to order to be returned.public ImmutableOpenMap<java.lang.String,ImmutableOpenMap<java.lang.String,MappingMetaData>> findMappings(java.lang.String[] concreteIndices, java.lang.String[] types)
public java.lang.String[] getConcreteAllIndices()
public java.lang.String[] getConcreteAllOpenIndices()
public java.lang.String[] getConcreteAllClosedIndices()
public java.lang.String resolveIndexRouting(@Nullable java.lang.String parent, @Nullable java.lang.String routing, java.lang.String aliasOrIndex)
public boolean hasIndex(java.lang.String index)
public boolean hasConcreteIndex(java.lang.String index)
public IndexMetaData index(java.lang.String index)
public IndexMetaData index(Index index)
public boolean hasIndexMetaData(IndexMetaData indexMetaData)
IndexMetaData
instancepublic IndexMetaData getIndexSafe(Index index)
IndexMetaData
for this index.IndexNotFoundException
- if no metadata for this index is foundpublic ImmutableOpenMap<java.lang.String,IndexMetaData> indices()
public ImmutableOpenMap<java.lang.String,IndexMetaData> getIndices()
public ImmutableOpenMap<java.lang.String,IndexTemplateMetaData> templates()
public ImmutableOpenMap<java.lang.String,IndexTemplateMetaData> getTemplates()
public ImmutableOpenMap<java.lang.String,MetaData.Custom> customs()
public ImmutableOpenMap<java.lang.String,MetaData.Custom> getCustoms()
public IndexGraveyard indexGraveyard()
public <T extends MetaData.Custom> T custom(java.lang.String type)
public int getTotalNumberOfShards()
public int getNumberOfShards()
public static boolean isAllTypes(java.lang.String[] types)
types
- the array containing typespublic static boolean isExplicitAllType(java.lang.String[] types)
types
- the array containing index namespublic boolean routingRequired(java.lang.String concreteIndex, java.lang.String type)
concreteIndex
- The concrete index to check if routing is requiredtype
- The type to check if routing is requiredpublic java.util.Iterator<IndexMetaData> iterator()
iterator
in interface java.lang.Iterable<IndexMetaData>
public static boolean isGlobalStateEquals(MetaData metaData1, MetaData metaData2)
public Diff<MetaData> diff(MetaData previousState)
Diffable
public static Diff<MetaData> readDiffFrom(StreamInput in) throws java.io.IOException
java.io.IOException
public static MetaData fromXContent(XContentParser parser) throws java.io.IOException
java.io.IOException
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
toXContent
in interface ToXContent
java.io.IOException
public static MetaData readFrom(StreamInput in) throws java.io.IOException
java.io.IOException
public void writeTo(StreamOutput out) throws java.io.IOException
Writeable
public static MetaData.Builder builder()
public static MetaData.Builder builder(MetaData metaData)