org.apache.flink.runtime.checkpoint.CheckpointOptions Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.11 Show documentation
There is a newer version: 1.13.6
/*
 * 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.checkpoint;

import org.apache.flink.annotation.VisibleForTesting;
import org.apache.flink.runtime.jobgraph.tasks.AbstractInvokable;
import org.apache.flink.runtime.state.CheckpointStorageLocationReference;

import java.io.Serializable;

import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Options for performing the checkpoint.
 *
 * The {@link CheckpointProperties} are related and cover properties that
 * are only relevant at the {@link CheckpointCoordinator}. These options are
 * relevant at the {@link AbstractInvokable} instances running on task managers.
 */
public class CheckpointOptions implements Serializable {

	private static final long serialVersionUID = 5010126558083292915L;

	/** Type of the checkpoint. */
	private final CheckpointType checkpointType;

	/** Target location for the checkpoint. */
	private final CheckpointStorageLocationReference targetLocation;

	private final boolean isExactlyOnceMode;

	private final boolean isUnalignedCheckpoint;

	@VisibleForTesting
	public CheckpointOptions(
			CheckpointType checkpointType,
			CheckpointStorageLocationReference targetLocation) {
		this(checkpointType, targetLocation, true, false);
	}

	public CheckpointOptions(
			CheckpointType checkpointType,
			CheckpointStorageLocationReference targetLocation,
			boolean isExactlyOnceMode,
			boolean isUnalignedCheckpoint) {

		this.checkpointType = checkNotNull(checkpointType);
		this.targetLocation = checkNotNull(targetLocation);
		this.isExactlyOnceMode = isExactlyOnceMode;
		this.isUnalignedCheckpoint = isUnalignedCheckpoint;
	}

	public boolean needsAlignment() {
		return isExactlyOnceMode() && (getCheckpointType().isSavepoint() || !isUnalignedCheckpoint());
	}

	// ------------------------------------------------------------------------

	/**
	 * Returns the type of checkpoint to perform.
	 */
	public CheckpointType getCheckpointType() {
		return checkpointType;
	}

	/**
	 * Returns the target location for the checkpoint.
	 */
	public CheckpointStorageLocationReference getTargetLocation() {
		return targetLocation;
	}

	public boolean isExactlyOnceMode() {
		return isExactlyOnceMode;
	}

	public boolean isUnalignedCheckpoint() {
		return isUnalignedCheckpoint;
	}

	// ------------------------------------------------------------------------

	@Override
	public int hashCode() {
		int result = 1;
		result = 31 * result + targetLocation.hashCode();
		result = 31 * result + checkpointType.hashCode();
		result = 31 * result + (isExactlyOnceMode ? 1 : 0);
		result = 31 * result + (isUnalignedCheckpoint ? 1 : 0);
		return result;
	}

	@Override
	public boolean equals(Object obj) {
		if (this == obj) {
			return true;
		}
		else if (obj != null && obj.getClass() == CheckpointOptions.class) {
			final CheckpointOptions that = (CheckpointOptions) obj;
			return this.checkpointType == that.checkpointType &&
					this.targetLocation.equals(that.targetLocation) &&
					this.isExactlyOnceMode == that.isExactlyOnceMode &&
					this.isUnalignedCheckpoint == that.isUnalignedCheckpoint;
		}
		else {
			return false;
		}
	}

	@Override
	public String toString() {
		return "CheckpointOptions {" +
			"checkpointType = " + checkpointType +
			", targetLocation = " + targetLocation +
			", isExactlyOnceMode = " + isExactlyOnceMode +
			", isUnalignedCheckpoint = " + isUnalignedCheckpoint +
			"}";
	}

	// ------------------------------------------------------------------------
	//  Factory methods
	// ------------------------------------------------------------------------

	private static final CheckpointOptions CHECKPOINT_AT_DEFAULT_LOCATION =
			new CheckpointOptions(CheckpointType.CHECKPOINT, CheckpointStorageLocationReference.getDefault());

	@VisibleForTesting
	public static CheckpointOptions forCheckpointWithDefaultLocation() {
		return CHECKPOINT_AT_DEFAULT_LOCATION;
	}

	public static CheckpointOptions forCheckpointWithDefaultLocation(
			boolean isExactlyOnceMode,
			boolean isUnalignedCheckpoint) {
		return new CheckpointOptions(
			CheckpointType.CHECKPOINT,
			CheckpointStorageLocationReference.getDefault(),
			isExactlyOnceMode,
			isUnalignedCheckpoint);
	}
}