JobVertex (Flink : Runtime 1.16.0 API)

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

所有已实现的接口:

Serializable

直接已知子类:

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

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static interface JobVertex.InitializeOnMasterContext

嵌套类
限定符和类型	类和说明
`static interface`	`JobVertex.InitializeOnMasterContext`

字段概要

字段
限定符和类型字段和说明

static int MAX_PARALLELISM_DEFAULT

字段
限定符和类型	字段和说明
`static int`	`MAX_PARALLELISM_DEFAULT`

构造器概要

构造器
构造器和说明
`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.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addIntermediateDataSetIdToConsume(IntermediateDataSetID intermediateDataSetId)`
`void`	`addOperatorCoordinator(org.apache.flink.util.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)`
`boolean`	`containsSinks()`
`boolean`	`containsSources()`
`void`	`finalizeOnMaster(JobVertex.InitializeOnMasterContext 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()`
`org.apache.flink.configuration.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()`
`org.apache.flink.core.io.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.
`org.apache.flink.api.common.operators.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<org.apache.flink.util.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.
`org.apache.flink.api.common.operators.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`	`isStoppable()`
`void`	`markContainsSinks()`
`void`	`markContainsSources()`
`void`	`setInputSplitSource(org.apache.flink.core.io.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`	`setResources(org.apache.flink.api.common.operators.ResourceSpec minResources, org.apache.flink.api.common.operators.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.
`String`	`toString()`
`void`	`updateCoLocationGroup(CoLocationGroupImpl group)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - MAX_PARALLELISM_DEFAULT
```
public static final int MAX_PARALLELISM_DEFAULT
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - JobVertex
```
public JobVertex(String name)
```
    Constructs a new job vertex and assigns it with the given name.
    
    参数:
    
    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.
    
    参数:
    
    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.
    
    参数:
    
    name - The name of the new job vertex.
    
    primaryId - The id of the job vertex.
    
    operatorIDPairs - The operator ID pairs of the job vertex.
- 方法详细资料
  - getID
```
public JobVertexID getID()
```
    Returns the ID of this job vertex.
    
    返回:
    
    The ID of this job vertex
  - getName
```
public String getName()
```
    Returns the name of the vertex.
    
    返回:
    
    The name of the vertex.
  - setName
```
public void setName(String name)
```
    Sets the name of the vertex.
    
    参数:
    
    name - The new name.
  - getNumberOfProducedIntermediateDataSets
```
public int getNumberOfProducedIntermediateDataSets()
```
    Returns the number of produced intermediate data sets.
    
    返回:
    
    The number of produced intermediate data sets.
  - getNumberOfInputs
```
public int getNumberOfInputs()
```
    Returns the number of inputs.
    
    返回:
    
    The number of inputs.
  - getOperatorIDs
```
public List<OperatorIDPair> getOperatorIDs()
```
  - getConfiguration
```
public org.apache.flink.configuration.Configuration getConfiguration()
```
    Returns the vertex's configuration object which can be used to pass custom settings to the task at runtime.
    
    返回:
    
    the vertex's configuration object
  - setInvokableClass
```
public void setInvokableClass(Class<? extends TaskInvokable> invokable)
```
  - getInvokableClassName
```
public String getInvokableClassName()
```
    Returns the name of the invokable class which represents the task of this vertex.
    
    返回:
    
    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.
    
    参数:
    
    cl - The classloader used to resolve user-defined classes
    
    返回:
    
    The invokable class, null if it is not set
  - getParallelism
```
public int getParallelism()
```
    Gets the parallelism of the task.
    
    返回:
    
    The parallelism of the task.
  - setParallelism
```
public void setParallelism(int parallelism)
```
    Sets the parallelism for the task.
    
    参数:
    
    parallelism - The parallelism for the task.
  - getMaxParallelism
```
public int getMaxParallelism()
```
    Gets the maximum parallelism for the task.
    
    返回:
    
    The maximum parallelism for the task.
  - setMaxParallelism
```
public void setMaxParallelism(int maxParallelism)
```
    Sets the maximum parallelism for the task.
    
    参数:
    
    maxParallelism - The maximum parallelism to be set. must be between 1 and Short.MAX_VALUE.
  - getMinResources
```
public org.apache.flink.api.common.operators.ResourceSpec getMinResources()
```
    Gets the minimum resource for the task.
    
    返回:
    
    The minimum resource for the task.
  - getPreferredResources
```
public org.apache.flink.api.common.operators.ResourceSpec getPreferredResources()
```
    Gets the preferred resource for the task.
    
    返回:
    
    The preferred resource for the task.
  - setResources
```
public void setResources(org.apache.flink.api.common.operators.ResourceSpec minResources,
                         org.apache.flink.api.common.operators.ResourceSpec preferredResources)
```
    Sets the minimum and preferred resources for the task.
    
    参数:
    
    minResources - The minimum resource for the task.
    
    preferredResources - The preferred resource for the task.
  - getInputSplitSource
```
public org.apache.flink.core.io.InputSplitSource<?> getInputSplitSource()
```
  - setInputSplitSource
```
public void setInputSplitSource(org.apache.flink.core.io.InputSplitSource<?> inputSplitSource)
```
  - getProducedDataSets
```
public List<IntermediateDataSet> getProducedDataSets()
```
  - getInputs
```
public List<JobEdge> getInputs()
```
  - getOperatorCoordinators
```
public List<org.apache.flink.util.SerializedValue<OperatorCoordinator.Provider>> getOperatorCoordinators()
```
  - addOperatorCoordinator
```
public void addOperatorCoordinator(org.apache.flink.util.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.
    
    参数:
    
    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.
    
    返回:
    
    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.
    
    参数:
    
    strictlyCoLocatedWith - The vertex whose subtasks to co-locate this vertex's subtasks with.
    
    抛出:
    
    IllegalArgumentException - Thrown, if this vertex and the vertex to co-locate with are not in a common slot sharing group.
    
    另请参阅:
    
    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()
```
  - markContainsSources
```
public void markContainsSources()
```
  - containsSources
```
public boolean containsSources()
```
  - markContainsSinks
```
public void markContainsSinks()
```
  - containsSinks
```
public boolean containsSinks()
```
  - 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.
    
    参数:
    
    context - Provides contextual information for the initialization
    
    抛出:
    
    Exception - The method may throw exceptions which cause the job to fail immediately.
  - finalizeOnMaster
```
public void finalizeOnMaster(JobVertex.InitializeOnMasterContext 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.
    
    参数:
    
    context - Provides contextual information for the initialization
    
    抛出:
    
    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()
```
    覆盖:
    
    toString 在类中 Object

类 JobVertex

嵌套类概要

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

MAX_PARALLELISM_DEFAULT

构造器详细资料

JobVertex

JobVertex

JobVertex

方法详细资料

getID

getName

setName

getNumberOfProducedIntermediateDataSets

getNumberOfInputs

getOperatorIDs

getConfiguration

setInvokableClass

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

markContainsSources

containsSources

markContainsSinks

containsSinks

initializeOnMaster

finalizeOnMaster

getOperatorName

setOperatorName

getOperatorDescription

setOperatorDescription

setOperatorPrettyName

getOperatorPrettyName

getResultOptimizerProperties

setResultOptimizerProperties

addIntermediateDataSetIdToConsume

getIntermediateDataSetIdsToConsume

toString