JobVertex (Flink : 1.17-SNAPSHOT API)

java.lang.Object
- org.apache.flink.runtime.jobgraph.JobVertex

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

InputOutputFormatVertex
```
public class JobVertex
extends Object
implements Serializable
```
The base class for job vertexes.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobVertex.FinalizeOnMasterContext` The context exposes some runtime infos for finalization.
`static interface`	`JobVertex.InitializeOnMasterContext`

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_PARALLELISM_DEFAULT

Fields
Modifier and Type	Field and Description
`static int`	`MAX_PARALLELISM_DEFAULT`

Constructor Summary

Constructors
Constructor and Description
`JobVertex(String name)` Constructs a new job vertex and assigns it with the given name.
`JobVertex(String name, JobVertexID id)` Constructs a new job vertex and assigns it with the given name.
`JobVertex(String name, JobVertexID primaryId, List<OperatorIDPair> operatorIDPairs)` Constructs a new job vertex and assigns it with the given name.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIntermediateDataSetIdToConsume(IntermediateDataSetID intermediateDataSetId)`
`void`	`addOperatorCoordinator(SerializedValue<OperatorCoordinator.Provider> serializedCoordinatorProvider)`
`JobEdge`	`connectNewDataSetAsInput(JobVertex input, DistributionPattern distPattern, ResultPartitionType partitionType)`
`JobEdge`	`connectNewDataSetAsInput(JobVertex input, DistributionPattern distPattern, ResultPartitionType partitionType, boolean isBroadcast)`
`JobEdge`	`connectNewDataSetAsInput(JobVertex input, DistributionPattern distPattern, ResultPartitionType partitionType, IntermediateDataSetID intermediateDataSetId, boolean isBroadcast)`
`void`	`finalizeOnMaster(JobVertex.FinalizeOnMasterContext context)` A hook that can be overwritten by sub classes to implement logic that is called by the master after the job completed.
`CoLocationGroup`	`getCoLocationGroup()`
`Configuration`	`getConfiguration()` Returns the vertex's configuration object which can be used to pass custom settings to the task at runtime.
`JobVertexID`	`getID()` Returns the ID of this job vertex.
`List<JobEdge>`	`getInputs()`
`InputSplitSource<?>`	`getInputSplitSource()`
`List<IntermediateDataSetID>`	`getIntermediateDataSetIdsToConsume()`
`Class<? extends TaskInvokable>`	`getInvokableClass(ClassLoader cl)` Returns the invokable class which represents the task of this vertex.
`String`	`getInvokableClassName()` Returns the name of the invokable class which represents the task of this vertex.
`int`	`getMaxParallelism()` Gets the maximum parallelism for the task.
`ResourceSpec`	`getMinResources()` Gets the minimum resource for the task.
`String`	`getName()` Returns the name of the vertex.
`int`	`getNumberOfInputs()` Returns the number of inputs.
`int`	`getNumberOfProducedIntermediateDataSets()` Returns the number of produced intermediate data sets.
`List<SerializedValue<OperatorCoordinator.Provider>>`	`getOperatorCoordinators()`
`String`	`getOperatorDescription()`
`List<OperatorIDPair>`	`getOperatorIDs()`
`String`	`getOperatorName()`
`String`	`getOperatorPrettyName()`
`IntermediateDataSet`	`getOrCreateResultDataSet(IntermediateDataSetID id, ResultPartitionType partitionType)`
`int`	`getParallelism()` Gets the parallelism of the task.
`ResourceSpec`	`getPreferredResources()` Gets the preferred resource for the task.
`List<IntermediateDataSet>`	`getProducedDataSets()`
`String`	`getResultOptimizerProperties()`
`SlotSharingGroup`	`getSlotSharingGroup()` Gets the slot sharing group that this vertex is associated with.
`boolean`	`hasNoConnectedInputs()`
`void`	`initializeOnMaster(JobVertex.InitializeOnMasterContext context)` A hook that can be overwritten by sub classes to implement logic that is called by the master when the job starts.
`boolean`	`isInputVertex()`
`boolean`	`isOutputVertex()`
`boolean`	`isParallelismConfigured()`
`boolean`	`isStoppable()`
`boolean`	`isSupportsConcurrentExecutionAttempts()`
`void`	`setInputSplitSource(InputSplitSource<?> inputSplitSource)`
`void`	`setInvokableClass(Class<? extends TaskInvokable> invokable)`
`void`	`setMaxParallelism(int maxParallelism)` Sets the maximum parallelism for the task.
`void`	`setName(String name)` Sets the name of the vertex.
`void`	`setOperatorDescription(String operatorDescription)`
`void`	`setOperatorName(String operatorName)`
`void`	`setOperatorPrettyName(String operatorPrettyName)`
`void`	`setParallelism(int parallelism)` Sets the parallelism for the task.
`void`	`setParallelismConfigured(boolean parallelismConfigured)`
`void`	`setResources(ResourceSpec minResources, ResourceSpec preferredResources)` Sets the minimum and preferred resources for the task.
`void`	`setResultOptimizerProperties(String resultOptimizerProperties)`
`void`	`setSlotSharingGroup(SlotSharingGroup grp)` Associates this vertex with a slot sharing group for scheduling.
`void`	`setStrictlyCoLocatedWith(JobVertex strictlyCoLocatedWith)` Tells this vertex to strictly co locate its subtasks with the subtasks of the given vertex.
`void`	`setSupportsConcurrentExecutionAttempts(boolean supportsConcurrentExecutionAttempts)`
`String`	`toString()`
`void`	`updateCoLocationGroup(CoLocationGroupImpl group)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - MAX_PARALLELISM_DEFAULT
```
public static final int MAX_PARALLELISM_DEFAULT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JobVertex
```
public JobVertex(String name)
```
    Constructs a new job vertex and assigns it with the given name.
    
    Parameters:
    
    name - The name of the new job vertex.
  - JobVertex
