org.apache.flink.runtime.jobgraph.SavepointConfigOptions 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.flink.runtime.jobgraph;
import org.apache.flink.annotation.PublicEvolving;
import org.apache.flink.configuration.ConfigOption;
import static org.apache.flink.configuration.ConfigOptions.key;
/** The {@link ConfigOption configuration options} used when restoring from a savepoint. */
@PublicEvolving
public class SavepointConfigOptions {
/** The path to a savepoint that will be used to bootstrap the pipeline's state. */
public static final ConfigOption SAVEPOINT_PATH =
key("execution.savepoint.path")
.stringType()
.noDefaultValue()
.withDescription(
"Path to a savepoint to restore the job from (for example hdfs:///flink/savepoint-1537).");
/**
* A flag indicating if we allow Flink to skip savepoint state that cannot be restored, e.g.
* because the corresponding operator has been removed.
*/
public static final ConfigOption SAVEPOINT_IGNORE_UNCLAIMED_STATE =
key("execution.savepoint.ignore-unclaimed-state")
.booleanType()
.defaultValue(false)
.withDescription(
"Allow to skip savepoint state that cannot be restored. "
+ "Allow this if you removed an operator from your pipeline after the savepoint was triggered.");
/**
* Describes the mode how Flink should restore from the given savepoint or retained checkpoint.
*/
public static final ConfigOption RESTORE_MODE =
key("execution.savepoint-restore-mode")
.enumType(RestoreMode.class)
.defaultValue(RestoreMode.DEFAULT)
.withDescription(
"Describes the mode how Flink should restore from the given"
+ " savepoint or retained checkpoint.");
}