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 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 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.

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

public static final CoordinatorConfig.ClientVersionConfig CLIENT_VERSION_CONFIG_COMPATIBLE_WITH_2X

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. During the migration process, application must use ClientVersion=CLIENT_VERSION_COMPATIBLE_WITH_2x so that it runs in a compatible mode until all workers in the cluster have upgraded to the version running 3.x version (which is determined based on workers emitting WorkerMetricStats) Once all known workers are in 3.x mode, the library auto toggles to 3.x mode; but prior to that it runs in a mode compatible with 2.x workers. This version also allows rolling back to the compatible mode from the auto-toggled 3.x mode.

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. 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