org.elasticsearch.index.snapshots.blobstore

Class BlobStoreIndexShardSnapshot

java.lang.Object

org.elasticsearch.index.snapshots.blobstore.BlobStoreIndexShardSnapshot

All Implemented Interfaces:

FromXContentBuilder<BlobStoreIndexShardSnapshot>, ToXContent

public class BlobStoreIndexShardSnapshot
extends Object
implements ToXContent, FromXContentBuilder<BlobStoreIndexShardSnapshot>

Shard snapshot metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BlobStoreIndexShardSnapshot.FileInfo Information about snapshotted file

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static BlobStoreIndexShardSnapshot	PROTO

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
BlobStoreIndexShardSnapshot(String snapshot, long indexVersion, List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles, long startTime, long time, int numberOfFiles, long totalSize) Constructs new shard snapshot metadata from snapshot metadata

Method Summary

Methods

Modifier and Type	Method and Description
BlobStoreIndexShardSnapshot	fromXContent(XContentParser parser, ParseFieldMatcher parseFieldMatcher) Parses shard snapshot metadata
List<BlobStoreIndexShardSnapshot.FileInfo>	indexFiles() Returns list of files in the shard
long	indexVersion() Returns index version
int	numberOfFiles() Returns number of files that where snapshotted
String	snapshot() Returns snapshot id
long	startTime() Returns snapshot start time
long	time() Returns snapshot running time
long	totalSize() Returns total size of all files that where snapshotted
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params) Serializes shard snapshot metadata info into JSON

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROTO

public static final BlobStoreIndexShardSnapshot PROTO

Constructor Detail

BlobStoreIndexShardSnapshot

public BlobStoreIndexShardSnapshot(String snapshot,
                           long indexVersion,
                           List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles,
                           long startTime,
                           long time,
                           int numberOfFiles,
                           long totalSize)

Constructs new shard snapshot metadata from snapshot metadata

Parameters:

snapshot - snapshot id

indexVersion - index version

indexFiles - list of files in the shard

startTime - snapshot start time

time - snapshot running time

numberOfFiles - number of files that where snapshotted

totalSize - total size of all files snapshotted

Method Detail

indexVersion

public long indexVersion()

Returns index version

Returns:

index version

snapshot

public String snapshot()

Returns snapshot id

Returns:

snapshot id

indexFiles

public List<BlobStoreIndexShardSnapshot.FileInfo> indexFiles()

Returns list of files in the shard

Returns:

list of files

startTime

public long startTime()

Returns snapshot start time

time

public long time()

Returns snapshot running time

numberOfFiles

public int numberOfFiles()

Returns number of files that where snapshotted

totalSize

public long totalSize()

Returns total size of all files that where snapshotted

toXContent

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

Serializes shard snapshot metadata info into JSON

Specified by:

toXContent in interface ToXContent

Parameters:

builder - XContent builder

params - parameters

Throws:

IOException

fromXContent

public BlobStoreIndexShardSnapshot fromXContent(XContentParser parser,
                                       ParseFieldMatcher parseFieldMatcher)
                                         throws IOException

Parses shard snapshot metadata

Specified by:

fromXContent in interface FromXContentBuilder<BlobStoreIndexShardSnapshot>

Parameters:

parser - parser

Returns:

shard snapshot metadata

Throws:

IOException