org.apache.flink.client.deployment

Class LegacyStandaloneClusterDescriptor

java.lang.Object

org.apache.flink.client.deployment.LegacyStandaloneClusterDescriptor

All Implemented Interfaces:

AutoCloseable, ClusterDescriptor<StandaloneClusterId>

public class LegacyStandaloneClusterDescriptor
extends Object
implements ClusterDescriptor<StandaloneClusterId>

A deployment descriptor for an existing cluster.

Constructor Summary

Constructors

Constructor and Description
LegacyStandaloneClusterDescriptor(org.apache.flink.configuration.Configuration config)

Method Summary

Modifier and Type	Method and Description
void	close()
StandaloneClusterClient	deployJobCluster(ClusterSpecification clusterSpecification, org.apache.flink.runtime.jobgraph.JobGraph jobGraph, boolean detached) Deploys a per-job cluster with the given job on the cluster.
StandaloneClusterClient	deploySessionCluster(ClusterSpecification clusterSpecification) Triggers deployment of a cluster.
String	getClusterDescription() Returns a String containing details about the cluster (NodeManagers, available memory, ...).
void	killCluster(StandaloneClusterId clusterId) Terminates the cluster with the given cluster id.
StandaloneClusterClient	retrieve(StandaloneClusterId standaloneClusterId) Retrieves an existing Flink Cluster.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyStandaloneClusterDescriptor

public LegacyStandaloneClusterDescriptor(org.apache.flink.configuration.Configuration config)

Method Detail

getClusterDescription

public String getClusterDescription()

Description copied from interface: ClusterDescriptor

Returns a String containing details about the cluster (NodeManagers, available memory, ...).

Specified by:

getClusterDescription in interface ClusterDescriptor<StandaloneClusterId>

retrieve

public StandaloneClusterClient retrieve(StandaloneClusterId standaloneClusterId)
                                 throws ClusterRetrieveException

Description copied from interface: ClusterDescriptor

Retrieves an existing Flink Cluster.

Specified by:

retrieve in interface ClusterDescriptor<StandaloneClusterId>

Parameters:

standaloneClusterId - The unique identifier of the running cluster

Returns:

Client for the cluster

Throws:

ClusterRetrieveException - if the cluster client could not be retrieved

deploySessionCluster

public StandaloneClusterClient deploySessionCluster(ClusterSpecification clusterSpecification)

Description copied from interface: ClusterDescriptor

Triggers deployment of a cluster.

Specified by:

deploySessionCluster in interface ClusterDescriptor<StandaloneClusterId>

Parameters:

clusterSpecification - Cluster specification defining the cluster to deploy

Returns:

Client for the cluster

deployJobCluster

public StandaloneClusterClient deployJobCluster(ClusterSpecification clusterSpecification,
                                                org.apache.flink.runtime.jobgraph.JobGraph jobGraph,
                                                boolean detached)

Description copied from interface: ClusterDescriptor

Deploys a per-job cluster with the given job on the cluster.

Specified by:

deployJobCluster in interface ClusterDescriptor<StandaloneClusterId>

Parameters:

clusterSpecification - Initial cluster specification with which the Flink cluster is launched

jobGraph - JobGraph with which the job cluster is started

detached - true if the cluster should be stopped after the job completion without serving the result, otherwise false

Returns:

Cluster client to talk to the Flink cluster

killCluster

public void killCluster(StandaloneClusterId clusterId)
                 throws org.apache.flink.util.FlinkException

Description copied from interface: ClusterDescriptor

Terminates the cluster with the given cluster id.

Specified by:

killCluster in interface ClusterDescriptor<StandaloneClusterId>

Parameters:

clusterId - identifying the cluster to shut down

Throws:

org.apache.flink.util.FlinkException - if the cluster could not be terminated

close

public void close()
           throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception