JobGraph (flink-runtime 1.8.2 API)

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

所有已实现的接口:

Serializable
```
public class JobGraph
extends Object
implements Serializable
```
The JobGraph represents a Flink dataflow program, at the low level that the JobManager accepts. All programs from higher level APIs are transformed into JobGraphs.
The JobGraph is a graph of vertices and intermediate results that are connected together to form a DAG. Note that iterations (feedback edges) are currently not encoded inside the JobGraph but inside certain special vertices that establish the feedback channel amongst themselves.
The JobGraph defines the job-wide configuration settings, while each vertex and intermediate result define the characteristics of the concrete operation and intermediate data.

另请参阅:

序列化表格

构造器概要

构造器
构造器和说明
`JobGraph(org.apache.flink.api.common.JobID jobId, String jobName)` Constructs a new job graph with the given job ID (or a random ID, if `null` is passed), the given name and the given execution configuration (see `ExecutionConfig`).
`JobGraph(org.apache.flink.api.common.JobID jobId, String jobName, JobVertex... vertices)` Constructs a new job graph with the given name, the given `ExecutionConfig`, the given jobId or a random one if null supplied, and the given job vertices.
`JobGraph(JobVertex... vertices)` Constructs a new job graph with no name, a random job ID, the given `ExecutionConfig`, and the given job vertices.
`JobGraph(String jobName)` Constructs a new job graph with the given name, the given `ExecutionConfig`, and a random job ID.
`JobGraph(String jobName, JobVertex... vertices)` Constructs a new job graph with the given name, the given `ExecutionConfig`, a random job ID, and the given job vertices.

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addJar(org.apache.flink.core.fs.Path jar)` Adds the path of a JAR file required to run the job on a task manager.
`void`	`addUserArtifact(String name, org.apache.flink.api.common.cache.DistributedCache.DistributedCacheEntry file)` Adds the path of a custom file required to run the job on a task manager.
`void`	`addUserJarBlobKey(PermanentBlobKey key)` Adds the BLOB referenced by the key to the JobGraph's dependencies.
`void`	`addVertex(JobVertex vertex)` Adds a new task vertex to the job graph if it is not already included.
`JobVertex`	`findVertexByID(JobVertexID id)` Searches for a vertex with a matching ID and returns it.
`boolean`	`getAllowQueuedScheduling()`
`JobCheckpointingSettings`	`getCheckpointingSettings()` Gets the settings for asynchronous snapshots.
`List<URL>`	`getClasspaths()`
`org.apache.flink.configuration.Configuration`	`getJobConfiguration()` Returns the configuration object for this job.
`org.apache.flink.api.common.JobID`	`getJobID()` Returns the ID of the job.
`int`	`getMaximumParallelism()` Gets the maximum parallelism of all operations in this job graph.
`String`	`getName()` Returns the name assigned to the job graph.
`int`	`getNumberOfVertices()` Returns the number of all vertices.
`SavepointRestoreSettings`	`getSavepointRestoreSettings()` Returns the configured savepoint restore setting.
`ScheduleMode`	`getScheduleMode()`
`org.apache.flink.util.SerializedValue<org.apache.flink.api.common.ExecutionConfig>`	`getSerializedExecutionConfig()` Returns the `ExecutionConfig`
`long`	`getSessionTimeout()` Gets the timeout after which the corresponding ExecutionGraph is removed at the job manager after it has been executed.
`Map<String,org.apache.flink.api.common.cache.DistributedCache.DistributedCacheEntry>`	`getUserArtifacts()` Gets the list of assigned user jar paths.
`List<PermanentBlobKey>`	`getUserJarBlobKeys()` Returns a set of BLOB keys referring to the JAR files required to run this job.
`List<org.apache.flink.core.fs.Path>`	`getUserJars()` Gets the list of assigned user jar paths.
`Iterable<JobVertex>`	`getVertices()` Returns an Iterable to iterate all vertices registered with the job graph.
`JobVertex[]`	`getVerticesAsArray()` Returns an array of all job vertices that are registered with the job graph.
`List<JobVertex>`	`getVerticesSortedTopologicallyFromSources()`
`boolean`	`hasUsercodeJarFiles()` Checks whether the JobGraph has user code JAR files attached.
`boolean`	`isCheckpointingEnabled()` Checks if the checkpointing was enabled for this job graph
`void`	`setAllowQueuedScheduling(boolean allowQueuedScheduling)`
`void`	`setClasspaths(List<URL> paths)` Sets the classpaths required to run the job on a task manager.
`void`	`setExecutionConfig(org.apache.flink.api.common.ExecutionConfig executionConfig)` Sets the execution config.
`void`	`setSavepointRestoreSettings(SavepointRestoreSettings settings)` Sets the savepoint restore settings.
`void`	`setScheduleMode(ScheduleMode scheduleMode)`
`void`	`setSessionTimeout(long sessionTimeout)` Sets the timeout of the session in seconds.
`void`	`setSnapshotSettings(JobCheckpointingSettings settings)` Sets the settings for asynchronous snapshots.
`void`	`setUserArtifactBlobKey(String entryName, PermanentBlobKey blobKey)`
`String`	`toString()`
`void`	`writeUserArtifactEntriesToConfiguration()`

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

- 构造器详细资料
  - JobGraph
```
public JobGraph(String jobName)
```
    Constructs a new job graph with the given name, the given ExecutionConfig, and a random job ID. The ExecutionConfig will be serialized and can't be modified afterwards.
    
    参数:
    
    jobName - The name of the job.
  - JobGraph
```
public JobGraph(org.apache.flink.api.common.JobID jobId,
                String jobName)
