software.amazon.kinesis.coordinator

Enum CoordinatorConfig.ClientVersionConfig

java.lang.Object

java.lang.Enum<CoordinatorConfig.ClientVersionConfig>

software.amazon.kinesis.coordinator.CoordinatorConfig.ClientVersionConfig

All Implemented Interfaces:

Serializable, Comparable<CoordinatorConfig.ClientVersionConfig>

Enclosing class:

CoordinatorConfig

public static enum CoordinatorConfig.ClientVersionConfig
extends Enum<CoordinatorConfig.ClientVersionConfig>

Version the KCL needs to operate in. For an application that was operating with previous KCLv2.x, during upgrade to KCLv3.x, a migration process is needed due to the incompatible changes between the 2 versions. The 2.x to 3.x migration uses a 3-phase deployment:

1. Phase 1 (CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X_PHASE1): Forward-compatible with non-lease entities being present in Lease table. Passive 2.x compatible mode.
2. Phase 2 (CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X): Starts the migration state machine. Stores additional KCL 3.x entities such as coordinator state, worker metrics etc in the Lease table.
3. Phase 3 (CLIENT_VERSION_CONFIG_3X): Full 3.x functionality. No rollback support. Terminal state.

For more details check the KCLv3 migration documentation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT_VERSION_CONFIG_3X A new application operating with KCLv3.x will use this value.
CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X Phase 2 of 2.x to 3.x migration.
CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X_PHASE1 Phase 1 of 2.x to 3.x migration.

Method Summary

Modifier and Type	Method and Description
static CoordinatorConfig.ClientVersionConfig	valueOf(String name) Returns the enum constant of this type with the specified name.
static CoordinatorConfig.ClientVersionConfig[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

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

CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X_PHASE1

public static final CoordinatorConfig.ClientVersionConfig CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X_PHASE1

Phase 1 of 2.x to 3.x migration. In this phase, the worker operates in pure 2.x compatible mode: deterministic leader election, lease-count-based assignment. This phase primarily offers forward-compatibility to non-lease entities being present in lease table.

CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X

public static final CoordinatorConfig.ClientVersionConfig CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X

Phase 2 of 2.x to 3.x migration. In this phase, the worker starts the migration state machine where it operates in a compatible mode to 2.x algorithms until all workers in the cluster have upgraded to the version running Phase 2 code (where it emits WorkerMetricStats). Once all known workers are 3.x compatible, the library auto toggles to 3.x mode functionality. This config allows rolling back to 2.x compatible mode from the auto-toggled 3.x mode using a KCL Migration tool.

CLIENT_VERSION_CONFIG_3X

public static final CoordinatorConfig.ClientVersionConfig CLIENT_VERSION_CONFIG_3X

A new application operating with KCLv3.x will use this value. Also, an application that has successfully upgraded to 3.x version and no longer needs the ability for a rollback to a 2.x compatible version, will use this value (i.e. phase 3 of the migration from KCL version 2.x). In this version, KCL will operate with new algorithms introduced in 3.x which is not compatible with prior versions. And once in this version, rollback to 2.x is not supported.

Method Detail

values

public static CoordinatorConfig.ClientVersionConfig[] 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 (CoordinatorConfig.ClientVersionConfig c : CoordinatorConfig.ClientVersionConfig.values())
    System.out.println(c);

Returns:

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

valueOf

public static CoordinatorConfig.ClientVersionConfig 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