/*
 * 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.io.network.partition.hybrid.tiered.tier;

import org.apache.flink.api.common.JobID;
import org.apache.flink.runtime.io.network.partition.ResultPartitionID;

/** The master-side agent of a Tier. */
public interface TierMasterAgent {

    /** Register a job id with a {@link TierShuffleHandler}. */
    void registerJob(JobID jobID, TierShuffleHandler tierShuffleHandler);

    /** Unregister a job id. */
    void unregisterJob(JobID jobID);

    /** Add a new tiered storage partition and get the {@link TierShuffleDescriptor}. */
    TierShuffleDescriptor addPartitionAndGetShuffleDescriptor(
            JobID jobID, ResultPartitionID resultPartitionID);

    /**
     * Release a tiered storage partition.
     *
     * @param shuffleDescriptor the partition shuffle descriptor to be released
     */
    void releasePartition(TierShuffleDescriptor shuffleDescriptor);

    /** Close this tier master agent. */
    void close();
}
