org.apache.flink.runtime.operators.util

Class TaskConfig

java.lang.Object

org.apache.flink.runtime.operators.util.TaskConfig

All Implemented Interfaces:

Serializable

public class TaskConfig
extends Object
implements Serializable

Configuration class which stores all relevant parameters required to set up the Pact tasks.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.flink.configuration.Configuration	config

Constructor Summary

Constructors

Constructor and Description
TaskConfig(org.apache.flink.configuration.Configuration config) Creates a new Task Config that wraps the given configuration.

Method Summary

Modifier and Type	Method and Description
void	addBroadcastInputToGroup(int groupIndex)
void	addChainedTask(Class<? extends ChainedDriver> chainedTaskClass, TaskConfig conf, String taskName)
void	addInputToGroup(int groupIndex)
void	addIterationAggregator(String name, org.apache.flink.api.common.aggregators.Aggregator<?> aggregator)
void	addIterationAggregators(Collection<org.apache.flink.api.common.aggregators.AggregatorWithName<?>> aggregators)
void	addOutputShipStrategy(ShipStrategyType strategy)
int	getBroadcastGroupSize(int groupIndex)
String	getBroadcastInputName(int groupIndex)
<T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T>	getBroadcastInputSerializer(int inputNum, ClassLoader cl)
TaskConfig	getChainedStubConfig(int chainPos)
Class<? extends ChainedDriver<?,?>>	getChainedTask(int chainPos)
String	getChainedTaskName(int chainPos)
org.apache.flink.configuration.Configuration	getConfiguration() Gets the configuration that holds the actual values encoded.
<T extends org.apache.flink.types.Value> org.apache.flink.api.common.aggregators.ConvergenceCriterion<T>	getConvergenceCriterion(ClassLoader cl)
String	getConvergenceCriterionAggregatorName()
<S extends org.apache.flink.api.common.functions.Function,OT> Class<? extends Driver<S,OT>>	getDriver()
<T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T>	getDriverComparator(int inputNum, ClassLoader cl)
DriverStrategy	getDriverStrategy()
int	getFilehandlesDriver()
int	getFilehandlesInput(int inputNum)
int	getGroupSize(int groupIndex)
<T extends org.apache.flink.types.Value> org.apache.flink.api.common.aggregators.ConvergenceCriterion<T>	getImplicitConvergenceCriterion(ClassLoader cl)
String	getImplicitConvergenceCriterionAggregatorName()
<T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T>	getInputComparator(int inputNum, ClassLoader cl)
LocalStrategy	getInputLocalStrategy(int inputNum)
<T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T>	getInputSerializer(int inputNum, ClassLoader cl)
boolean	getIsSolutionSetUpdate()
boolean	getIsSolutionSetUpdateWithoutReprobe()
boolean	getIsWorksetIteration()
boolean	getIsWorksetUpdate()
Collection<org.apache.flink.api.common.aggregators.AggregatorWithName<?>>	getIterationAggregators(ClassLoader cl)
TaskConfig	getIterationHeadFinalOutputConfig()
int	getIterationHeadIndexOfSyncOutput()
int	getIterationHeadPartialSolutionOrWorksetInputIndex()
int	getIterationHeadSolutionSetInputIndex()
int	getIterationId()
boolean	getMutableObjectMode()
int	getNumberOfChainedStubs()
int	getNumberOfEventsUntilInterruptInIterativeBroadcastGate(int bcGateIndex)
int	getNumberOfEventsUntilInterruptInIterativeGate(int inputGateIndex)
int	getNumberOfIterations()
int	getNumBroadcastInputs()
int	getNumInputs()
int	getNumOutputs()
<T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T>	getOutputComparator(int outputNum, ClassLoader cl)
org.apache.flink.api.common.distributions.DataDistribution	getOutputDataDistribution(int outputNum, ClassLoader cl)
org.apache.flink.api.common.functions.Partitioner<?>	getOutputPartitioner(int outputNum, ClassLoader cl)
<T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T>	getOutputSerializer(ClassLoader cl)
ShipStrategyType	getOutputShipStrategy(int outputNum)
<T1,T2> org.apache.flink.api.common.typeutils.TypePairComparatorFactory<T1,T2>	getPairComparatorFactory(ClassLoader cl)
double	getRelativeBackChannelMemory()
double	getRelativeInputMaterializationMemory(int inputNum)
double	getRelativeMemoryDriver()
double	getRelativeMemoryInput(int inputNum)
double	getRelativeSolutionSetMemory()
<T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T>	getSolutionSetComparator(ClassLoader cl)
<T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T>	getSolutionSetSerializer(ClassLoader cl)
float	getSpillingThresholdDriver()
float	getSpillingThresholdInput(int inputNum)
String	getStubParameter(String key, String defaultValue)
org.apache.flink.configuration.Configuration	getStubParameters()
<T> org.apache.flink.api.common.operators.util.UserCodeWrapper<T>	getStubWrapper(ClassLoader cl)
String	getTaskName()
boolean	getUseLargeRecordHandler()
boolean	getWaitForSolutionSetUpdate()
boolean	hasStubWrapper()
boolean	isInputAsynchronouslyMaterialized(int inputNum)
boolean	isInputCached(int inputNum)
boolean	isIterativeInputGate(int inputGateIndex)
boolean	isSolutionSetUnmanaged()
void	setBroadcastGateIterativeWithNumberOfEventsUntilInterrupt(int bcGateIndex, int numEvents)
void	setBroadcastInputName(String name, int groupIndex)
void	setBroadcastInputSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory, int inputNum)
void	setConvergenceCriterion(String aggregatorName, org.apache.flink.api.common.aggregators.ConvergenceCriterion<?> convCriterion)
void	setDriver(Class<? extends Driver> driver)
void	setDriverComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory, int inputNum)
void	setDriverPairComparator(org.apache.flink.api.common.typeutils.TypePairComparatorFactory<?,?> factory)
void	setDriverStrategy(DriverStrategy strategy)
void	setFilehandlesDriver(int filehandles)
void	setFilehandlesInput(int inputNum, int filehandles)
void	setGateIterativeWithNumberOfEventsUntilInterrupt(int inputGateIndex, int numEvents)
void	setImplicitConvergenceCriterion(String aggregatorName, org.apache.flink.api.common.aggregators.ConvergenceCriterion<?> convCriterion) Sets the default convergence criterion of a DeltaIteration
void	setInputAsynchronouslyMaterialized(int inputNum, boolean temp)
void	setInputCached(int inputNum, boolean persistent)
void	setInputComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory, int inputNum)
void	setInputLocalStrategy(int inputNum, LocalStrategy strategy)
void	setInputSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory, int inputNum)
void	setIsSolutionSetUpdate()
void	setIsSolutionSetUpdateWithoutReprobe()
void	setIsWorksetIteration()
void	setIsWorksetUpdate()
void	setIterationHeadFinalOutputConfig(TaskConfig conf)
void	setIterationHeadIndexOfSyncOutput(int outputIndex)
void	setIterationHeadPartialSolutionOrWorksetInputIndex(int inputIndex)
void	setIterationHeadSolutionSetInputIndex(int inputIndex)
void	setIterationId(int id)
void	setMutableObjectMode(boolean mode)
void	setNumberOfIterations(int numberOfIterations)
void	setOutputComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory, int outputNum)
void	setOutputDataDistribution(org.apache.flink.api.common.distributions.DataDistribution distribution, int outputNum)
void	setOutputPartitioner(org.apache.flink.api.common.functions.Partitioner<?> partitioner, int outputNum)
void	setOutputSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory)
void	setRelativeBackChannelMemory(double relativeMemory)
void	setRelativeInputMaterializationMemory(int inputNum, double relativeMemory)
void	setRelativeMemoryDriver(double relativeMemorySize)
void	setRelativeMemoryInput(int inputNum, double relativeMemorySize)
void	setRelativeSolutionSetMemory(double relativeMemory)
void	setSolutionSetComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory)
void	setSolutionSetSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory)
void	setSolutionSetUnmanaged(boolean unmanaged)
void	setSpillingThresholdDriver(float threshold)
void	setSpillingThresholdInput(int inputNum, float threshold)
void	setStubParameter(String key, String value)
void	setStubParameters(org.apache.flink.configuration.Configuration parameters)
void	setStubWrapper(org.apache.flink.api.common.operators.util.UserCodeWrapper<?> wrapper)
void	setTaskName(String name)
void	setUseLargeRecordHandler(boolean useLargeRecordHandler)
void	setWaitForSolutionSetUpdate()
boolean	usesConvergenceCriterion()
boolean	usesImplicitConvergenceCriterion()

Methods inherited from class java.lang.Object

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

Field Detail

config

protected final org.apache.flink.configuration.Configuration config

Constructor Detail

TaskConfig

public TaskConfig(org.apache.flink.configuration.Configuration config)

Creates a new Task Config that wraps the given configuration.

Parameters:

config - The configuration holding the actual values.

Method Detail

getConfiguration

public org.apache.flink.configuration.Configuration getConfiguration()

Gets the configuration that holds the actual values encoded.

Returns:

The configuration that holds the actual values

setTaskName

public void setTaskName(String name)

getTaskName

public String getTaskName()

hasStubWrapper

public boolean hasStubWrapper()

setStubWrapper

public void setStubWrapper(org.apache.flink.api.common.operators.util.UserCodeWrapper<?> wrapper)

getStubWrapper

public <T> org.apache.flink.api.common.operators.util.UserCodeWrapper<T> getStubWrapper(ClassLoader cl)

setStubParameters

public void setStubParameters(org.apache.flink.configuration.Configuration parameters)

getStubParameters

public org.apache.flink.configuration.Configuration getStubParameters()

setStubParameter

public void setStubParameter(String key,
                             String value)

getStubParameter

public String getStubParameter(String key,
                               String defaultValue)

setDriver

public void setDriver(Class<? extends Driver> driver)

