org.apache.flink.client.program

Class StandaloneClusterClient

java.lang.Object

org.apache.flink.client.program.ClusterClient<StandaloneClusterId>

org.apache.flink.client.program.StandaloneClusterClient

public class StandaloneClusterClient
extends ClusterClient<StandaloneClusterId>

Cluster client for communication with an standalone (on-premise) cluster or an existing cluster that has been brought up independently of a specific job.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.flink.client.program.ClusterClient

ClusterClient.LazyActorSystemLoader

Field Summary

Fields inherited from class org.apache.flink.client.program.ClusterClient

actorSystemLoader, flinkConfig, highAvailabilityServices, lastJobExecutionResult, log, MAX_SLOTS_UNKNOWN, timeout

Constructor Summary

Constructors

Constructor and Description
StandaloneClusterClient(org.apache.flink.configuration.Configuration config)
StandaloneClusterClient(org.apache.flink.configuration.Configuration config, org.apache.flink.runtime.highavailability.HighAvailabilityServices highAvailabilityServices, boolean sharedHaServices)
StandaloneClusterClient(org.apache.flink.configuration.Configuration config, org.apache.flink.runtime.highavailability.HighAvailabilityServices highAvailabilityServices, boolean sharedHaServices, ActorSystemLoader actorSystemLoader)

Method Summary

Modifier and Type	Method and Description
StandaloneClusterId	getClusterId() Returns the cluster id identifying the cluster to which the client is connected.
org.apache.flink.runtime.clusterframework.messages.GetClusterStatusResponse	getClusterStatus() Returns the latest cluster status, with number of Taskmanagers and slots.
int	getMaxSlots() The client may define an upper limit on the number of slots to use.
List<String>	getNewMessages() May return new messages from the cluster.
String	getWebInterfaceURL() Returns an URL (as a string) to the JobManager web interface.
boolean	hasUserJarsInClassPath(List<URL> userJarFiles) Returns true if the client already has the user jar and providing it again would result in duplicate uploading of the jar.
org.apache.flink.api.common.JobSubmissionResult	submitJob(org.apache.flink.runtime.jobgraph.JobGraph jobGraph, ClassLoader classLoader) Calls the subclasses' submitJob method.
void	waitForClusterToBeReady() Blocks until the client has determined that the cluster is ready for Job submission.

Methods inherited from class org.apache.flink.client.program.ClusterClient

cancel, cancelWithSavepoint, connectToJob, disposeSavepoint, endSession, endSessions, getAccumulators, getAccumulators, getClusterConnectionInfo, getFlinkConfiguration, getJobGraph, getJobGraph, getJobManagerGateway, getJobStatus, getOptimizedPlan, getOptimizedPlan, getOptimizedPlanAsJson, getPrintStatusDuringExecution, isDetached, listJobs, logAndSysout, rescaleJob, retrieveJob, run, run, run, run, run, run, runDetached, setDetached, setPrintStatusDuringExecution, shutdown, shutDownCluster, stop, triggerSavepoint

Methods inherited from class java.lang.Object

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

Constructor Detail

StandaloneClusterClient

public StandaloneClusterClient(org.apache.flink.configuration.Configuration config)
                        throws Exception

Throws:

Exception

StandaloneClusterClient

public StandaloneClusterClient(org.apache.flink.configuration.Configuration config,
                               org.apache.flink.runtime.highavailability.HighAvailabilityServices highAvailabilityServices,
                               boolean sharedHaServices)

StandaloneClusterClient

public StandaloneClusterClient(org.apache.flink.configuration.Configuration config,
                               org.apache.flink.runtime.highavailability.HighAvailabilityServices highAvailabilityServices,
                               boolean sharedHaServices,
                               ActorSystemLoader actorSystemLoader)

Method Detail

waitForClusterToBeReady

public void waitForClusterToBeReady()

Description copied from class: ClusterClient

Blocks until the client has determined that the cluster is ready for Job submission.

This is delayed until right before job submission to report any other errors first (e.g. invalid job definitions/errors in the user jar)

Specified by:

waitForClusterToBeReady in class ClusterClient<StandaloneClusterId>

getWebInterfaceURL

public String getWebInterfaceURL()

Description copied from class: ClusterClient

Returns an URL (as a string) to the JobManager web interface.

Specified by:

getWebInterfaceURL in class ClusterClient<StandaloneClusterId>

getClusterStatus

public org.apache.flink.runtime.clusterframework.messages.GetClusterStatusResponse getClusterStatus()

Description copied from class: ClusterClient

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

Specified by:

getClusterStatus in class ClusterClient<StandaloneClusterId>

getNewMessages

public List<String> getNewMessages()

Description copied from class: ClusterClient

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

Specified by:

getNewMessages in class ClusterClient<StandaloneClusterId>

getClusterId

public StandaloneClusterId getClusterId()

Description copied from class: ClusterClient

Returns the cluster id identifying the cluster to which the client is connected.

Specified by:

getClusterId in class ClusterClient<StandaloneClusterId>

Returns:

cluster id of the connected cluster

getMaxSlots

public int getMaxSlots()

Description copied from class: ClusterClient

The client may define an upper limit on the number of slots to use.

Specified by:

getMaxSlots in class ClusterClient<StandaloneClusterId>

Returns:

-1 (ClusterClient.MAX_SLOTS_UNKNOWN) if unknown

hasUserJarsInClassPath

public boolean hasUserJarsInClassPath(List<URL> userJarFiles)

Description copied from class: ClusterClient

Returns true if the client already has the user jar and providing it again would result in duplicate uploading of the jar.

Specified by:

hasUserJarsInClassPath in class ClusterClient<StandaloneClusterId>

submitJob

public org.apache.flink.api.common.JobSubmissionResult submitJob(org.apache.flink.runtime.jobgraph.JobGraph jobGraph,
                                                                 ClassLoader classLoader)
                                                          throws ProgramInvocationException

Description copied from class: ClusterClient

Calls the subclasses' submitJob method. It may decide to simply call one of the run methods or it may perform some custom job submission logic.

Specified by:

submitJob in class ClusterClient<StandaloneClusterId>

Parameters:

jobGraph - The JobGraph to be submitted

Returns:

JobSubmissionResult

Throws:

ProgramInvocationException