org.apache.flink.runtime.jobmaster.JobManagerRunner Maven / Gradle / Ivy
/*
* 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.jobmaster;
import org.apache.flink.api.common.JobID;
import org.apache.flink.api.common.JobStatus;
import org.apache.flink.api.common.time.Time;
import org.apache.flink.runtime.messages.Acknowledge;
import org.apache.flink.runtime.messages.webmonitor.JobDetails;
import org.apache.flink.runtime.scheduler.ExecutionGraphInfo;
import org.apache.flink.util.AutoCloseableAsync;
import java.util.concurrent.CompletableFuture;
/** Interface for a runner which executes a {@link JobMaster}. */
public interface JobManagerRunner extends AutoCloseableAsync {
/**
* Start the execution of the {@link JobMaster}.
*
* @throws Exception if the JobMaster cannot be started
*/
void start() throws Exception;
/**
* Get the {@link JobMasterGateway} of the {@link JobMaster}. The future is only completed if
* the JobMaster becomes leader.
*
* @return Future with the JobMasterGateway once the underlying JobMaster becomes leader
*/
CompletableFuture getJobMasterGateway();
/**
* Get the result future of this runner. The future is completed once the executed job reaches a
* globally terminal state or if the initialization of the {@link JobMaster} fails. If the
* result future is completed exceptionally via {@link JobNotFinishedException}, then this
* signals that the job has not been completed successfully. All other exceptional completions
* denote an unexpected exception which leads to a process restart.
*
* @return Future which is completed with the job result
*/
CompletableFuture getResultFuture();
/**
* Get the job id of the executed job.
*
* @return job id of the executed job
*/
JobID getJobID();
/**
* Cancels the currently executed job.
*
* @param timeout of this operation
* @return Future acknowledge of the operation
*/
CompletableFuture cancel(Time timeout);
/**
* Requests the current job status.
*
* @param timeout for the rpc call
* @return Future containing the current job status
*/
CompletableFuture requestJobStatus(Time timeout);
/**
* Request the details of the executed job.
*
* @param timeout for the rpc call
* @return Future details of the executed job
*/
CompletableFuture requestJobDetails(Time timeout);
/**
* Requests the {@link ExecutionGraphInfo} of the executed job.
*
* @param timeout for the rpc call
* @return Future which is completed with the {@link ExecutionGraphInfo} of the executed job
*/
CompletableFuture requestJob(Time timeout);
/**
* Flag indicating if the JobManagerRunner has been initialized.
*
* @return true if the JobManagerRunner has been initialized.
*/
boolean isInitialized();
}