getDriver

public <S extends org.apache.flink.api.common.functions.Function,OT> Class<? extends Driver<S,OT>> getDriver()

setDriverStrategy

public void setDriverStrategy(DriverStrategy strategy)

getDriverStrategy

public DriverStrategy getDriverStrategy()

setMutableObjectMode

public void setMutableObjectMode(boolean mode)

getMutableObjectMode

public boolean getMutableObjectMode()

setDriverComparator

public void setDriverComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory,
                                int inputNum)

getDriverComparator

public <T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T> getDriverComparator(int inputNum,
                                                                                              ClassLoader cl)

setDriverPairComparator

public void setDriverPairComparator(org.apache.flink.api.common.typeutils.TypePairComparatorFactory<?,?> factory)

getPairComparatorFactory

public <T1,T2> org.apache.flink.api.common.typeutils.TypePairComparatorFactory<T1,T2> getPairComparatorFactory(ClassLoader cl)

setInputLocalStrategy

public void setInputLocalStrategy(int inputNum,
                                  LocalStrategy strategy)

getInputLocalStrategy

public LocalStrategy getInputLocalStrategy(int inputNum)

setInputSerializer

public void setInputSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory,
                               int inputNum)

setBroadcastInputSerializer

public void setBroadcastInputSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory,
                                        int inputNum)

getInputSerializer

public <T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T> getInputSerializer(int inputNum,
                                                                                             ClassLoader cl)

getBroadcastInputSerializer

public <T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T> getBroadcastInputSerializer(int inputNum,
                                                                                                      ClassLoader cl)

setInputComparator

public void setInputComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory,
                               int inputNum)

getInputComparator

public <T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T> getInputComparator(int inputNum,
                                                                                             ClassLoader cl)

getNumInputs

public int getNumInputs()

getNumBroadcastInputs

public int getNumBroadcastInputs()

getGroupSize

public int getGroupSize(int groupIndex)

getBroadcastGroupSize

public int getBroadcastGroupSize(int groupIndex)

addInputToGroup

public void addInputToGroup(int groupIndex)

addBroadcastInputToGroup

public void addBroadcastInputToGroup(int groupIndex)

setInputAsynchronouslyMaterialized

public void setInputAsynchronouslyMaterialized(int inputNum,
                                               boolean temp)

isInputAsynchronouslyMaterialized

public boolean isInputAsynchronouslyMaterialized(int inputNum)

setInputCached

public void setInputCached(int inputNum,
                           boolean persistent)

isInputCached

public boolean isInputCached(int inputNum)

setRelativeInputMaterializationMemory

public void setRelativeInputMaterializationMemory(int inputNum,
                                                  double relativeMemory)

getRelativeInputMaterializationMemory

public double getRelativeInputMaterializationMemory(int inputNum)

setBroadcastInputName

public void setBroadcastInputName(String name,
                                  int groupIndex)

getBroadcastInputName

public String getBroadcastInputName(int groupIndex)

addOutputShipStrategy

public void addOutputShipStrategy(ShipStrategyType strategy)

