程序包 org.apache.bookkeeper.mledger.offload.jcloud

接口 OffloadIndexBlock

所有超级接口:

AutoCloseable, Closeable, OffloadIndexBlockV2

所有已知实现类:

OffloadIndexBlockImpl

@Unstable
public interface OffloadIndexBlock
extends Closeable, OffloadIndexBlockV2

The Index block abstraction used for offload a ledger to long term storage.

嵌套类概要

嵌套类

修饰符和类型	接口	说明
static class	OffloadIndexBlock.IndexInputStream	An input stream which knows the size of the stream upfront.

方法概要

修饰符和类型	方法	说明
long	getDataBlockHeaderLength()	Get the length of the header in the blocks in the data object.
long	getDataObjectLength()	Get the total size of the data object.
int	getEntryCount()	Get the entry count that contained in this index Block.
OffloadIndexEntry	getIndexEntryForEntry(long messageEntryId)	Get the related OffloadIndexEntry that contains the given messageEntryId.
default OffloadIndexEntry	getIndexEntryForEntry(long ledgerId, long messageEntryId)	Get the related OffloadIndexEntry that contains the given messageEntryId.
org.apache.bookkeeper.client.api.LedgerMetadata	getLedgerMetadata()	Get LedgerMetadata.
default org.apache.bookkeeper.client.api.LedgerMetadata	getLedgerMetadata(long ledgerId)	Get LedgerMetadata.
default long	getStartEntryId(long ledgerId)
OffloadIndexBlock.IndexInputStream	toStream()	Get the content of the index block as InputStream.

从接口继承的方法 java.io.Closeable

close

方法详细资料

toStream

OffloadIndexBlock.IndexInputStream toStream()
                                     throws IOException

Get the content of the index block as InputStream. Read out in format: | index_magic_header | index_block_len | index_entry_count | | data_object_size | segment_metadata_length | segment metadata | index entries ... |

指定者:

toStream 在接口中 OffloadIndexBlockV2

抛出:

IOException

getIndexEntryForEntry

OffloadIndexEntry getIndexEntryForEntry(long messageEntryId)
                                 throws IOException

Get the related OffloadIndexEntry that contains the given messageEntryId.

参数:

messageEntryId - the entry id of message

返回:

the offload index entry

抛出:

IOException

getEntryCount

int getEntryCount()

Get the entry count that contained in this index Block.

指定者:

getEntryCount 在接口中 OffloadIndexBlockV2

getLedgerMetadata

org.apache.bookkeeper.client.api.LedgerMetadata getLedgerMetadata()

Get LedgerMetadata.

getDataObjectLength

long getDataObjectLength()

Get the total size of the data object.

指定者:

getDataObjectLength 在接口中 OffloadIndexBlockV2

getDataBlockHeaderLength

long getDataBlockHeaderLength()

Get the length of the header in the blocks in the data object.

指定者:

getDataBlockHeaderLength 在接口中 OffloadIndexBlockV2

getIndexEntryForEntry

default OffloadIndexEntry getIndexEntryForEntry(long ledgerId,
 long messageEntryId)
                                         throws IOException

从接口复制的说明: OffloadIndexBlockV2

Get the related OffloadIndexEntry that contains the given messageEntryId.

指定者:

getIndexEntryForEntry 在接口中 OffloadIndexBlockV2

messageEntryId - the entry id of message

返回:

the offload index entry

抛出:

IOException

getStartEntryId

default long getStartEntryId(long ledgerId)

指定者:

getStartEntryId 在接口中 OffloadIndexBlockV2

getLedgerMetadata

default org.apache.bookkeeper.client.api.LedgerMetadata getLedgerMetadata(long ledgerId)

从接口复制的说明: OffloadIndexBlockV2

Get LedgerMetadata.

指定者:

getLedgerMetadata 在接口中 OffloadIndexBlockV2

返回: