software.amazon.kinesis.leases

Enum EntityType

java.lang.Object

java.lang.Enum<EntityType>

software.amazon.kinesis.leases.EntityType

All Implemented Interfaces:

Serializable, Comparable<EntityType>

public enum EntityType
extends Enum<EntityType>

Global enum representing all entity types that can be stored in the DynamoDB tables used by KCL (Lease table, CoordinatorState table). Each entity type has a unique DDB value that is persisted as the "entityType" attribute. This enum is persisted in storage, so any changes to it need to be backward compatible.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityType.CoordinatorStateType Subset enum for entity types that are specifically coordinator state entities.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENT_VERSION_MIGRATION Client version migration state (KCLv2.x -> KCLv3.x).
LEADER_LOCK Leader election lock entry.
LEASE Lease entities tracking shard ownership across workers.
STREAM_INFO Stream metadata tracking stream identifiers and their IDs.
TABLE_MIGRATION Table migration state (to migrate legacy coordinator and worker metrics table to lease table).
WORKER_METRIC_STATS Worker metric stats for resource-based lease assignment.

Method Summary

Modifier and Type	Method and Description
static EntityType	fromDdbValue(String ddbValue) Look up an EntityType by its DDB value.
String	getDdbValue() The string value persisted in DynamoDB as the entityType attribute.
static EntityType	valueOf(String name) Returns the enum constant of this type with the specified name.
static EntityType[]	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

LEASE

public static final EntityType LEASE

Lease entities tracking shard ownership across workers.

STREAM_INFO

public static final EntityType STREAM_INFO

Stream metadata tracking stream identifiers and their IDs.

LEADER_LOCK

public static final EntityType LEADER_LOCK

Leader election lock entry.

CLIENT_VERSION_MIGRATION

public static final EntityType CLIENT_VERSION_MIGRATION

Client version migration state (KCLv2.x -> KCLv3.x).

TABLE_MIGRATION

public static final EntityType TABLE_MIGRATION

Table migration state (to migrate legacy coordinator and worker metrics table to lease table).

WORKER_METRIC_STATS

public static final EntityType WORKER_METRIC_STATS

Worker metric stats for resource-based lease assignment.

Method Detail

values

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

Returns:

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

valueOf

public static EntityType 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

getDdbValue

public String getDdbValue()

The string value persisted in DynamoDB as the entityType attribute.

fromDdbValue

public static EntityType fromDdbValue(String ddbValue)

Look up an EntityType by its DDB value.

Parameters:

ddbValue - the value stored in DynamoDB

Returns:

the matching EntityType, or null if not found