org.apache.flink.runtime.deployment.ResultPartitionDeploymentDescriptor Maven / Gradle / Ivy

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.deployment;

import org.apache.flink.runtime.io.network.partition.ResultPartition;
import org.apache.flink.runtime.io.network.partition.ResultPartitionType;
import org.apache.flink.runtime.jobgraph.IntermediateDataSetID;
import org.apache.flink.runtime.jobgraph.IntermediateResultPartitionID;
import org.apache.flink.runtime.shuffle.PartitionDescriptor;
import org.apache.flink.runtime.shuffle.ShuffleDescriptor;
import org.apache.flink.runtime.state.KeyGroupRangeAssignment;

import java.io.Serializable;

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

/**
 * Deployment descriptor for a result partition.
 *
 * @see ResultPartition
 */
public class ResultPartitionDeploymentDescriptor implements Serializable {

	private static final long serialVersionUID = 6343547936086963705L;

	private final PartitionDescriptor partitionDescriptor;

	private final ShuffleDescriptor shuffleDescriptor;

	private final int maxParallelism;

	/** Flag whether the result partition should send scheduleOrUpdateConsumer messages. */
	private final boolean sendScheduleOrUpdateConsumersMessage;

	public ResultPartitionDeploymentDescriptor(
			PartitionDescriptor partitionDescriptor,
			ShuffleDescriptor shuffleDescriptor,
			int maxParallelism,
			boolean sendScheduleOrUpdateConsumersMessage) {
		this.partitionDescriptor = checkNotNull(partitionDescriptor);
		this.shuffleDescriptor = checkNotNull(shuffleDescriptor);
		KeyGroupRangeAssignment.checkParallelismPreconditions(maxParallelism);
		this.maxParallelism = maxParallelism;
		this.sendScheduleOrUpdateConsumersMessage = sendScheduleOrUpdateConsumersMessage;
	}

	public IntermediateDataSetID getResultId() {
		return partitionDescriptor.getResultId();
	}

	public IntermediateResultPartitionID getPartitionId() {
		return partitionDescriptor.getPartitionId();
	}

	public ResultPartitionType getPartitionType() {
		return partitionDescriptor.getPartitionType();
	}

	public int getTotalNumberOfPartitions() {
		return partitionDescriptor.getTotalNumberOfPartitions();
	}

	public int getNumberOfSubpartitions() {
		return partitionDescriptor.getNumberOfSubpartitions();
	}

	public int getMaxParallelism() {
		return maxParallelism;
	}

	public ShuffleDescriptor getShuffleDescriptor() {
		return shuffleDescriptor;
	}

	public boolean sendScheduleOrUpdateConsumersMessage() {
		return sendScheduleOrUpdateConsumersMessage;
	}

	@Override
	public String toString() {
		return String.format("ResultPartitionDeploymentDescriptor [PartitionDescriptor: %s, "
						+ "ShuffleDescriptor: %s]",
			partitionDescriptor, shuffleDescriptor);
	}
}