streams.CheckpointContext Class Reference

Class that represents a checkpointing context for an operator. More...

Classes
class	Kind

Public Member Functions
def	getName (self)
	Get the optional context name. More...
def	getKind (self)
	Get the kind of checkpointing. More...
def	getCheckpointingInterval (self)
	Get the checkpointing interval. More...
def	createCheckpoint (self)
	Perform synchronous, operator-driven checkpointing. More...
def	isEnabled (self)
	Return whether checkpointing is enabled for this operator. More...

Detailed Description

Class that represents a checkpointing context for an operator.

Member Function Documentation

getName()

def streams.CheckpointContext.getName	(		self,
			str
	)

Get the optional context name.

Returns

context name

getKind()

def streams.CheckpointContext.getKind	(		self,
			Kind
	)

Get the kind of checkpointing.

Returns

the kind of checkpointing

getCheckpointingInterval()

def streams.CheckpointContext.getCheckpointingInterval	(		self,
			float
	)

Get the checkpointing interval.

Returns

checkpointing interval (<0 if the operator is not performing periodic checkpointing)

createCheckpoint()

def streams.CheckpointContext.createCheckpoint	(		self,
			bool
	)

Perform synchronous, operator-driven checkpointing.

Returns

true if checkpointing is successful; return false if checkpointing is not enabled

Exceptions

DataStoreException

if checkpointing cannot be completed successfuly

isEnabled()

def streams.CheckpointContext.isEnabled	(		self,
			bool
	)

Return whether checkpointing is enabled for this operator.

For Streams version 4.0.0.0, this function always returns true.

Returns

true if checkpointing is enabled for this operator; return false otherwise

---

The documentation for this class was generated from the following file:

• streams/__init__.py