Package org.apache.hadoop.yarn.api.records

Class ExecutionTypeRequest

java.lang.Object

org.apache.hadoop.yarn.api.records.ExecutionTypeRequest

All Implemented Interfaces:

java.lang.Comparable<ExecutionTypeRequest>

@Public
@Evolving
public abstract class ExecutionTypeRequest
extends java.lang.Object
implements java.lang.Comparable<ExecutionTypeRequest>

An object of this class represents a specification of the execution guarantee of the Containers associated with a ResourceRequest. It consists of an ExecutionType as well as flag that explicitly asks the configuredScheduler to return Containers of exactly the Execution Type requested.

Constructor Summary

Constructors

Constructor	Description
ExecutionTypeRequest()

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
abstract boolean	getEnforceExecutionType()	Get whether Scheduling Authority should return Containers of exactly the Execution Type requested for this ResourceRequest.
abstract ExecutionType	getExecutionType()	Get ExecutionType.
int	hashCode()
static ExecutionTypeRequest	newInstance()
static ExecutionTypeRequest	newInstance(ExecutionType execType)
static ExecutionTypeRequest	newInstance(ExecutionType execType, boolean ensureExecutionType)
abstract void	setEnforceExecutionType(boolean enforceExecutionType)	Set to true to explicitly ask that the Scheduling Authority return Containers of exactly the Execution Type requested.
abstract void	setExecutionType(ExecutionType execType)	Set the ExecutionType of the requested container.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

ExecutionTypeRequest

public ExecutionTypeRequest()

Method Detail

newInstance

@Public
@Evolving
public static ExecutionTypeRequest newInstance()

newInstance

@Public
@Evolving
public static ExecutionTypeRequest newInstance(ExecutionType execType)

newInstance

@Public
@Evolving
public static ExecutionTypeRequest newInstance(ExecutionType execType,
                                               boolean ensureExecutionType)

setExecutionType

@Public
public abstract void setExecutionType(ExecutionType execType)

Set the ExecutionType of the requested container.

Parameters:

execType - ExecutionType of the requested container

getExecutionType

@Public
public abstract ExecutionType getExecutionType()

Get ExecutionType.

Returns:

ExecutionType.

setEnforceExecutionType

@Public
public abstract void setEnforceExecutionType(boolean enforceExecutionType)

Set to true to explicitly ask that the Scheduling Authority return Containers of exactly the Execution Type requested.

Parameters:

enforceExecutionType - whether ExecutionType request should be strictly honored.

getEnforceExecutionType

@Public
public abstract boolean getEnforceExecutionType()

Get whether Scheduling Authority should return Containers of exactly the Execution Type requested for this ResourceRequest. Defaults to false.

Returns:

whether ExecutionType request should be strictly honored

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object