org.apache.flink.client.deployment

Interface ClusterDescriptor<ClientType extends ClusterClient>

All Known Implementing Classes:

AbstractYarnClusterDescriptor, Flip6StandaloneClusterDescriptor, StandaloneClusterDescriptor, YarnClusterDescriptor, YarnClusterDescriptorV2

public interface ClusterDescriptor<ClientType extends ClusterClient>

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
ClientType	deployJobCluster(ClusterSpecification clusterSpecification, JobGraph jobGraph) Deploys a per-job cluster with the given job on the cluster.
ClientType	deploySessionCluster(ClusterSpecification clusterSpecification) Triggers deployment of a cluster.
String	getClusterDescription() Returns a String containing details about the cluster (NodeManagers, available memory, ...).
ClientType	retrieve(String applicationID) Retrieves an existing Flink Cluster.

Method Detail

getClusterDescription

String getClusterDescription()

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

retrieve

ClientType retrieve(String applicationID)
             throws UnsupportedOperationException

Retrieves an existing Flink Cluster.

Parameters:

applicationID - The unique application identifier of the running cluster

Returns:

Client for the cluster

Throws:

UnsupportedOperationException - if this cluster descriptor doesn't support the operation

deploySessionCluster

ClientType deploySessionCluster(ClusterSpecification clusterSpecification)
                         throws UnsupportedOperationException

Triggers deployment of a cluster.

Parameters:

clusterSpecification - Cluster specification defining the cluster to deploy

Returns:

Client for the cluster

Throws:

UnsupportedOperationException - if this cluster descriptor doesn't support the operation

deployJobCluster

ClientType deployJobCluster(ClusterSpecification clusterSpecification,
                            JobGraph jobGraph)

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

Returns:

Cluster client to talk to the Flink cluster

Throws:

ClusterDeploymentException - if the cluster could not be deployed