com.amazonaws.services.kinesis.leases.impl

Enum UpdateField

java.lang.Object

java.lang.Enum<UpdateField>

com.amazonaws.services.kinesis.leases.impl.UpdateField

All Implemented Interfaces:

Serializable, Comparable<UpdateField>

public enum UpdateField
extends Enum<UpdateField>

These are the special fields that will be updated only once during the lifetime of the lease. Since these are meta information that will not affect lease ownership or data durability, we allow any elected leader or worker to set these fields directly without any conditional checks. Note that though HASH_KEY_RANGE will be available during lease initialization in newer versions, we keep this for backfilling while rolling forward to newer versions.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHILD_SHARDS
HASH_KEY_RANGE

Method Summary

Modifier and Type	Method and Description
static UpdateField	valueOf(String name) Returns the enum constant of this type with the specified name.
static UpdateField[]	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

CHILD_SHARDS

public static final UpdateField CHILD_SHARDS

HASH_KEY_RANGE

public static final UpdateField HASH_KEY_RANGE

Method Detail

values

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

Returns:

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

valueOf

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