Package org.apache.flink.runtime.jobgraph

Class JobVertex

    • 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.

      • 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.
        Returns:
        the vertex's configuration object

      • setInvokableClass

        public void setInvokableClass​(Class<? extends TaskInvokable> invokable)

      • setParallelismConfigured

        public void setParallelismConfigured​(boolean parallelismConfigured)

      • isParallelismConfigured

        public boolean isParallelismConfigured()

      • setDynamicParallelism

        public void setDynamicParallelism​(int parallelism)

      • isDynamicParallelism

        public boolean isDynamicParallelism()

      • 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 + 1.

      • getMinResources

        public org.apache.flink.api.common.operators.ResourceSpec getMinResources()
        Gets the minimum resource for the task.
        Returns:
        The minimum resource for the task.

      • getPreferredResources

        public org.apache.flink.api.common.operators.ResourceSpec getPreferredResources()
        Gets the preferred resource for the task.
        Returns:
        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.
        Parameters:
        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)

      • 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.
        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()

      • 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()

      • isAnyOutputBlocking

        public boolean isAnyOutputBlocking()

      • 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)