org.apache.flink.runtime.scheduler.DeploymentHandle Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-runtime_2.12 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.scheduler;

import org.apache.flink.runtime.executiongraph.ExecutionVertex;
import org.apache.flink.runtime.jobmaster.LogicalSlot;
import org.apache.flink.runtime.scheduler.strategy.ExecutionVertexID;
import org.apache.flink.util.Preconditions;

import java.util.Optional;
import java.util.concurrent.CompletableFuture;

/**
 * This class is a tuple holding the information necessary to deploy an {@link ExecutionVertex}.
 *
 * The tuple consists of:
 *
 * 

 *   {@link ExecutionVertexVersion}
 *   
{@link ExecutionVertexDeploymentOption}
 *   
{@link SlotExecutionVertexAssignment}
 * 
 */
class DeploymentHandle {

    private final ExecutionVertexVersion requiredVertexVersion;

    private final ExecutionVertexDeploymentOption executionVertexDeploymentOption;

    private final SlotExecutionVertexAssignment slotExecutionVertexAssignment;

    public DeploymentHandle(
            final ExecutionVertexVersion requiredVertexVersion,
            final ExecutionVertexDeploymentOption executionVertexDeploymentOption,
            final SlotExecutionVertexAssignment slotExecutionVertexAssignment) {

        this.requiredVertexVersion = Preconditions.checkNotNull(requiredVertexVersion);
        this.executionVertexDeploymentOption =
                Preconditions.checkNotNull(executionVertexDeploymentOption);
        this.slotExecutionVertexAssignment =
                Preconditions.checkNotNull(slotExecutionVertexAssignment);
    }

    public ExecutionVertexID getExecutionVertexId() {
        return requiredVertexVersion.getExecutionVertexId();
    }

    public ExecutionVertexVersion getRequiredVertexVersion() {
        return requiredVertexVersion;
    }

    public DeploymentOption getDeploymentOption() {
        return executionVertexDeploymentOption.getDeploymentOption();
    }

    public SlotExecutionVertexAssignment getSlotExecutionVertexAssignment() {
        return slotExecutionVertexAssignment;
    }

    public Optional getLogicalSlot() {
        final CompletableFuture logicalSlotFuture =
                slotExecutionVertexAssignment.getLogicalSlotFuture();
        Preconditions.checkState(
                logicalSlotFuture.isDone(), "method can only be called after slot future is done");

        if (logicalSlotFuture.isCompletedExceptionally()) {
            return Optional.empty();
        }
        return Optional.ofNullable(logicalSlotFuture.getNow(null));
    }
}