@Internal public interface ClusterClientFactory<ClusterID>
Modifier and Type | Method and Description |
---|---|
ClusterDescriptor<ClusterID> |
createClusterDescriptor(Configuration configuration)
Create a
ClusterDescriptor from the given configuration. |
default 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. |
ClusterID |
getClusterId(Configuration configuration)
Returns the cluster id if a cluster id is specified in the provided configuration, otherwise
it returns
null . |
ClusterSpecification |
getClusterSpecification(Configuration configuration)
Returns the
ClusterSpecification specified by the configuration and the command line
options. |
boolean |
isCompatibleWith(Configuration configuration)
Returns
true if the current ClusterClientFactory is compatible with the
provided configuration, false otherwise. |
boolean isCompatibleWith(Configuration configuration)
true
if the current ClusterClientFactory
is compatible with the
provided configuration, false
otherwise.ClusterDescriptor<ClusterID> createClusterDescriptor(Configuration configuration)
ClusterDescriptor
from the given configuration.configuration
- containing the configuration options relevant for the ClusterDescriptor
ClusterDescriptor
.@Nullable ClusterID getClusterId(Configuration configuration)
null
.
A cluster id identifies a running cluster, e.g. the Yarn application id for a Flink cluster running on Yarn.
configuration
- containing the configuration options relevant for the cluster id
retrievalClusterSpecification getClusterSpecification(Configuration configuration)
ClusterSpecification
specified by the configuration and the command line
options. This specification can be used to deploy a new Flink cluster.configuration
- containing the configuration options relevant for the ClusterSpecification
ClusterSpecification
for a new Flink clusterdefault Optional<String> getApplicationTargetName()
Optional.empty()
if the environment of this
cluster client factory does not support Application Mode.Copyright © 2014–2024 The Apache Software Foundation. All rights reserved.