software.amazon.kinesis.coordinator.migration

Class TableMigrationState

java.lang.Object

software.amazon.kinesis.coordinator.CoordinatorState

software.amazon.kinesis.coordinator.migration.TableMigrationState

All Implemented Interfaces:

EntityDAO.Entity

public class TableMigrationState
extends CoordinatorState

Data model of the TableMigration state. This is used to track the state related to table migration from KCLv3.4 -> KCLv3.5+

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableMigrationState.TableMigrationStateHistoryEntry

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_BAKE_TIME_SECONDS Default bake time in seconds (60 minutes).
static String	HISTORY_ATTRIBUTE_NAME
static String	MODIFIED_BY_ATTRIBUTE_NAME
static String	MODIFIED_TIMESTAMP_ATTRIBUTE_NAME
static String	TABLE_MIGRATION_HASH_KEY Key value for the item in the CoordinatorState table
static String	TABLE_MIGRATION_STATUS_ATTRIBUTE_NAME Attribute name in migration state item, whose value is used during the KCL v3.4 -> v3.5+ table migration process to track whether the workers have completed migrating all entities to the lease table or are still performing migration operations.

Fields inherited from class software.amazon.kinesis.coordinator.CoordinatorState

ENTITY_TYPE_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
TableMigrationState(String modifiedBy)

Method Summary

Modifier and Type	Method and Description
void	addTableMigrationStateHistoryEntry(TableMigrationStatus lastTableMigrationStatus, String lastModifiedBy, long lastModifiedTimestamp)
TableMigrationState	copy()
static TableMigrationState	deserialize(String key, HashMap<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> attributes)
Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue>	getDynamoTableMigrationStatusExpectation()
Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate>	getDynamoUpdate() Produce an update map for DynamoDB UpdateItem operations.
HashMap<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue>	serialize() Serialize this state's attributes into a map of DynamoDB attribute values.
TableMigrationState	update(TableMigrationStatus tableMigrationStatus, String modifiedBy)

Methods inherited from class software.amazon.kinesis.coordinator.CoordinatorState

getEntityType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TABLE_MIGRATION_HASH_KEY

public static final String TABLE_MIGRATION_HASH_KEY

Key value for the item in the CoordinatorState table

See Also:

Constant Field Values

TABLE_MIGRATION_STATUS_ATTRIBUTE_NAME

public static final String TABLE_MIGRATION_STATUS_ATTRIBUTE_NAME

Attribute name in migration state item, whose value is used during the KCL v3.4 -> v3.5+ table migration process to track whether the workers have completed migrating all entities to the lease table or are still performing migration operations.

See Also:

Constant Field Values

MODIFIED_BY_ATTRIBUTE_NAME

public static final String MODIFIED_BY_ATTRIBUTE_NAME

See Also:

Constant Field Values

MODIFIED_TIMESTAMP_ATTRIBUTE_NAME

public static final String MODIFIED_TIMESTAMP_ATTRIBUTE_NAME

See Also:

Constant Field Values

HISTORY_ATTRIBUTE_NAME

public static final String HISTORY_ATTRIBUTE_NAME

See Also:

Constant Field Values

DEFAULT_BAKE_TIME_SECONDS

public static final long DEFAULT_BAKE_TIME_SECONDS

Default bake time in seconds (60 minutes).

Constructor Detail

TableMigrationState

public TableMigrationState(String modifiedBy)

Method Detail

serialize

public HashMap<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> serialize()

Description copied from class: CoordinatorState

Serialize this state's attributes into a map of DynamoDB attribute values. Includes the entityType attribute and any generic attributes. Subclasses should call super.serialize() and then add their own domain-specific fields.

Overrides:

serialize in class CoordinatorState

Returns:

map of attribute name to AttributeValue for DynamoDB storage

deserialize

public static TableMigrationState deserialize(String key,
                                              HashMap<String,software.amazon.awssdk.services.dynamodb.model.AttributeValue> attributes)

getDynamoTableMigrationStatusExpectation

public Map<String,software.amazon.awssdk.services.dynamodb.model.ExpectedAttributeValue> getDynamoTableMigrationStatusExpectation()

copy

public TableMigrationState copy()

update

public TableMigrationState update(TableMigrationStatus tableMigrationStatus,
                                  String modifiedBy)

addTableMigrationStateHistoryEntry

public void addTableMigrationStateHistoryEntry(TableMigrationStatus lastTableMigrationStatus,
                                               String lastModifiedBy,
                                               long lastModifiedTimestamp)

getDynamoUpdate

public Map<String,software.amazon.awssdk.services.dynamodb.model.AttributeValueUpdate> getDynamoUpdate()

Description copied from class: CoordinatorState

Produce an update map for DynamoDB UpdateItem operations. Subclasses should override this to provide their specific update logic. The base implementation converts all attributes to PUT updates.

Overrides:

getDynamoUpdate in class CoordinatorState

Returns:

map of attribute name to AttributeValueUpdate for DynamoDB UpdateItem