com.ververica.cdc.connectors.mysql.source.assigners

Enum AssignerStatus

java.lang.Object

java.lang.Enum<AssignerStatus>

com.ververica.cdc.connectors.mysql.source.assigners.AssignerStatus

All Implemented Interfaces:

Serializable, Comparable<AssignerStatus>

public enum AssignerStatus
extends Enum<AssignerStatus>

The state of split assigner finite state machine, tips: we use word status instead of word state to avoid conflict with Flink state keyword. The assigner finite state machine goes this way.

        INITIAL_ASSIGNING(start)
              |
              |
          onFinish()
              |
              ↓
    INITIAL_ASSIGNING_FINISHED(end)
              |
              |
        suspend() // found newly added tables
              |
              ↓
          SUSPENDED --- wakeup() --→ NEWLY_ADDED_ASSIGNING --- onFinish() --→ NEWLY_ADDED_ASSIGNING_FINISHED(end)
              ↑                                                                  |
              |                                                                  |
              |----------------- suspend() //found newly added tables -----------|
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
INITIAL_ASSIGNING
INITIAL_ASSIGNING_FINISHED
NEWLY_ADDED_ASSIGNING
NEWLY_ADDED_ASSIGNING_FINISHED
SUSPENDED

Method Summary

Modifier and Type	Method and Description
static AssignerStatus	fromStatusCode(int statusCode) Gets the AssignerStatus from status code.
abstract AssignerStatus	getNextStatus()
int	getStatusCode()
static boolean	isAssigning(AssignerStatus assignerStatus) Returns whether the split assigner is assigning snapshot splits.
static boolean	isAssigningFinished(AssignerStatus assignerStatus) Returns whether the split assigner has assigned all snapshot splits, which indicates there is no more splits and all records of splits have been completely processed in the pipeline.
static boolean	isInitialAssigningFinished(AssignerStatus assignerStatus) Returns whether the split assigner has finished its initial tables assignment.
static boolean	isNewlyAddedAssigning(AssignerStatus assignerStatus) Returns whether the split assigner is assigning newly added snapshot splits.
static boolean	isNewlyAddedAssigningFinished(AssignerStatus assignerStatus) Returns whether the split assigner has finished its newly added tables assignment.
static boolean	isSuspended(AssignerStatus assignerStatus) Returns whether the split assigner state is suspended.
AssignerStatus	onFinish()
AssignerStatus	suspend()
static AssignerStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static AssignerStatus[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
AssignerStatus	wakeup()

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INITIAL_ASSIGNING

public static final AssignerStatus INITIAL_ASSIGNING

INITIAL_ASSIGNING_FINISHED

public static final AssignerStatus INITIAL_ASSIGNING_FINISHED

SUSPENDED

public static final AssignerStatus SUSPENDED

NEWLY_ADDED_ASSIGNING

public static final AssignerStatus NEWLY_ADDED_ASSIGNING

NEWLY_ADDED_ASSIGNING_FINISHED

public static final AssignerStatus NEWLY_ADDED_ASSIGNING_FINISHED

Method Detail

values

public static AssignerStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AssignerStatus c : AssignerStatus.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AssignerStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getStatusCode

public int getStatusCode()

getNextStatus

public abstract AssignerStatus getNextStatus()

onFinish

public AssignerStatus onFinish()

suspend

public AssignerStatus suspend()

wakeup

public AssignerStatus wakeup()

fromStatusCode

public static AssignerStatus fromStatusCode(int statusCode)

Gets the AssignerStatus from status code.

isSuspended

public static boolean isSuspended(AssignerStatus assignerStatus)

Returns whether the split assigner state is suspended.

isAssigningFinished

public static boolean isAssigningFinished(AssignerStatus assignerStatus)

Returns whether the split assigner has assigned all snapshot splits, which indicates there is no more splits and all records of splits have been completely processed in the pipeline.

isAssigning

public static boolean isAssigning(AssignerStatus assignerStatus)

Returns whether the split assigner is assigning snapshot splits.

isNewlyAddedAssigning

public static boolean isNewlyAddedAssigning(AssignerStatus assignerStatus)

Returns whether the split assigner is assigning newly added snapshot splits.

isInitialAssigningFinished

public static boolean isInitialAssigningFinished(AssignerStatus assignerStatus)

Returns whether the split assigner has finished its initial tables assignment.

isNewlyAddedAssigningFinished

public static boolean isNewlyAddedAssigningFinished(AssignerStatus assignerStatus)

Returns whether the split assigner has finished its newly added tables assignment.