org.apache.hudi.common.model

Enum HoodieFailedWritesCleaningPolicy

java.lang.Object

java.lang.Enum<HoodieFailedWritesCleaningPolicy>

org.apache.hudi.common.model.HoodieFailedWritesCleaningPolicy

All Implemented Interfaces:

Serializable, Comparable<HoodieFailedWritesCleaningPolicy>

@EnumDescription(value="Policy that controls how to clean up failed writes. Hudi will delete any files written by failed writes to re-claim space.")
public enum HoodieFailedWritesCleaningPolicy
extends Enum<HoodieFailedWritesCleaningPolicy>

Policy controlling how to perform cleaning for failed writes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAGER
LAZY
NEVER

Method Summary

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

EAGER

@EnumFieldDescription(value="Clean failed writes inline after every write operation.")
public static final HoodieFailedWritesCleaningPolicy EAGER

LAZY

@EnumFieldDescription(value="Clean failed writes lazily after heartbeat timeout when the cleaning service runs. This policy is required when multi-writers are enabled.")
public static final HoodieFailedWritesCleaningPolicy LAZY

NEVER

@EnumFieldDescription(value="Never clean failed writes.")
public static final HoodieFailedWritesCleaningPolicy NEVER

Method Detail

values

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

Returns:

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

valueOf

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

isEager

public boolean isEager()

isLazy

public boolean isLazy()

isNever

public boolean isNever()