org.apache.flink.yarn

Class YarnClusterClientFactory

java.lang.Object

org.apache.flink.client.deployment.AbstractContainerizedClusterClientFactory<org.apache.hadoop.yarn.api.records.ApplicationId>

org.apache.flink.yarn.YarnClusterClientFactory

All Implemented Interfaces:

ClusterClientFactory<org.apache.hadoop.yarn.api.records.ApplicationId>

@Internal
public class YarnClusterClientFactory
extends AbstractContainerizedClusterClientFactory<org.apache.hadoop.yarn.api.records.ApplicationId>

A ClusterClientFactory for a YARN cluster.

Constructor Summary

Constructors

Constructor and Description
YarnClusterClientFactory()

Method Summary

Modifier and Type	Method and Description
YarnClusterDescriptor	createClusterDescriptor(Configuration configuration) Create a ClusterDescriptor from the given configuration.
Optional<String>	getApplicationTargetName() Returns the option to be used when trying to execute an application in Application Mode using this cluster client factory, or an Optional.empty() if the environment of this cluster client factory does not support Application Mode.
org.apache.hadoop.yarn.api.records.ApplicationId	getClusterId(Configuration configuration) Returns the cluster id if a cluster id is specified in the provided configuration, otherwise it returns null.
boolean	isCompatibleWith(Configuration configuration) Returns true if the current ClusterClientFactory is compatible with the provided configuration, false otherwise.

Methods inherited from class org.apache.flink.client.deployment.AbstractContainerizedClusterClientFactory

getClusterSpecification

Methods inherited from class java.lang.Object

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

Constructor Detail

YarnClusterClientFactory

public YarnClusterClientFactory()

Method Detail

isCompatibleWith

public boolean isCompatibleWith(Configuration configuration)

Description copied from interface: ClusterClientFactory

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

createClusterDescriptor

public YarnClusterDescriptor createClusterDescriptor(Configuration configuration)

Description copied from interface: ClusterClientFactory

Create a ClusterDescriptor from the given configuration.

Parameters:

configuration - containing the configuration options relevant for the ClusterDescriptor

Returns:

the corresponding ClusterDescriptor.

getClusterId

@Nullable
public org.apache.hadoop.yarn.api.records.ApplicationId getClusterId(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.

Parameters:

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

Returns:

Cluster id identifying the cluster to deploy jobs to or null

getApplicationTargetName

public Optional<String> getApplicationTargetName()

Description copied from interface: ClusterClientFactory

Returns the option to be used when trying to execute an application in Application Mode using this cluster client factory, or an Optional.empty() if the environment of this cluster client factory does not support Application Mode.