org.apache.hudi.keygen.constant

Enum KeyGeneratorType

java.lang.Object

java.lang.Enum<KeyGeneratorType>

org.apache.hudi.keygen.constant.KeyGeneratorType

All Implemented Interfaces:

Serializable, Comparable<KeyGeneratorType>

@EnumDescription(value="Key generator type, indicating the key generator class to use, that implements `org.apache.hudi.keygen.KeyGenerator`.")
public enum KeyGeneratorType
extends Enum<KeyGeneratorType>

Types of KeyGenerator.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLEX
CUSTOM
GLOBAL_DELETE
NON_PARTITION
SIMPLE
TIMESTAMP

Method Summary

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

SIMPLE

@EnumFieldDescription(value="Simple key generator, which takes names of fields to be used for recordKey and partitionPath as configs.")
public static final KeyGeneratorType SIMPLE

COMPLEX

@EnumFieldDescription(value="Complex key generator, which takes names of fields to be used for recordKey and partitionPath as configs.")
public static final KeyGeneratorType COMPLEX

TIMESTAMP

@EnumFieldDescription(value="Timestamp-based key generator, that relies on timestamps for partitioning field. Still picks record key by name.")
public static final KeyGeneratorType TIMESTAMP

CUSTOM

@EnumFieldDescription(value="This is a generic implementation type of KeyGenerator where users can configure record key as a single field or  a combination of fields. Similarly partition path can be configured to have multiple fields or only one field.  This KeyGenerator expects value for prop \"hoodie.datasource.write.partitionpath.field\" in a specific format.  For example:  properties.put(\"hoodie.datasource.write.partitionpath.field\", \"field1:PartitionKeyType1,field2:PartitionKeyType2\").")
public static final KeyGeneratorType CUSTOM

NON_PARTITION

@EnumFieldDescription(value="Simple Key generator for non-partitioned tables.")
public static final KeyGeneratorType NON_PARTITION

GLOBAL_DELETE

@EnumFieldDescription(value="Key generator for deletes using global indices.")
public static final KeyGeneratorType GLOBAL_DELETE

Method Detail

values

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

Returns:

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

valueOf

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

getNames

public static List<String> getNames()