org.apache.hadoop.hbase.wal

Interface WALKey

All Superinterfaces:

Comparable<WALKey>, SequenceId

All Known Implementing Classes:

WALKeyImpl

@InterfaceAudience.LimitedPrivate(value={"Replication","Coprocesssor"})
public interface WALKey
extends SequenceId, Comparable<WALKey>

Key for WAL Entry.

Field Summary

Fields

Modifier and Type	Field and Description
static List<UUID>	EMPTY_UUIDS Unmodifiable empty list of UUIDs.

Fields inherited from interface org.apache.hadoop.hbase.regionserver.SequenceId

NO_SEQUENCE_ID

Method Summary

Modifier and Type	Method and Description
void	addExtendedAttribute(String attributeKey, byte[] attributeValue) Add a named String value to this WALKey to be persisted into the WAL
default long	estimatedSerializedSizeOf()
byte[]	getEncodedRegionName() Returns encoded region name
default byte[]	getExtendedAttribute(String attributeKey) Return a named String value injected into the WALKey during processing, such as by a coprocessor
default Map<String,byte[]>	getExtendedAttributes() Returns a map of all extended attributes injected into this WAL key.
default long	getNonce() Returns The nonce
default long	getNonceGroup() Returns The nonce group
UUID	getOriginatingClusterId()
long	getOrigLogSeqNum() Return a positive long if current WALKeyImpl is created from a replay edit; a replay edit is an edit that came in when replaying WALs of a crashed server.
TableName	getTableName() Returns table name
long	getWriteTime() Returns the write time
default Map<String,Object>	toStringMap() Produces a string map for this key.

Methods inherited from interface org.apache.hadoop.hbase.regionserver.SequenceId

getSequenceId

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

EMPTY_UUIDS

static final List<UUID> EMPTY_UUIDS

Unmodifiable empty list of UUIDs.

Method Detail

estimatedSerializedSizeOf

default long estimatedSerializedSizeOf()

getEncodedRegionName

byte[] getEncodedRegionName()

Returns encoded region name

getTableName

TableName getTableName()

Returns table name

getWriteTime

long getWriteTime()

Returns the write time

getNonceGroup

default long getNonceGroup()

Returns The nonce group

getNonce

default long getNonce()

Returns The nonce

getOriginatingClusterId

UUID getOriginatingClusterId()

getOrigLogSeqNum

long getOrigLogSeqNum()

Return a positive long if current WALKeyImpl is created from a replay edit; a replay edit is an edit that came in when replaying WALs of a crashed server.

Returns:

original sequence number of the WALEdit

addExtendedAttribute

void addExtendedAttribute(String attributeKey,
                          byte[] attributeValue)

Add a named String value to this WALKey to be persisted into the WAL

Parameters:

attributeKey - Name of the attribute

attributeValue - Value of the attribute

getExtendedAttribute

default byte[] getExtendedAttribute(String attributeKey)

Return a named String value injected into the WALKey during processing, such as by a coprocessor

Parameters:

attributeKey - The key of a key / value pair

getExtendedAttributes

default Map<String,byte[]> getExtendedAttributes()

Returns a map of all extended attributes injected into this WAL key.

toStringMap

default Map<String,Object> toStringMap()

Produces a string map for this key. Useful for programmatic use and manipulation of the data stored in an WALKeyImpl, for example, printing as JSON.

Returns:

a Map containing data from this key