org.apache.flink.client.deployment

Interface ClusterDescriptor<T>

Type Parameters:

T - Type of the cluster id

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

LegacyStandaloneClusterDescriptor, StandaloneClusterDescriptor

public interface ClusterDescriptor<T>
extends AutoCloseable

A descriptor to deploy a cluster (e.g. Yarn or Mesos) and return a Client for Cluster communication.

Method Summary

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

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getClusterDescription

String getClusterDescription()

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

retrieve

ClusterClient<T> retrieve(T clusterId)
                   throws ClusterRetrieveException

Retrieves an existing Flink Cluster.

Parameters:

clusterId - The unique identifier of the running cluster

Returns:

Client for the cluster

Throws:

ClusterRetrieveException - if the cluster client could not be retrieved

deploySessionCluster

ClusterClient<T> deploySessionCluster(ClusterSpecification clusterSpecification)
                               throws ClusterDeploymentException

Triggers deployment of a cluster.

Parameters:

clusterSpecification - Cluster specification defining the cluster to deploy

Returns:

Client for the cluster

Throws:

ClusterDeploymentException - if the cluster could not be deployed

deployJobCluster

ClusterClient<T> deployJobCluster(ClusterSpecification clusterSpecification,
                                  org.apache.flink.runtime.jobgraph.JobGraph jobGraph,
                                  boolean detached)
                           throws ClusterDeploymentException

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

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

Throws:

ClusterDeploymentException - if the cluster could not be deployed

killCluster

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

Terminates the cluster with the given cluster id.

Parameters:

clusterId - identifying the cluster to shut down

Throws:

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