```
    Constructs a new job graph with the given job ID (or a random ID, if null is passed), the given name and the given execution configuration (see ExecutionConfig). The ExecutionConfig will be serialized and can't be modified afterwards.
    
    参数:
    
    jobId - The id of the job. A random ID is generated, if null is passed.
    
    jobName - The name of the job.
  - JobGraph
```
public JobGraph(JobVertex... vertices)
```
    Constructs a new job graph with no name, a random job ID, the given ExecutionConfig, and the given job vertices. The ExecutionConfig will be serialized and can't be modified afterwards.
    
    参数:
    
    vertices - The vertices to add to the graph.
  - JobGraph
```
public JobGraph(String jobName,
                JobVertex... vertices)
```
    Constructs a new job graph with the given name, the given ExecutionConfig, a random job ID, and the given job vertices. The ExecutionConfig will be serialized and can't be modified afterwards.
    
    参数:
    
    jobName - The name of the job.
    
    vertices - The vertices to add to the graph.
  - JobGraph
```
public JobGraph(org.apache.flink.api.common.JobID jobId,
                String jobName,
                JobVertex... vertices)
```
    Constructs a new job graph with the given name, the given ExecutionConfig, the given jobId or a random one if null supplied, and the given job vertices. The ExecutionConfig will be serialized and can't be modified afterwards.
    
    参数:
    
    jobId - The id of the job. A random ID is generated, if null is passed.
    
    jobName - The name of the job.
    
    vertices - The vertices to add to the graph.
- 方法详细资料
  - getJobID
```
public org.apache.flink.api.common.JobID getJobID()
```
    Returns the ID of the job.
    
    返回:
    
    the ID of the job
  - getName
```
public String getName()
```
    Returns the name assigned to the job graph.
    
    返回:
    
    the name assigned to the job graph
  - getJobConfiguration
```
public org.apache.flink.configuration.Configuration getJobConfiguration()
```
    Returns the configuration object for this job. Job-wide parameters should be set into that configuration object.
    
    返回:
    
    The configuration object for this job.
  - getSerializedExecutionConfig
```
public org.apache.flink.util.SerializedValue<org.apache.flink.api.common.ExecutionConfig> getSerializedExecutionConfig()
```
    Returns the ExecutionConfig
    
    返回:
    
    ExecutionConfig
  - getSessionTimeout
```
public long getSessionTimeout()
```
    Gets the timeout after which the corresponding ExecutionGraph is removed at the job manager after it has been executed.
    
    返回:
    
    a timeout as a long in seconds.
  - setSessionTimeout
```
public void setSessionTimeout(long sessionTimeout)
```
    Sets the timeout of the session in seconds. The timeout specifies how long a job will be kept in the job manager after it finishes.
    
    参数:
    
    sessionTimeout - The timeout in seconds
  - setAllowQueuedScheduling
```
public void setAllowQueuedScheduling(boolean allowQueuedScheduling)
```
  - getAllowQueuedScheduling
```
public boolean getAllowQueuedScheduling()
```
  - setScheduleMode
```
public void setScheduleMode(ScheduleMode scheduleMode)
```
  - getScheduleMode
```
public ScheduleMode getScheduleMode()
```
  - setSavepointRestoreSettings
```
public void setSavepointRestoreSettings(SavepointRestoreSettings settings)
```
    Sets the savepoint restore settings.
    
    参数:
    
    settings - The savepoint restore settings.
  - getSavepointRestoreSettings
```
public SavepointRestoreSettings getSavepointRestoreSettings()
```
    Returns the configured savepoint restore setting.
    
    返回:
    
    The configured savepoint restore settings.
  - setExecutionConfig
```
public void setExecutionConfig(org.apache.flink.api.common.ExecutionConfig executionConfig)
                        throws IOException