getNumOutputs

public int getNumOutputs()

getOutputShipStrategy

public ShipStrategyType getOutputShipStrategy(int outputNum)

setOutputSerializer

public void setOutputSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory)

getOutputSerializer

public <T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T> getOutputSerializer(ClassLoader cl)

setOutputComparator

public void setOutputComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory,
                                int outputNum)

getOutputComparator

public <T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T> getOutputComparator(int outputNum,
                                                                                              ClassLoader cl)

setOutputDataDistribution

public void setOutputDataDistribution(org.apache.flink.api.common.distributions.DataDistribution distribution,
                                      int outputNum)

getOutputDataDistribution

public org.apache.flink.api.common.distributions.DataDistribution getOutputDataDistribution(int outputNum,
                                                                                            ClassLoader cl)
                                                                                     throws ClassNotFoundException

Throws:

ClassNotFoundException

setOutputPartitioner

public void setOutputPartitioner(org.apache.flink.api.common.functions.Partitioner<?> partitioner,
                                 int outputNum)

getOutputPartitioner

public org.apache.flink.api.common.functions.Partitioner<?> getOutputPartitioner(int outputNum,
                                                                                 ClassLoader cl)
                                                                          throws ClassNotFoundException

Throws:

ClassNotFoundException

setRelativeMemoryDriver

public void setRelativeMemoryDriver(double relativeMemorySize)

getRelativeMemoryDriver

public double getRelativeMemoryDriver()

setRelativeMemoryInput

public void setRelativeMemoryInput(int inputNum,
                                   double relativeMemorySize)

getRelativeMemoryInput

public double getRelativeMemoryInput(int inputNum)

setFilehandlesDriver

public void setFilehandlesDriver(int filehandles)

getFilehandlesDriver

public int getFilehandlesDriver()

setFilehandlesInput

public void setFilehandlesInput(int inputNum,
                                int filehandles)

getFilehandlesInput

public int getFilehandlesInput(int inputNum)

setSpillingThresholdDriver

public void setSpillingThresholdDriver(float threshold)

getSpillingThresholdDriver

public float getSpillingThresholdDriver()

setSpillingThresholdInput

public void setSpillingThresholdInput(int inputNum,
                                      float threshold)

getSpillingThresholdInput

public float getSpillingThresholdInput(int inputNum)

setUseLargeRecordHandler

public void setUseLargeRecordHandler(boolean useLargeRecordHandler)

getUseLargeRecordHandler

public boolean getUseLargeRecordHandler()

getNumberOfChainedStubs

public int getNumberOfChainedStubs()

addChainedTask

public void addChainedTask(Class<? extends ChainedDriver> chainedTaskClass,
                           TaskConfig conf,
                           String taskName)

getChainedStubConfig

public TaskConfig getChainedStubConfig(int chainPos)

getChainedTask

public Class<? extends ChainedDriver<?,?>> getChainedTask(int chainPos)

getChainedTaskName

public String getChainedTaskName(int chainPos)

setNumberOfIterations

public void setNumberOfIterations(int numberOfIterations)

getNumberOfIterations

public int getNumberOfIterations()

setIterationHeadPartialSolutionOrWorksetInputIndex

public void setIterationHeadPartialSolutionOrWorksetInputIndex(int inputIndex)

getIterationHeadPartialSolutionOrWorksetInputIndex

public int getIterationHeadPartialSolutionOrWorksetInputIndex()

setIterationHeadSolutionSetInputIndex

public void setIterationHeadSolutionSetInputIndex(int inputIndex)

getIterationHeadSolutionSetInputIndex

public int getIterationHeadSolutionSetInputIndex()

setRelativeBackChannelMemory

public void setRelativeBackChannelMemory(double relativeMemory)

getRelativeBackChannelMemory

public double getRelativeBackChannelMemory()

setRelativeSolutionSetMemory

public void setRelativeSolutionSetMemory(double relativeMemory)

getRelativeSolutionSetMemory

public double getRelativeSolutionSetMemory()

isIterativeInputGate

public boolean isIterativeInputGate(int inputGateIndex)

setGateIterativeWithNumberOfEventsUntilInterrupt

public void setGateIterativeWithNumberOfEventsUntilInterrupt(int inputGateIndex,
                                                             int numEvents)

getNumberOfEventsUntilInterruptInIterativeGate