```
public JobVertex(String name,
                 JobVertexID id)
```
    Constructs a new job vertex and assigns it with the given name.
    
    Parameters:
    
    name - The name of the new job vertex.
    
    id - The id of the job vertex.
  - JobVertex
```
public JobVertex(String name,
                 JobVertexID primaryId,
                 List<OperatorIDPair> operatorIDPairs)
```
    Constructs a new job vertex and assigns it with the given name.
    
    Parameters:
    
    name - The name of the new job vertex.
    
    primaryId - The id of the job vertex.
    
    operatorIDPairs - The operator ID pairs of the job vertex.
- Method Detail
  - getID
```
public JobVertexID getID()
```
    Returns the ID of this job vertex.
    
    Returns:
    
    The ID of this job vertex
  - getName
```
public String getName()
```
    Returns the name of the vertex.
    
    Returns:
    
    The name of the vertex.
  - setName
```
public void setName(String name)
```
    Sets the name of the vertex.
    
    Parameters:
    
    name - The new name.
  - getNumberOfProducedIntermediateDataSets
```
public int getNumberOfProducedIntermediateDataSets()
```
    Returns the number of produced intermediate data sets.
    
    Returns:
    
    The number of produced intermediate data sets.
  - getNumberOfInputs
```
public int getNumberOfInputs()
```
    Returns the number of inputs.
    
    Returns:
    
    The number of inputs.
  - getOperatorIDs
```
public List<OperatorIDPair> getOperatorIDs()
```
  - getConfiguration
```
public Configuration getConfiguration()
```
    Returns the vertex's configuration object which can be used to pass custom settings to the task at runtime.
    
    Returns:
    
    the vertex's configuration object
  - setInvokableClass
```
public void setInvokableClass(Class<? extends TaskInvokable> invokable)
```
  - setParallelismConfigured
```
public void setParallelismConfigured(boolean parallelismConfigured)
```
  - isParallelismConfigured
```
public boolean isParallelismConfigured()
```
  - getInvokableClassName
```
public String getInvokableClassName()
```
    Returns the name of the invokable class which represents the task of this vertex.
    
    Returns:
    
    The name of the invokable class, null if not set.
  - getInvokableClass
```
public Class<? extends TaskInvokable> getInvokableClass(ClassLoader cl)
```
    Returns the invokable class which represents the task of this vertex.
    
    Parameters:
    
    cl - The classloader used to resolve user-defined classes
    
    Returns:
    
    The invokable class, null if it is not set
  - getParallelism
