org.apache.flink.client.deployment

接口 ClusterDescriptor<T>

类型参数:

T - Type of the cluster id

所有超级接口:

AutoCloseable

所有已知实现类:

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.

方法概要

限定符和类型	方法和说明
void	close()
ClusterClientProvider<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.
ClusterClientProvider<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.
ClusterClientProvider<T>	retrieve(T clusterId) Retrieves an existing Flink Cluster.

方法详细资料

getClusterDescription

String getClusterDescription()

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

retrieve

ClusterClientProvider<T> retrieve(T clusterId)
                           throws ClusterRetrieveException

Retrieves an existing Flink Cluster.

参数:

clusterId - The unique identifier of the running cluster

返回:

Client for the cluster

抛出:

ClusterRetrieveException - if the cluster client could not be retrieved

deploySessionCluster

ClusterClientProvider<T> deploySessionCluster(ClusterSpecification clusterSpecification)
                                       throws ClusterDeploymentException

Triggers deployment of a cluster.

参数:

clusterSpecification - Cluster specification defining the cluster to deploy

返回:

Client for the cluster

抛出:

ClusterDeploymentException - if the cluster could not be deployed

deployJobCluster

ClusterClientProvider<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.

参数:

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

返回:

Cluster client to talk to the Flink cluster

抛出:

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.

参数:

clusterId - identifying the cluster to shut down

抛出:

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

close

void close()

指定者:

close 在接口中 AutoCloseable