org.apache.hudi.common.model

Enum HoodieCleaningPolicy

java.lang.Object

java.lang.Enum<HoodieCleaningPolicy>

org.apache.hudi.common.model.HoodieCleaningPolicy

All Implemented Interfaces:

Serializable, Comparable<HoodieCleaningPolicy>

@EnumDescription(value="Cleaning policy to be used. The cleaner service deletes older file slices files to re-claim space. Long running query plans may often refer to older file slices and will break if those are cleaned, before the query has had a chance to run. So, it is good to make sure that the data is retained for more than the maximum query execution time. By default, the cleaning policy is determined based on one of the following configs explicitly set by the user (at most one of them can be set; otherwise, KEEP_LATEST_COMMITS cleaning policy is used).")
public enum HoodieCleaningPolicy
extends Enum<HoodieCleaningPolicy>

Hoodie cleaning policies.

Enum Constant Summary

Enum Constants

Enum Constant and Description
KEEP_LATEST_BY_HOURS
KEEP_LATEST_COMMITS
KEEP_LATEST_FILE_VERSIONS

Method Summary

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

KEEP_LATEST_FILE_VERSIONS

@EnumFieldDescription(value="keeps the last N versions of the file slices written; used when \"hoodie.clean.fileversions.retained\" is explicitly set only.")
public static final HoodieCleaningPolicy KEEP_LATEST_FILE_VERSIONS

KEEP_LATEST_COMMITS

@EnumFieldDescription(value="keeps the file slices written by the last N commits; used when \"hoodie.clean.commits.retained\" is explicitly set only.")
public static final HoodieCleaningPolicy KEEP_LATEST_COMMITS

KEEP_LATEST_BY_HOURS

@EnumFieldDescription(value="keeps the file slices written in the last N hours based on the commit time; used when \"hoodie.clean.hours.retained\" is explicitly set only.")
public static final HoodieCleaningPolicy KEEP_LATEST_BY_HOURS

Method Detail

values

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

Returns:

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

valueOf

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