io.cdap.cdap.api.dataset.lib.partitioned

Interface ConsumablePartition

All Known Implementing Classes:

DefaultConsumablePartition

public interface ConsumablePartition

Represents a Partition available for consuming.

Method Summary

Modifier and Type	Method and Description
void	complete() Marks the ProcessState as COMPLETED
void	discard() Marks the ProcessState as DISCARDED
int	getNumFailures()
PartitionKey	getPartitionKey()
ProcessState	getProcessState()
long	getTimestamp()
int	incrementNumFailures()
void	retry() Marks the ProcessState as AVAILABLE, resets the timestamp to 0, and increments the number of failures by 1
void	setProcessState(ProcessState processState) Sets a ProcessState to this ConsumablePartition
void	setTimestamp(long timestamp) Set a timestamp on this partition, when this partition is claimed for processing.
void	take() Marks the ProcessState as IN_PROGRESS
void	untake() Marks the ProcessState as AVAILABLE, after it has been taken.

Method Detail

getPartitionKey

PartitionKey getPartitionKey()

Returns:

the PartitionKey associated with this partition

getNumFailures

int getNumFailures()

Returns:

the number of failure attempts this partition has had

incrementNumFailures

int incrementNumFailures()

Returns:

the number of failures after incrementing

getProcessState

ProcessState getProcessState()

Returns:

this ConsumablePartition's ProcessState

setProcessState

void setProcessState(ProcessState processState)

Sets a ProcessState to this ConsumablePartition

take

void take()

Marks the ProcessState as IN_PROGRESS

untake

void untake()

Marks the ProcessState as AVAILABLE, after it has been taken.

retry

void retry()

Marks the ProcessState as AVAILABLE, resets the timestamp to 0, and increments the number of failures by 1

complete

void complete()

Marks the ProcessState as COMPLETED

discard

void discard()

Marks the ProcessState as DISCARDED

getTimestamp

long getTimestamp()

Returns:

the timestamp that this partition was claimed for processing, or 0 if it is not IN_PROGRESS

setTimestamp

void setTimestamp(long timestamp)

Set a timestamp on this partition, when this partition is claimed for processing.