org.apache.hudi.common.model

Enum RecordPayloadType

java.lang.Object

java.lang.Enum<RecordPayloadType>

org.apache.hudi.common.model.RecordPayloadType

All Implemented Interfaces:

Serializable, Comparable<RecordPayloadType>

@EnumDescription(value="Payload to use for merging records")
public enum RecordPayloadType
extends Enum<RecordPayloadType>

Payload to use for record.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AWS_DMS_AVRO
CUSTOM
EVENT_TIME_AVRO
EXPRESSION_AVRO
HOODIE_AVRO
HOODIE_AVRO_DEFAULT
HOODIE_METADATA
MYSQL_DEBEZIUM_AVRO
OVERWRITE_LATEST_AVRO
OVERWRITE_NON_DEF_LATEST_AVRO
PARTIAL_UPDATE_AVRO
POSTGRES_DEBEZIUM_AVRO
VALIDATE_DUPLICATE_AVRO

Method Summary

Modifier and Type	Method and Description
static RecordPayloadType	fromClassName(String className)
String	getClassName()
static String	getPayloadClassName(HoodieConfig config)
static RecordPayloadType	valueOf(String name) Returns the enum constant of this type with the specified name.
static RecordPayloadType[]	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

AWS_DMS_AVRO

@EnumFieldDescription(value="Provides support for seamlessly applying changes captured via Amazon Database Migration Service onto S3.")
public static final RecordPayloadType AWS_DMS_AVRO

HOODIE_AVRO

@EnumFieldDescription(value="A payload to wrap a existing Hoodie Avro Record. Useful to create a HoodieRecord over existing GenericRecords.")
public static final RecordPayloadType HOODIE_AVRO

HOODIE_AVRO_DEFAULT

@EnumFieldDescription(value="Honors ordering field in both preCombine and combineAndGetUpdateValue.")
public static final RecordPayloadType HOODIE_AVRO_DEFAULT

EVENT_TIME_AVRO

@EnumFieldDescription(value="The only difference with HOODIE_AVRO_DEFAULT is that this does not track the event time metadata for efficiency")
public static final RecordPayloadType EVENT_TIME_AVRO

OVERWRITE_NON_DEF_LATEST_AVRO

@EnumFieldDescription(value="Subclass of OVERWRITE_LATEST_AVRO used for delta streamer.")
public static final RecordPayloadType OVERWRITE_NON_DEF_LATEST_AVRO

OVERWRITE_LATEST_AVRO

@EnumFieldDescription(value="Honors ordering field in preCombine and overwrites storage with latest delta record in combineAndGetUpdateValue")
public static final RecordPayloadType OVERWRITE_LATEST_AVRO

PARTIAL_UPDATE_AVRO

@EnumFieldDescription(value="Used for partial update to Hudi Table.")
public static final RecordPayloadType PARTIAL_UPDATE_AVRO

MYSQL_DEBEZIUM_AVRO

@EnumFieldDescription(value="Provides support for seamlessly applying changes captured via Debezium for MysqlDB.")
public static final RecordPayloadType MYSQL_DEBEZIUM_AVRO

POSTGRES_DEBEZIUM_AVRO

@EnumFieldDescription(value="Provides support for seamlessly applying changes captured via Debezium for PostgresDB.")
public static final RecordPayloadType POSTGRES_DEBEZIUM_AVRO

HOODIE_METADATA

@EnumFieldDescription(value="A record payload Hudi\'s internal metadata table.")
public static final RecordPayloadType HOODIE_METADATA

VALIDATE_DUPLICATE_AVRO

@EnumFieldDescription(value="A record payload to validate the duplicate key for INSERT statement in spark-sql.")
public static final RecordPayloadType VALIDATE_DUPLICATE_AVRO

EXPRESSION_AVRO

@EnumFieldDescription(value="A record payload for MERGE INTO statement in spark-sql.")
public static final RecordPayloadType EXPRESSION_AVRO

CUSTOM

@EnumFieldDescription(value="Use the payload class set in `hoodie.datasource.write.payload.class`")
public static final RecordPayloadType CUSTOM

Method Detail

values

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

Returns:

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

valueOf

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

getClassName

public String getClassName()

fromClassName

public static RecordPayloadType fromClassName(String className)

getPayloadClassName

public static String getPayloadClassName(HoodieConfig config)