org.apache.hudi.common.model.HoodieFailedWritesCleaningPolicy Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.hudi.common.model;
import org.apache.hudi.common.config.EnumDescription;
import org.apache.hudi.common.config.EnumFieldDescription;
/**
* Policy controlling how to perform cleaning for failed writes.
*/
@EnumDescription("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 {
// performs cleaning of failed writes inline every write operation
@EnumFieldDescription("Clean failed writes inline after every write operation.")
EAGER,
// performs cleaning of failed writes lazily during clean
@EnumFieldDescription("Clean failed writes lazily after heartbeat timeout when the cleaning "
+ "service runs. This policy is required when multi-writers are enabled.")
LAZY,
// Does not clean failed writes
@EnumFieldDescription("Never clean failed writes.")
NEVER;
public boolean isEager() {
return this == EAGER;
}
public boolean isLazy() {
return this == LAZY;
}
public boolean isNever() {
return this == NEVER;
}
}