```
public int getParallelism()
```
    Gets the parallelism of the task.
    
    Returns:
    
    The parallelism of the task.
  - setParallelism
```
public void setParallelism(int parallelism)
```
    Sets the parallelism for the task.
    
    Parameters:
    
    parallelism - The parallelism for the task.
  - getMaxParallelism
```
public int getMaxParallelism()
```
    Gets the maximum parallelism for the task.
    
    Returns:
    
    The maximum parallelism for the task.
  - setMaxParallelism
```
public void setMaxParallelism(int maxParallelism)
```
    Sets the maximum parallelism for the task.
    
    Parameters:
    
    maxParallelism - The maximum parallelism to be set. must be between 1 and Short.MAX_VALUE.
  - getMinResources
```
public ResourceSpec getMinResources()
```
    Gets the minimum resource for the task.
    
    Returns:
    
    The minimum resource for the task.
  - getPreferredResources
```
public ResourceSpec getPreferredResources()
```
    Gets the preferred resource for the task.
    
    Returns:
    
    The preferred resource for the task.
  - setResources
```
public void setResources(ResourceSpec minResources,
                         ResourceSpec preferredResources)
```
    Sets the minimum and preferred resources for the task.
    
    Parameters:
    
    minResources - The minimum resource for the task.
    
    preferredResources - The preferred resource for the task.
  - getInputSplitSource
```
public InputSplitSource<?> getInputSplitSource()
```
  - setInputSplitSource
```
public void setInputSplitSource(InputSplitSource<?> inputSplitSource)
```
  - getProducedDataSets
```
public List<IntermediateDataSet> getProducedDataSets()
```
  - getInputs
```
public List<JobEdge> getInputs()
```
  - getOperatorCoordinators
```
public List<SerializedValue<OperatorCoordinator.Provider>> getOperatorCoordinators()
```
  - addOperatorCoordinator
```
public void addOperatorCoordinator(SerializedValue<OperatorCoordinator.Provider> serializedCoordinatorProvider)
```
  - setSlotSharingGroup
```
public void setSlotSharingGroup(SlotSharingGroup grp)
```
    Associates this vertex with a slot sharing group for scheduling. Different vertices in the same slot sharing group can run one subtask each in the same slot.
    
    Parameters:
    
    grp - The slot sharing group to associate the vertex with.
  - getSlotSharingGroup
```
public SlotSharingGroup getSlotSharingGroup()
```
    Gets the slot sharing group that this vertex is associated with. Different vertices in the same slot sharing group can run one subtask each in the same slot.
    
    Returns:
    
    The slot sharing group to associate the vertex with
  - setStrictlyCoLocatedWith
```
public void setStrictlyCoLocatedWith(JobVertex strictlyCoLocatedWith)
```
    Tells this vertex to strictly co locate its subtasks with the subtasks of the given vertex. Strict co-location implies that the n'th subtask of this vertex will run on the same parallel computing instance (TaskManager) as the n'th subtask of the given vertex.
    NOTE: Co-location is only possible between vertices in a slot sharing group.
    NOTE: This vertex must (transitively) depend on the vertex to be co-located with. That means that the respective vertex must be a (transitive) input of this vertex.
    
    Parameters:
    
    strictlyCoLocatedWith - The vertex whose subtasks to co-locate this vertex's subtasks with.
    
    Throws:
    
    IllegalArgumentException - Thrown, if this vertex and the vertex to co-locate with are not in a common slot sharing group.
    
    See Also:
    
    setSlotSharingGroup(SlotSharingGroup)
  - getCoLocationGroup
```
@Nullable
public CoLocationGroup getCoLocationGroup()
```
  - updateCoLocationGroup
```
public void updateCoLocationGroup(CoLocationGroupImpl group)
```
  - getOrCreateResultDataSet
```
public IntermediateDataSet getOrCreateResultDataSet(IntermediateDataSetID id,
                                                    ResultPartitionType partitionType)
```
  - connectNewDataSetAsInput
```
public JobEdge connectNewDataSetAsInput(JobVertex input,
                                        DistributionPattern distPattern,
                                        ResultPartitionType partitionType)
```
  - connectNewDataSetAsInput
