Package org.apache.flink.client.deployment

Class StandaloneClientFactory

java.lang.Object

org.apache.flink.client.deployment.StandaloneClientFactory

All Implemented Interfaces:

ClusterClientFactory<StandaloneClusterId>

@Internal
public class StandaloneClientFactory
extends Object
implements ClusterClientFactory<StandaloneClusterId>

A ClusterClientFactory for a standalone cluster, i.e. Flink on bare-metal.

Constructor Summary

Constructors

Constructor	Description
StandaloneClientFactory()

Method Summary

Modifier and Type	Method	Description
StandaloneClusterDescriptor	createClusterDescriptor(org.apache.flink.configuration.Configuration configuration)	Create a ClusterDescriptor from the given configuration.
StandaloneClusterId	getClusterId(org.apache.flink.configuration.Configuration configuration)	Returns the cluster id if a cluster id is specified in the provided configuration, otherwise it returns null.
ClusterSpecification	getClusterSpecification(org.apache.flink.configuration.Configuration configuration)	Returns the ClusterSpecification specified by the configuration and the command line options.
boolean	isCompatibleWith(org.apache.flink.configuration.Configuration configuration)	Returns true if the current ClusterClientFactory is compatible with the provided configuration, false otherwise.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.client.deployment.ClusterClientFactory

getApplicationTargetName

Constructor Details

StandaloneClientFactory

public StandaloneClientFactory()

Method Details

isCompatibleWith

public boolean isCompatibleWith(org.apache.flink.configuration.Configuration configuration)

Description copied from interface: ClusterClientFactory

Returns true if the current ClusterClientFactory is compatible with the provided configuration, false otherwise.

Specified by:

isCompatibleWith in interface ClusterClientFactory<StandaloneClusterId>

createClusterDescriptor

public StandaloneClusterDescriptor createClusterDescriptor(org.apache.flink.configuration.Configuration configuration)

Description copied from interface: ClusterClientFactory

Create a ClusterDescriptor from the given configuration.

Specified by:

createClusterDescriptor in interface ClusterClientFactory<StandaloneClusterId>

Parameters:

configuration - containing the configuration options relevant for the ClusterDescriptor

Returns:

the corresponding ClusterDescriptor.

getClusterId

@Nullable
public StandaloneClusterId getClusterId(org.apache.flink.configuration.Configuration configuration)

Description copied from interface: ClusterClientFactory

Returns the cluster id if a cluster id is specified in the provided configuration, otherwise it returns null.

A cluster id identifies a running cluster, e.g. the Yarn application id for a Flink cluster running on Yarn.

Specified by:

getClusterId in interface ClusterClientFactory<StandaloneClusterId>

Parameters:

configuration - containing the configuration options relevant for the cluster id retrieval

Returns:

Cluster id identifying the cluster to deploy jobs to or null

getClusterSpecification

public ClusterSpecification getClusterSpecification(org.apache.flink.configuration.Configuration configuration)

Description copied from interface: ClusterClientFactory

Returns the ClusterSpecification specified by the configuration and the command line options. This specification can be used to deploy a new Flink cluster.

Specified by:

getClusterSpecification in interface ClusterClientFactory<StandaloneClusterId>

Parameters:

configuration - containing the configuration options relevant for the ClusterSpecification

Returns:

the corresponding ClusterSpecification for a new Flink cluster