Package org.elasticsearch.index.snapshots.blobstore

Class BlobStoreIndexShardSnapshot.FileInfo

java.lang.Object

org.elasticsearch.index.snapshots.blobstore.BlobStoreIndexShardSnapshot.FileInfo

All Implemented Interfaces:

Writeable

Enclosing class:

BlobStoreIndexShardSnapshot

public static class BlobStoreIndexShardSnapshot.FileInfo
extends Object
implements Writeable

Information about snapshotted file

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERIALIZE_WRITER_UUID

Constructor Summary

Constructors

Constructor	Description
FileInfo(String name, StoreFileMetadata metadata, ByteSizeValue partSize)	Constructs a new instance of file info
FileInfo(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static String	canonicalName(String blobName)	Returns base file name from part name
String	checksum()	Returns file md5 checksum provided by Store
static BlobStoreIndexShardSnapshot.FileInfo	fromXContent(org.elasticsearch.xcontent.XContentParser parser)	Parses JSON that represents file info
boolean	isSame(BlobStoreIndexShardSnapshot.FileInfo fileInfo)	Checks if a file in a store is the same file
boolean	isSame(StoreFileMetadata md)	Checks if a file in a store is the same file
long	length()	File length
StoreFileMetadata	metadata()	Returns the StoreFileMetadata for this file info.
String	name()	Returns the base file name
int	numberOfParts()	Returns number of parts
long	partBytes(int part)	Returns the size (in bytes) of a given part
String	partName(int part)	Returns part name if file is stored as multiple parts
ByteSizeValue	partSize()	Returns part size
String	physicalName()	Returns original file name
String	toString()
static void	toXContent(BlobStoreIndexShardSnapshot.FileInfo file, org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)	Serializes file info into JSON
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Field Details

SERIALIZE_WRITER_UUID

public static final String SERIALIZE_WRITER_UUID

See Also:

• Constant Field Values

Constructor Details

FileInfo

public FileInfo(String name,
 StoreFileMetadata metadata,
 ByteSizeValue partSize)

Constructs a new instance of file info

Parameters:

name - file name as stored in the blob store

metadata - the files meta data

partSize - size of the single chunk

FileInfo

public FileInfo(StreamInput in)
         throws IOException

Throws:

IOException

Method Details

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

name

public String name()

Returns the base file name

Returns:

file name

partName

public String partName(int part)

Returns part name if file is stored as multiple parts

Parameters:

part - part number

Returns:

part name

canonicalName

public static String canonicalName(String blobName)

Returns base file name from part name

Parameters:

blobName - part name

Returns:

base file name

physicalName

public String physicalName()

Returns original file name

Returns:

original file name

length

public long length()

File length

Returns:

file length

partSize

public ByteSizeValue partSize()

Returns part size

Returns:

part size

partBytes

public long partBytes(int part)

Returns the size (in bytes) of a given part

Returns:

the size (in bytes) of a given part

numberOfParts

public int numberOfParts()

Returns number of parts

Returns:

number of parts

checksum

public String checksum()

Returns file md5 checksum provided by Store

Returns:

file checksum

metadata

public StoreFileMetadata metadata()

Returns the StoreFileMetadata for this file info.

isSame

public boolean isSame(StoreFileMetadata md)

Checks if a file in a store is the same file

Parameters:

md - file in a store

Returns:

true if file in a store this this file have the same checksum and length

isSame

public boolean isSame(BlobStoreIndexShardSnapshot.FileInfo fileInfo)

Checks if a file in a store is the same file

Parameters:

fileInfo - file in a store

Returns:

true if file in a store this this file have the same checksum and length

toXContent

public static void toXContent(BlobStoreIndexShardSnapshot.FileInfo file,
 org.elasticsearch.xcontent.XContentBuilder builder,
 org.elasticsearch.xcontent.ToXContent.Params params)
                       throws IOException

Serializes file info into JSON

Parameters:

file - file info

builder - XContent builder

params - parameters

Throws:

IOException

fromXContent

public static BlobStoreIndexShardSnapshot.FileInfo fromXContent(org.elasticsearch.xcontent.XContentParser parser)
                                                         throws IOException

Parses JSON that represents file info

Parameters:

parser - parser

Returns:

file info

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object