```
public JobEdge connectNewDataSetAsInput(JobVertex input,
                                        DistributionPattern distPattern,
                                        ResultPartitionType partitionType,
                                        boolean isBroadcast)
```
  - connectNewDataSetAsInput
```
public JobEdge connectNewDataSetAsInput(JobVertex input,
                                        DistributionPattern distPattern,
                                        ResultPartitionType partitionType,
                                        IntermediateDataSetID intermediateDataSetId,
                                        boolean isBroadcast)
```
  - isInputVertex
```
public boolean isInputVertex()
```
  - isStoppable
```
public boolean isStoppable()
```
  - isOutputVertex
```
public boolean isOutputVertex()
```
  - hasNoConnectedInputs
```
public boolean hasNoConnectedInputs()
```
  - setSupportsConcurrentExecutionAttempts
```
public void setSupportsConcurrentExecutionAttempts(boolean supportsConcurrentExecutionAttempts)
```
  - isSupportsConcurrentExecutionAttempts
```
public boolean isSupportsConcurrentExecutionAttempts()
```
  - initializeOnMaster
```
public void initializeOnMaster(JobVertex.InitializeOnMasterContext context)
                        throws Exception
```
    A hook that can be overwritten by sub classes to implement logic that is called by the master when the job starts.
    
    Parameters:
    
    context - Provides contextual information for the initialization
    
    Throws:
    
    Exception - The method may throw exceptions which cause the job to fail immediately.
  - finalizeOnMaster
```
public void finalizeOnMaster(JobVertex.FinalizeOnMasterContext context)
                      throws Exception
```
    A hook that can be overwritten by sub classes to implement logic that is called by the master after the job completed.
    
    Parameters:
    
    context - Provides contextual information for the initialization
    
    Throws:
    
    Exception - The method may throw exceptions which cause the job to fail immediately.
  - getOperatorName
```
public String getOperatorName()
```
  - setOperatorName
```
public void setOperatorName(String operatorName)
```
  - getOperatorDescription
```
public String getOperatorDescription()
```
  - setOperatorDescription
```
public void setOperatorDescription(String operatorDescription)
```
  - setOperatorPrettyName
```
public void setOperatorPrettyName(String operatorPrettyName)
```
  - getOperatorPrettyName
```
public String getOperatorPrettyName()
```
  - getResultOptimizerProperties
```
public String getResultOptimizerProperties()
```
  - setResultOptimizerProperties
```
public void setResultOptimizerProperties(String resultOptimizerProperties)
```
  - addIntermediateDataSetIdToConsume
```
public void addIntermediateDataSetIdToConsume(IntermediateDataSetID intermediateDataSetId)
```
  - getIntermediateDataSetIdsToConsume
```
public List<IntermediateDataSetID> getIntermediateDataSetIdsToConsume()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Back to Flink Website

Class JobVertex

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_PARALLELISM_DEFAULT

Constructor Detail

JobVertex

JobVertex

JobVertex

Method Detail

getID

getName

setName

getNumberOfProducedIntermediateDataSets

getNumberOfInputs

getOperatorIDs

getConfiguration

setInvokableClass

setParallelismConfigured

isParallelismConfigured

getInvokableClassName

getInvokableClass

getParallelism

setParallelism

getMaxParallelism

setMaxParallelism

getMinResources

getPreferredResources

setResources

getInputSplitSource

setInputSplitSource

getProducedDataSets

getInputs

getOperatorCoordinators

addOperatorCoordinator

setSlotSharingGroup

getSlotSharingGroup

setStrictlyCoLocatedWith

getCoLocationGroup

updateCoLocationGroup

getOrCreateResultDataSet

connectNewDataSetAsInput

connectNewDataSetAsInput

connectNewDataSetAsInput

isInputVertex

isStoppable

isOutputVertex

hasNoConnectedInputs

setSupportsConcurrentExecutionAttempts

isSupportsConcurrentExecutionAttempts

initializeOnMaster

finalizeOnMaster

getOperatorName

setOperatorName

getOperatorDescription

setOperatorDescription

setOperatorPrettyName

getOperatorPrettyName

getResultOptimizerProperties

setResultOptimizerProperties

addIntermediateDataSetIdToConsume

getIntermediateDataSetIdsToConsume

toString

Back to Flink Website