org.elasticsearch.index.snapshots.blobstore

クラス BlobStoreIndexShardSnapshot.FileInfo

java.lang.Object

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

含まれているクラス:

BlobStoreIndexShardSnapshot

public static class BlobStoreIndexShardSnapshot.FileInfo
extends Object

Information about snapshotted file

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
FileInfo(String name, StoreFileMetaData metaData, ByteSizeValue partSize) Constructs a new instance of file info

メソッドのサマリー

修飾子とタイプ	メソッドと説明
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(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
long	numberOfParts() Returns number of parts
long	partBytes(int part) Returns the size (in bytes) of a given part
String	partName(long part) Returns part name if file is stored as multiple parts
ByteSizeValue	partSize() Returns part size
String	physicalName() Returns original file name
static void	toXContent(BlobStoreIndexShardSnapshot.FileInfo file, XContentBuilder builder, ToXContent.Params params) Serializes file info into JSON

クラスから継承されたメソッド java.lang.Object

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

コンストラクタの詳細

FileInfo

public FileInfo(String name,
                StoreFileMetaData metaData,
                ByteSizeValue partSize)

Constructs a new instance of file info

パラメータ:

name - file name as stored in the blob store

metaData - the files meta data

partSize - size of the single chunk

メソッドの詳細

name

public String name()

Returns the base file name

戻り値:

file name

partName

public String partName(long part)

Returns part name if file is stored as multiple parts

パラメータ:

part - part number

戻り値:

part name

canonicalName

public static String canonicalName(String blobName)

Returns base file name from part name

パラメータ:

blobName - part name

戻り値:

base file name

physicalName

public String physicalName()

Returns original file name

戻り値:

original file name

length

public long length()

File length

戻り値:

file length

partSize

public ByteSizeValue partSize()

Returns part size

戻り値:

part size

partBytes

public long partBytes(int part)

Returns the size (in bytes) of a given part

戻り値:

the size (in bytes) of a given part

numberOfParts

public long numberOfParts()

Returns number of parts

戻り値:

number of parts

checksum

@Nullable
public String checksum()

Returns file md5 checksum provided by Store

戻り値:

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

パラメータ:

md - file in a store

戻り値:

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

パラメータ:

fileInfo - file in a store

戻り値:

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

toXContent

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

Serializes file info into JSON

パラメータ:

file - file info

builder - XContent builder

params - parameters

例外:

IOException

fromXContent

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

Parses JSON that represents file info

パラメータ:

parser - parser

戻り値:

file info

例外:

IOException