public int getNumberOfEventsUntilInterruptInIterativeGate(int inputGateIndex)

setBroadcastGateIterativeWithNumberOfEventsUntilInterrupt

public void setBroadcastGateIterativeWithNumberOfEventsUntilInterrupt(int bcGateIndex,
                                                                      int numEvents)

getNumberOfEventsUntilInterruptInIterativeBroadcastGate

public int getNumberOfEventsUntilInterruptInIterativeBroadcastGate(int bcGateIndex)

setIterationId

public void setIterationId(int id)

getIterationId

public int getIterationId()

setIsWorksetIteration

public void setIsWorksetIteration()

getIsWorksetIteration

public boolean getIsWorksetIteration()

setIterationHeadIndexOfSyncOutput

public void setIterationHeadIndexOfSyncOutput(int outputIndex)

getIterationHeadIndexOfSyncOutput

public int getIterationHeadIndexOfSyncOutput()

setIterationHeadFinalOutputConfig

public void setIterationHeadFinalOutputConfig(TaskConfig conf)

getIterationHeadFinalOutputConfig

public TaskConfig getIterationHeadFinalOutputConfig()

setSolutionSetSerializer

public void setSolutionSetSerializer(org.apache.flink.api.common.typeutils.TypeSerializerFactory<?> factory)

getSolutionSetSerializer

public <T> org.apache.flink.api.common.typeutils.TypeSerializerFactory<T> getSolutionSetSerializer(ClassLoader cl)

setSolutionSetComparator

public void setSolutionSetComparator(org.apache.flink.api.common.typeutils.TypeComparatorFactory<?> factory)

getSolutionSetComparator

public <T> org.apache.flink.api.common.typeutils.TypeComparatorFactory<T> getSolutionSetComparator(ClassLoader cl)

addIterationAggregator

public void addIterationAggregator(String name,
                                   org.apache.flink.api.common.aggregators.Aggregator<?> aggregator)

addIterationAggregators

public void addIterationAggregators(Collection<org.apache.flink.api.common.aggregators.AggregatorWithName<?>> aggregators)

getIterationAggregators

public Collection<org.apache.flink.api.common.aggregators.AggregatorWithName<?>> getIterationAggregators(ClassLoader cl)

setConvergenceCriterion

public void setConvergenceCriterion(String aggregatorName,
                                    org.apache.flink.api.common.aggregators.ConvergenceCriterion<?> convCriterion)

setImplicitConvergenceCriterion

public void setImplicitConvergenceCriterion(String aggregatorName,
                                            org.apache.flink.api.common.aggregators.ConvergenceCriterion<?> convCriterion)

Sets the default convergence criterion of a DeltaIteration

Parameters:

aggregatorName -

convCriterion -

getConvergenceCriterion

public <T extends org.apache.flink.types.Value> org.apache.flink.api.common.aggregators.ConvergenceCriterion<T> getConvergenceCriterion(ClassLoader cl)

usesConvergenceCriterion

public boolean usesConvergenceCriterion()

getConvergenceCriterionAggregatorName

public String getConvergenceCriterionAggregatorName()

getImplicitConvergenceCriterion

public <T extends org.apache.flink.types.Value> org.apache.flink.api.common.aggregators.ConvergenceCriterion<T> getImplicitConvergenceCriterion(ClassLoader cl)

usesImplicitConvergenceCriterion

public boolean usesImplicitConvergenceCriterion()

getImplicitConvergenceCriterionAggregatorName

public String getImplicitConvergenceCriterionAggregatorName()

setIsSolutionSetUpdate

public void setIsSolutionSetUpdate()

getIsSolutionSetUpdate

public boolean getIsSolutionSetUpdate()

setIsSolutionSetUpdateWithoutReprobe

public void setIsSolutionSetUpdateWithoutReprobe()

getIsSolutionSetUpdateWithoutReprobe

public boolean getIsSolutionSetUpdateWithoutReprobe()

setWaitForSolutionSetUpdate

public void setWaitForSolutionSetUpdate()

getWaitForSolutionSetUpdate

public boolean getWaitForSolutionSetUpdate()

setIsWorksetUpdate

public void setIsWorksetUpdate()

getIsWorksetUpdate

public boolean getIsWorksetUpdate()

setSolutionSetUnmanaged

public void setSolutionSetUnmanaged(boolean unmanaged)

isSolutionSetUnmanaged

public boolean isSolutionSetUnmanaged()