```
    Sets the execution config. This method eagerly serialized the ExecutionConfig for future RPC transport. Further modification of the referenced ExecutionConfig object will not affect this serialized copy.
    
    参数:
    
    executionConfig - The ExecutionConfig to be serialized.
    
    抛出:
    
    IOException - Thrown if the serialization of the ExecutionConfig fails
  - addVertex
```
public void addVertex(JobVertex vertex)
```
    Adds a new task vertex to the job graph if it is not already included.
    
    参数:
    
    vertex - the new task vertex to be added
  - getVertices
```
public Iterable<JobVertex> getVertices()
```
    Returns an Iterable to iterate all vertices registered with the job graph.
    
    返回:
    
    an Iterable to iterate all vertices registered with the job graph
  - getVerticesAsArray
```
public JobVertex[] getVerticesAsArray()
```
    Returns an array of all job vertices that are registered with the job graph. The order in which the vertices appear in the list is not defined.
    
    返回:
    
    an array of all job vertices that are registered with the job graph
  - getNumberOfVertices
```
public int getNumberOfVertices()
```
    Returns the number of all vertices.
    
    返回:
    
    The number of all vertices.
  - setSnapshotSettings
```
public void setSnapshotSettings(JobCheckpointingSettings settings)
```
    Sets the settings for asynchronous snapshots. A value of null means that snapshotting is not enabled.
    
    参数:
    
    settings - The snapshot settings
  - getCheckpointingSettings
```
public JobCheckpointingSettings getCheckpointingSettings()
```
    Gets the settings for asynchronous snapshots. This method returns null, when checkpointing is not enabled.
    
    返回:
    
    The snapshot settings
  - isCheckpointingEnabled
```
public boolean isCheckpointingEnabled()
```
    Checks if the checkpointing was enabled for this job graph
    
    返回:
    
    true if checkpointing enabled
  - findVertexByID
```
public JobVertex findVertexByID(JobVertexID id)
```
    Searches for a vertex with a matching ID and returns it.
    
    参数:
    
    id - the ID of the vertex to search for
    
    返回:
    
    the vertex with the matching ID or null if no vertex with such ID could be found
  - setClasspaths
```
public void setClasspaths(List<URL> paths)
```
    Sets the classpaths required to run the job on a task manager.
    
    参数:
    
    paths - paths of the directories/JAR files required to run the job on a task manager
  - getClasspaths
```
public List<URL> getClasspaths()
```
  - getMaximumParallelism
```
public int getMaximumParallelism()
```
    Gets the maximum parallelism of all operations in this job graph.
    
    返回:
    
    The maximum parallelism of this job graph
  - getVerticesSortedTopologicallyFromSources
```
public List<JobVertex> getVerticesSortedTopologicallyFromSources()
                                                          throws org.apache.flink.api.common.InvalidProgramException
```
    抛出:
    
    org.apache.flink.api.common.InvalidProgramException
  - addJar
```
public void addJar(org.apache.flink.core.fs.Path jar)
```
    Adds the path of a JAR file required to run the job on a task manager.
    
    参数:
    
    jar - path of the JAR file required to run the job on a task manager
  - getUserJars
```
public List<org.apache.flink.core.fs.Path> getUserJars()
```
    Gets the list of assigned user jar paths.
    
    返回:
    
    The list of assigned user jar paths
  - addUserArtifact
```
public void addUserArtifact(String name,
                            org.apache.flink.api.common.cache.DistributedCache.DistributedCacheEntry file)
```
    Adds the path of a custom file required to run the job on a task manager.
    
    参数:
    
    name - a name under which this artifact will be accessible through DistributedCache
    
    file - path of a custom file required to run the job on a task manager
  - getUserArtifacts
```
public Map<String,org.apache.flink.api.common.cache.DistributedCache.DistributedCacheEntry> getUserArtifacts()
```
    Gets the list of assigned user jar paths.
    
    返回:
    
    The list of assigned user jar paths
  - addUserJarBlobKey
```
public void addUserJarBlobKey(PermanentBlobKey key)
```
    Adds the BLOB referenced by the key to the JobGraph's dependencies.
    
    参数:
    
    key - path of the JAR file required to run the job on a task manager
  - hasUsercodeJarFiles
```
public boolean hasUsercodeJarFiles()
```
    Checks whether the JobGraph has user code JAR files attached.
    
    返回:
    
    True, if the JobGraph has user code JAR files attached, false otherwise.
  - getUserJarBlobKeys
```
public List<PermanentBlobKey> getUserJarBlobKeys()
```
    Returns a set of BLOB keys referring to the JAR files required to run this job.
    
    返回:
    
    set of BLOB keys referring to the JAR files required to run this job
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object
  - setUserArtifactBlobKey
```
public void setUserArtifactBlobKey(String entryName,
                                   PermanentBlobKey blobKey)
                            throws IOException
```
    抛出:
    
    IOException
  - writeUserArtifactEntriesToConfiguration
```
public void writeUserArtifactEntriesToConfiguration()
```

类 JobGraph

构造器概要

方法概要

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

构造器详细资料

JobGraph

JobGraph

JobGraph

JobGraph

JobGraph

方法详细资料

getJobID

getName

getJobConfiguration

getSerializedExecutionConfig

getSessionTimeout

setSessionTimeout

setAllowQueuedScheduling

getAllowQueuedScheduling

setScheduleMode

getScheduleMode

setSavepointRestoreSettings

getSavepointRestoreSettings

setExecutionConfig

addVertex

getVertices

getVerticesAsArray

getNumberOfVertices

setSnapshotSettings

getCheckpointingSettings

isCheckpointingEnabled

findVertexByID

setClasspaths

getClasspaths

getMaximumParallelism

getVerticesSortedTopologicallyFromSources

addJar

getUserJars

addUserArtifact

getUserArtifacts

addUserJarBlobKey

hasUsercodeJarFiles

getUserJarBlobKeys

toString

setUserArtifactBlobKey

writeUserArtifactEntriesToConfiguration