Package org.elasticsearch.repositories

Class ShardGeneration

java.lang.Object

org.elasticsearch.repositories.ShardGeneration

All Implemented Interfaces:

Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public final class ShardGeneration
extends Object
implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment

The generation ID of a shard, used to name the shard-level index-$SHARD_GEN file that represents a BlobStoreIndexShardSnapshots instance. Before 7.6 (SnapshotsService.SHARD_GEN_IN_REPO_DATA_VERSION) these generations were numeric, but recent versions use a UUID instead.

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ShardGeneration(long legacyGeneration)	Construct a specific ShardGeneration for a repository using the legacy numeric format.
ShardGeneration(String rawGeneration)	Construct a specific ShardGeneration.
ShardGeneration(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ShardGeneration	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
int	hashCode()
static ShardGeneration	newGeneration()
static ShardGeneration	newGeneration(Random random)
String	toBlobNamePart()	Convert to a String for use in naming the index-$SHARD_GEN blob containing a BlobStoreIndexShardSnapshots.
String	toString()
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

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

Constructor Details

ShardGeneration

public ShardGeneration(String rawGeneration)

Construct a specific ShardGeneration. Doing this is generally a mistake, you should either create a new fresh one with newGeneration() or else read one from the wire with ShardGeneration(StreamInput) or fromXContent(XContentParser).

ShardGeneration

public ShardGeneration(long legacyGeneration)

Construct a specific ShardGeneration for a repository using the legacy numeric format.

ShardGeneration

public ShardGeneration(StreamInput in)
                throws IOException

Throws:

IOException

Method Details

newGeneration

public static ShardGeneration newGeneration()

Returns:

a new (fresh) shard generation.

newGeneration

public static ShardGeneration newGeneration(Random random)

Returns:

a new (fresh) shard generation generated using the given Random for repeatability in tests.

fromXContent

public static ShardGeneration fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                    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

toBlobNamePart

public String toBlobNamePart()

Convert to a String for use in naming the index-$SHARD_GEN blob containing a BlobStoreIndexShardSnapshots.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException