Package org.apache.flink.kubernetes

Class KubernetesClusterClientFactory

java.lang.Object

org.apache.flink.client.deployment.AbstractContainerizedClusterClientFactory<String>

org.apache.flink.kubernetes.KubernetesClusterClientFactory

All Implemented Interfaces:

ClusterClientFactory<String>

@Internal
public class KubernetesClusterClientFactory
extends AbstractContainerizedClusterClientFactory<String>

A ClusterClientFactory for a Kubernetes cluster.

Constructor Summary

Constructors

Constructor	Description
KubernetesClusterClientFactory()

Method Summary

Modifier and Type	Method	Description
KubernetesClusterDescriptor	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.
String	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

KubernetesClusterClientFactory

public KubernetesClusterClientFactory()

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 KubernetesClusterDescriptor 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 String 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.