Package org.elasticsearch.cluster.metadata

Class Manifest

java.lang.Object

org.elasticsearch.cluster.metadata.Manifest

All Implemented Interfaces:

ToXContent, ToXContentFragment

public class Manifest
extends Object
implements ToXContentFragment

This class represents the manifest file, which is the entry point for reading meta data from disk. Metadata consists of global metadata and index metadata. When new version of metadata is written it's assigned some generation long value. Global metadata generation could be obtained by calling getGlobalGeneration(). Index metadata generation could be obtained by calling getIndexGenerations().

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static MetaDataStateFormat<Manifest>	FORMAT

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Manifest(long currentTerm, long clusterStateVersion, long globalGeneration, Map<Index,Long> indexGenerations)

Method Summary

Modifier and Type	Method	Description
static Manifest	empty()
boolean	equals(Object o)
static Manifest	fromXContent(XContentParser parser)
long	getClusterStateVersion()
long	getCurrentTerm()
long	getGlobalGeneration()	Returns global metadata generation.
Map<Index,Long>	getIndexGenerations()	Returns map from Index to index metadata generation.
int	hashCode()
boolean	isEmpty()
boolean	isGlobalGenerationMissing()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
static Manifest	unknownCurrentTermAndVersion(long globalGeneration, Map<Index,Long> indexGenerations)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

isFragment

Field Detail

FORMAT

public static final MetaDataStateFormat<Manifest> FORMAT

Constructor Detail

Manifest

public Manifest(long currentTerm,
                long clusterStateVersion,
                long globalGeneration,
                Map<Index,Long> indexGenerations)

Method Detail

unknownCurrentTermAndVersion

public static Manifest unknownCurrentTermAndVersion(long globalGeneration,
                                                    Map<Index,Long> indexGenerations)

getGlobalGeneration

public long getGlobalGeneration()

Returns global metadata generation.

getIndexGenerations

public Map<Index,Long> getIndexGenerations()

Returns map from Index to index metadata generation.

getCurrentTerm

public long getCurrentTerm()

getClusterStateVersion

public long getClusterStateVersion()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static Manifest fromXContent(XContentParser parser)
                             throws IOException

Throws:

IOException

isEmpty

public boolean isEmpty()

empty

public static Manifest empty()

isGlobalGenerationMissing

public boolean isGlobalGenerationMissing()