org.apache.flink.runtime.yarn

Class AbstractFlinkYarnCluster

java.lang.Object

org.apache.flink.runtime.yarn.AbstractFlinkYarnCluster

public abstract class AbstractFlinkYarnCluster
extends Object

Abstract class for interacting with a running Flink cluster within YARN.

Constructor Summary

Constructors

Constructor and Description
AbstractFlinkYarnCluster()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	connectToCluster() Connect the FlinkYarnCluster to the ApplicationMaster.
abstract void	disconnect() Disconnect from the ApplicationMaster without stopping the session (therefore, use the shutdown(boolean) method.
abstract String	getApplicationId() Returns a string representation of the ApplicationID assigned by YARN.
abstract FlinkYarnClusterStatus	getClusterStatus() Returns the latest cluster status, with number of Taskmanagers and slots
abstract String	getDiagnostics()
abstract Configuration	getFlinkConfiguration() Return the Flink configuration object
abstract InetSocketAddress	getJobManagerAddress() Get hostname and port of the JobManager.
abstract List<String>	getNewMessages() May return new messages from the cluster.
abstract String	getWebInterfaceURL() Returns an URL (as a string) to the JobManager web interface, running next to the ApplicationMaster and JobManager in a YARN container
abstract boolean	hasBeenStopped() Boolean indicating whether the cluster has been stopped already
abstract boolean	hasFailed() Boolean indicating whether the Flink YARN cluster is in an erronous state.
abstract boolean	isDetached() Flink's YARN cluster abstraction has two modes for connecting to the YARN AM.
abstract void	shutdown(boolean failApplication) Request the YARN cluster to shut down.
abstract void	stopAfterJob(JobID jobID) Tells the ApplicationMaster to monitor the status of JobId and stop itself once the specified job has finished.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractFlinkYarnCluster

public AbstractFlinkYarnCluster()

Method Detail

getJobManagerAddress

public abstract InetSocketAddress getJobManagerAddress()

Get hostname and port of the JobManager.

getWebInterfaceURL

public abstract String getWebInterfaceURL()

Returns an URL (as a string) to the JobManager web interface, running next to the ApplicationMaster and JobManager in a YARN container

shutdown

public abstract void shutdown(boolean failApplication)

Request the YARN cluster to shut down.

Parameters:

failApplication - If true, the application will be marked as failed in YARN

hasBeenStopped

public abstract boolean hasBeenStopped()

Boolean indicating whether the cluster has been stopped already

getClusterStatus

public abstract FlinkYarnClusterStatus getClusterStatus()

Returns the latest cluster status, with number of Taskmanagers and slots

hasFailed

public abstract boolean hasFailed()

Boolean indicating whether the Flink YARN cluster is in an erronous state.

getDiagnostics

public abstract String getDiagnostics()

Returns:

Diagnostics if the Cluster is in "failed" state.

getNewMessages

public abstract List<String> getNewMessages()

May return new messages from the cluster. Messages can be for example about failed containers or container launch requests.

getApplicationId

public abstract String getApplicationId()

Returns a string representation of the ApplicationID assigned by YARN.

isDetached

public abstract boolean isDetached()

Flink's YARN cluster abstraction has two modes for connecting to the YARN AM. In the detached mode, the AM is launched and the Flink YARN client is disconnecting afterwards. In the non-detached mode, it maintains a connection with the AM to control the cluster.

Returns:

boolean indicating whether the cluster is a detached cluster

connectToCluster

public abstract void connectToCluster()
                               throws IOException

Connect the FlinkYarnCluster to the ApplicationMaster. Detached YARN sessions don't need to connect to the ApplicationMaster. Detached per job YARN sessions need to connect until the required number of TaskManagers have been started.

Throws:

IOException

disconnect

public abstract void disconnect()

Disconnect from the ApplicationMaster without stopping the session (therefore, use the shutdown(boolean) method.

See Also:

shutdown(boolean)

stopAfterJob

public abstract void stopAfterJob(JobID jobID)

Tells the ApplicationMaster to monitor the status of JobId and stop itself once the specified job has finished.

Parameters:

jobID - Id of the job

getFlinkConfiguration

public abstract Configuration getFlinkConfiguration()

Return the Flink configuration object

Returns:

The Flink configuration object