org.apache.hudi.table.action.cluster

Enum ClusteringPlanPartitionFilterMode

java.lang.Object

java.lang.Enum<ClusteringPlanPartitionFilterMode>

org.apache.hudi.table.action.cluster.ClusteringPlanPartitionFilterMode

All Implemented Interfaces:

Serializable, Comparable<ClusteringPlanPartitionFilterMode>

@EnumDescription(value="Partition filter mode used in the creation of clustering plan.")
public enum ClusteringPlanPartitionFilterMode
extends Enum<ClusteringPlanPartitionFilterMode>

Clustering partition filter mode

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY_ROLLING
NONE
RECENT_DAYS
SELECTED_PARTITIONS

Method Summary

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

NONE

@EnumFieldDescription(value="Do not filter partitions. The clustering plan will include all partitions that have clustering candidates.")
public static final ClusteringPlanPartitionFilterMode NONE

RECENT_DAYS

@EnumFieldDescription(value="This filter assumes that your data is partitioned by date. The clustering plan will only include partitions from K days ago to N days ago, where K >= N. K is determined by `hoodie.clustering.plan.strategy.daybased.lookback.partitions` and N is determined by `hoodie.clustering.plan.strategy.daybased.skipfromlatest.partitions`.")
public static final ClusteringPlanPartitionFilterMode RECENT_DAYS

SELECTED_PARTITIONS

@EnumFieldDescription(value="The clustering plan will include only partition paths with names that sort within the inclusive range [`hoodie.clustering.plan.strategy.cluster.begin.partition`, `hoodie.clustering.plan.strategy.cluster.end.partition`].")
public static final ClusteringPlanPartitionFilterMode SELECTED_PARTITIONS

DAY_ROLLING

@EnumFieldDescription(value="To determine the partitions in the clustering plan, the eligible partitions will be sorted in ascending order. Each partition will have an index i in that list. The clustering plan will only contain partitions such that i mod 24 = H, where H is the current hour of the day (from 0 to 23).")
public static final ClusteringPlanPartitionFilterMode DAY_ROLLING

Method Detail

values

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

Returns:

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

valueOf

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