org.apache.flink.runtime.scheduler.strategy.SchedulingResultPartition Maven / Gradle / Ivy

Go to download
/*
 * 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.strategy;

import org.apache.flink.runtime.executiongraph.IntermediateResultPartition;
import org.apache.flink.runtime.jobgraph.IntermediateDataSetID;
import org.apache.flink.runtime.jobgraph.IntermediateResultPartitionID;
import org.apache.flink.runtime.topology.Result;

import java.util.List;
import java.util.Optional;

/** Representation of {@link IntermediateResultPartition}. */
public interface SchedulingResultPartition
        extends Result<
                ExecutionVertexID,
                IntermediateResultPartitionID,
                SchedulingExecutionVertex,
                SchedulingResultPartition> {

    /**
     * Gets id of the intermediate result.
     *
     * @return id of the intermediate result
     */
    IntermediateDataSetID getResultId();

    /**
     * Gets the {@link ResultPartitionState}.
     *
     * @return result partition state
     */
    ResultPartitionState getState();

    /**
     * Gets the {@link ConsumerVertexGroup}.
     *
     * @return {@link ConsumerVertexGroup} if consumers exists, otherwise {@link Optional#empty()}.
     */
    Optional getConsumerVertexGroup();

    /**
     * Gets the {@link ConsumedPartitionGroup}s this partition belongs to.
     *
     * @return list of {@link ConsumedPartitionGroup}s
     */
    List getConsumedPartitionGroups();
}