org.elasticsearch.index.snapshots.blobstore

Class BlobStoreIndexShardSnapshots

java.lang.Object

org.elasticsearch.index.snapshots.blobstore.BlobStoreIndexShardSnapshots

All Implemented Interfaces:

Iterable<SnapshotFiles>, FromXContentBuilder<BlobStoreIndexShardSnapshots>, ToXContent

public class BlobStoreIndexShardSnapshots
extends Object
implements Iterable<SnapshotFiles>, ToXContent, FromXContentBuilder<BlobStoreIndexShardSnapshots>

Contains information about all snapshot for the given shard in repository

This class is used to find files that were already snapshoted and clear out files that no longer referenced by any snapshots

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 and Description
static BlobStoreIndexShardSnapshots	PROTO

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
BlobStoreIndexShardSnapshots(List<SnapshotFiles> shardSnapshots)

Method Summary

Methods

Modifier and Type	Method and Description
BlobStoreIndexShardSnapshot.FileInfo	findNameFile(String name) Finds reference to a snapshotted file by its snapshot name
List<BlobStoreIndexShardSnapshot.FileInfo>	findPhysicalIndexFiles(String physicalName) Finds reference to a snapshotted file by its original name
BlobStoreIndexShardSnapshots	fromXContent(XContentParser parser, ParseFieldMatcher parseFieldMatcher) Parses an object with the type T from parser
Iterator<SnapshotFiles>	iterator()
List<SnapshotFiles>	snapshots() Returns list of snapshots
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params) Writes index file for the shard in the following format.

Methods inherited from class java.lang.Object

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

Field Detail

PROTO

public static final BlobStoreIndexShardSnapshots PROTO

Constructor Detail

BlobStoreIndexShardSnapshots

public BlobStoreIndexShardSnapshots(List<SnapshotFiles> shardSnapshots)

Method Detail

snapshots

public List<SnapshotFiles> snapshots()

Returns list of snapshots

Returns:

list of snapshots

findPhysicalIndexFiles

public List<BlobStoreIndexShardSnapshot.FileInfo> findPhysicalIndexFiles(String physicalName)

Finds reference to a snapshotted file by its original name

Parameters:

physicalName - original name

Returns:

a list of file infos that match specified physical file or null if the file is not present in any of snapshots

findNameFile

public BlobStoreIndexShardSnapshot.FileInfo findNameFile(String name)

Finds reference to a snapshotted file by its snapshot name

Parameters:

name - file name

Returns:

file info or null if file is not present in any of snapshots

iterator

public Iterator<SnapshotFiles> iterator()

Specified by:

iterator in interface Iterable<SnapshotFiles>

toXContent

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

Writes index file for the shard in the following format.

 
 {
     "files": [{
         "name": "__3",
         "physical_name": "_0.si",
         "length": 310,
         "checksum": "1tpsg3p",
         "written_by": "5.1.0",
         "meta_hash": "P9dsFxNMdWNlb......"
     }, {
         "name": "__2",
         "physical_name": "segments_2",
         "length": 150,
         "checksum": "11qjpz6",
         "written_by": "5.1.0",
         "meta_hash": "P9dsFwhzZWdtZ......."
     }, {
         "name": "__1",
         "physical_name": "_0.cfe",
         "length": 363,
         "checksum": "er9r9g",
         "written_by": "5.1.0"
     }, {
         "name": "__0",
         "physical_name": "_0.cfs",
         "length": 3354,
         "checksum": "491liz",
         "written_by": "5.1.0"
     }, {
         "name": "__4",
         "physical_name": "segments_3",
         "length": 150,
         "checksum": "134567",
         "written_by": "5.1.0",
         "meta_hash": "P9dsFwhzZWdtZ......."
     }],
     "snapshots": {
         "snapshot_1": {
             "files": ["__0", "__1", "__2", "__3"]
         },
         "snapshot_2": {
             "files": ["__0", "__1", "__2", "__4"]
         }
     }
 }
 }
 
 

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

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

Description copied from interface: FromXContentBuilder

Parses an object with the type T from parser

Specified by:

fromXContent in interface FromXContentBuilder<BlobStoreIndexShardSnapshots>

Throws:

IOException