org.apache.flink.runtime.messages.JobClientMessages.scala 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.messages
import java.util.UUID
import akka.actor.ActorRef
import org.apache.flink.api.common.JobID
import org.apache.flink.runtime.jobgraph.JobGraph
/**
* This object contains the [[org.apache.flink.runtime.client.JobClient]] specific messages
*/
object JobClientMessages {
/**
* This message is sent to the JobClientActor (via ask) to submit a job and
* get a response when the job execution has finished.
*
* The response to this message is a
* [[org.apache.flink.runtime.client.SerializedJobExecutionResult]]
*
* @param jobGraph The job to be executed.
*/
case class SubmitJobAndWait(jobGraph: JobGraph)
/**
* This message is sent to the JobClientActor to ask it to register at the JobManager
* and then return once the job execution is complete.
* @param jobID The job id
*/
case class AttachToJobAndWait(jobID: JobID)
/** Notifies the JobClientActor about a new leader address and a leader session ID.
*
* @param address New leader address
* @param leaderSessionID New leader session ID
*/
case class JobManagerLeaderAddress(address: String, leaderSessionID: UUID)
/** Notifies the JobClientActor about the ActorRef of the new leader.
*
* @param jobManager ActorRef of the new leader
*/
case class JobManagerActorRef(jobManager: ActorRef) extends RequiresLeaderSessionID
/** Message which is triggered when the submission timeout has been reached. */
case object SubmissionTimeout extends RequiresLeaderSessionID
/** Message which is triggered when the JobClient registration at the JobManager times out */
case object RegistrationTimeout extends RequiresLeaderSessionID
/**
* Message which is triggered when the connection timeout has been reached.
*
* @param id Timeout id which identifies the concurrent timeouts
*/
case class ConnectionTimeout(id: UUID)
def getSubmissionTimeout(): AnyRef = SubmissionTimeout
def getRegistrationTimeout(): AnyRef = RegistrationTimeout
}