org.apache.flink.table.client.config.entries

Class DeploymentEntry

java.lang.Object

org.apache.flink.table.client.config.entries.DeploymentEntry

public class DeploymentEntry
extends Object

Configuration of a Flink cluster deployment. This class parses the `deployment` part in an environment file. In the future, we should keep the amount of properties here little and forward most properties to Flink's CLI frontend properties directly.

All properties of this entry are optional and evaluated lazily.

Field Summary

Fields

Modifier and Type	Field and Description
static DeploymentEntry	DEFAULT_INSTANCE
protected org.apache.flink.table.descriptors.DescriptorProperties	properties

Method Summary

Modifier and Type	Method and Description
Map<String,String>	asMap()
Map<String,String>	asTopLevelMap()
static DeploymentEntry	create(Map<String,Object> config)
static DeploymentEntry	enrich(DeploymentEntry deployment, Map<String,String> prefixedProperties) Creates a new deployment entry enriched with additional properties that are prefixed with Environment.DEPLOYMENT_ENTRY.
boolean	equals(Object o)
org.apache.commons.cli.CommandLine	getCommandLine(org.apache.commons.cli.Options commandLineOptions) Parses the given command line options from the deployment properties.
String	getGatewayAddress()
int	getGatewayPort()
long	getResponseTimeout()
int	hashCode()
static DeploymentEntry	merge(DeploymentEntry deployment1, DeploymentEntry deployment2) Merges two deployments entries.
String	toString()
protected void	validate(org.apache.flink.table.descriptors.DescriptorProperties properties) Performs syntactic validation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_INSTANCE

public static final DeploymentEntry DEFAULT_INSTANCE

properties

protected final org.apache.flink.table.descriptors.DescriptorProperties properties

Method Detail

validate

protected void validate(org.apache.flink.table.descriptors.DescriptorProperties properties)

Performs syntactic validation.

getResponseTimeout

public long getResponseTimeout()

getGatewayAddress

public String getGatewayAddress()

getGatewayPort

public int getGatewayPort()

getCommandLine

public org.apache.commons.cli.CommandLine getCommandLine(org.apache.commons.cli.Options commandLineOptions)
                                                  throws Exception

Parses the given command line options from the deployment properties. Ignores properties that are not defined by options.

Throws:

Exception

asTopLevelMap

public Map<String,String> asTopLevelMap()

create

public static DeploymentEntry create(Map<String,Object> config)

merge

public static DeploymentEntry merge(DeploymentEntry deployment1,
                                    DeploymentEntry deployment2)

Merges two deployments entries. The properties of the first deployment entry might be overwritten by the second one.

enrich

public static DeploymentEntry enrich(DeploymentEntry deployment,
                                     Map<String,String> prefixedProperties)

Creates a new deployment entry enriched with additional properties that are prefixed with Environment.DEPLOYMENT_ENTRY.

toString

public String toString()

Overrides:

toString in class Object

asMap

public Map<String,String> asMap()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object