Package org.apache.flink.runtime.jobgraph

Class JobResourceRequirements

java.lang.Object

org.apache.flink.runtime.jobgraph.JobResourceRequirements

All Implemented Interfaces:

Serializable

public class JobResourceRequirements
extends Object
implements Serializable

Information about the parallelism of job vertices.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	JobResourceRequirements.Builder

Constructor Summary

Constructors

Constructor	Description
JobResourceRequirements(Map<JobVertexID,JobVertexResourceRequirements> vertexResources)

Method Summary

Modifier and Type	Method	Description
static JobResourceRequirements	empty()
boolean	equals(Object o)
Map<JobVertexID,JobVertexResourceRequirements>	getJobVertexParallelisms()
Set<JobVertexID>	getJobVertices()
JobVertexResourceRequirements.Parallelism	getParallelism(JobVertexID jobVertexId)
int	hashCode()
static JobResourceRequirements.Builder	newBuilder()
static Optional<JobResourceRequirements>	readFromExecutionPlan(ExecutionPlan executionPlan)	Read resource requirements from the configuration of a given ExecutionPlan.
String	toString()
static List<String>	validate(JobResourceRequirements jobResourceRequirements, Map<JobVertexID,Integer> maxParallelismPerVertex)	This method validates that: The requested boundaries are less or equal than the max parallelism.
static void	writeToExecutionPlan(ExecutionPlan executionPlan, JobResourceRequirements jobResourceRequirements)	Write resource requirements into the configuration of a given ExecutionPlan.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

JobResourceRequirements

public JobResourceRequirements(Map<JobVertexID,JobVertexResourceRequirements> vertexResources)

Method Details

writeToExecutionPlan

public static void writeToExecutionPlan(ExecutionPlan executionPlan,
 JobResourceRequirements jobResourceRequirements)
                                 throws IOException

Write resource requirements into the configuration of a given ExecutionPlan.

Parameters:

executionPlan - executionPlan to write requirements to

jobResourceRequirements - resource requirements to write

Throws:

IOException - in case we're not able to serialize requirements into the configuration

readFromExecutionPlan

public static Optional<JobResourceRequirements> readFromExecutionPlan(ExecutionPlan executionPlan)
                                                               throws IOException

Read resource requirements from the configuration of a given ExecutionPlan.

Parameters:

executionPlan - execution plan to read requirements from

Throws:

IOException - in case we're not able to deserialize requirements from the configuration

validate

public static List<String> validate(JobResourceRequirements jobResourceRequirements,
 Map<JobVertexID,Integer> maxParallelismPerVertex)

This method validates that:

• The requested boundaries are less or equal than the max parallelism.
• The requested boundaries are greater than zero.
• The requested upper bound is greater than the lower bound.
• There are no unknown job vertex ids and that we're not missing any.

In case any boundary is set to -1, it will be expanded to the default value ( 1 for the lower bound and the max parallelism for the upper bound), before the validation.

Parameters:

jobResourceRequirements - contains the new resources requirements for the job vertices

maxParallelismPerVertex - allows us to look up maximum possible parallelism for a job vertex

Returns:

a list of validation errors

empty

public static JobResourceRequirements empty()

newBuilder

public static JobResourceRequirements.Builder newBuilder()

getParallelism

public JobVertexResourceRequirements.Parallelism getParallelism(JobVertexID jobVertexId)

getJobVertices

public Set<JobVertexID> getJobVertices()

getJobVertexParallelisms

public Map<JobVertexID,JobVertexResourceRequirements> getJobVertexParallelisms()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object