org.apache.slider.server.appmaster.state

Class OutstandingRequest

java.lang.Object

org.apache.slider.server.appmaster.state.RoleHostnamePair

org.apache.slider.server.appmaster.state.OutstandingRequest

public final class OutstandingRequest
extends RoleHostnamePair

Tracks an outstanding request. This is used to correlate an allocation response with the node and role used in the request.

The node identifier may be null -which indicates that a request was made without a specific target node

Equality and the hash code are based only on the role and hostname, which are fixed in the constructor. This means that a simple instance constructed with (role, hostname) can be used to look up a complete request instance in the OutstandingRequestTracker map

Field Summary

Fields

Modifier and Type	Field and Description
String	label Optional label.
protected static org.slf4j.Logger	log
NodeInstance	node Node the request is for -may be null
List<NodeInstance>	nodes A list of all possible nodes to list in an AA request.

Fields inherited from class org.apache.slider.server.appmaster.state.RoleHostnamePair

hostname, roleId

Constructor Summary

Constructors

Constructor and Description
OutstandingRequest(int roleId, List<NodeInstance> nodes) Create an Anti-affine reques, including all listed nodes (there must be one) as targets.
OutstandingRequest(int roleId, NodeInstance node) Create a request
OutstandingRequest(int roleId, String hostname) Create an outstanding request with the given role and hostname Important: this is useful only for map lookups -the other constructor with the NodeInstance parameter is needed to generate node-specific container requests

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest	buildContainerRequest(org.apache.hadoop.yarn.api.records.Resource resource, RoleStatus role, long time) Build a container request.
void	completed() Mark the request as completed (or canceled).
CancelSingleRequest	createCancelOperation() Create a cancel operation
org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest	escalate() Build an escalated container request, updating issuedRequest with the new value.
long	getEscalationTimeoutMillis()
RoleHostnamePair	getIndex() Create a new role/hostname pair for indexing.
org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest	getIssuedRequest()
int	getPriority()
long	getRequestedTimeMillis()
boolean	isAntiAffine()
boolean	isEscalated()
boolean	isLocated() Is the request located in the cluster, that is: does it have a node.
boolean	mayEscalate()
boolean	resourceRequirementsMatch(org.apache.hadoop.yarn.api.records.Resource resource) Query for the resource requirements matching; always false before a request is issued
void	setAntiAffine(boolean antiAffine)
boolean	shouldEscalate(long time) Query to see if the request is available and ready to be escalated
String	toString()
void	validate() Valid if a node label expression specified on container request is valid or not.

Methods inherited from class org.apache.slider.server.appmaster.state.RoleHostnamePair

equals, getHostname, getRoleId, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static final org.slf4j.Logger log

node

public final NodeInstance node

Node the request is for -may be null

nodes

public final List<NodeInstance> nodes

A list of all possible nodes to list in an AA request. For a non-AA request where node is set, element 0 of the list is the same value.

label

public String label

Optional label. This is cached as the request option (explicit-location + label) is forbidden, yet the label needs to be retained for escalation.

Constructor Detail

OutstandingRequest

public OutstandingRequest(int roleId,
                  NodeInstance node)

Create a request

Parameters:

roleId - role

node - node -can be null

OutstandingRequest

public OutstandingRequest(int roleId,
                  String hostname)

Create an outstanding request with the given role and hostname Important: this is useful only for map lookups -the other constructor with the NodeInstance parameter is needed to generate node-specific container requests

Parameters:

roleId - role

hostname - hostname

OutstandingRequest

public OutstandingRequest(int roleId,
                  List<NodeInstance> nodes)

Create an Anti-affine reques, including all listed nodes (there must be one) as targets.

Parameters:

roleId - role

nodes - list of nodes

Method Detail

isLocated

public boolean isLocated()

Is the request located in the cluster, that is: does it have a node.

Returns:

true if a node instance was supplied in the constructor

getRequestedTimeMillis

public long getRequestedTimeMillis()

getEscalationTimeoutMillis

public long getEscalationTimeoutMillis()

isEscalated

public boolean isEscalated()

mayEscalate

public boolean mayEscalate()

getIssuedRequest

public org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest getIssuedRequest()

getPriority

public int getPriority()

isAntiAffine

public boolean isAntiAffine()

setAntiAffine

public void setAntiAffine(boolean antiAffine)

buildContainerRequest

public org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest buildContainerRequest(org.apache.hadoop.yarn.api.records.Resource resource,
                                                                                  RoleStatus role,
                                                                                  long time)

Build a container request.

The value of node is used to direct a lot of policy. If null, placement is relaxed. If not null, the choice of whether to use the suggested node is based on the placement policy and failure history.

If the request has an address, it is set in the container request (with a flag to enable relaxed priorities).

This operation sets the requested time flag, used for tracking timeouts on outstanding requests

Parameters:

resource - resource

role - role

time - time in millis to record as request time

Returns:

the request to raise

escalate

public org.apache.hadoop.yarn.client.api.AMRMClient.ContainerRequest escalate()

Build an escalated container request, updating issuedRequest with the new value.

Returns:

the new container request, which has the same resource and label requirements as the original one, and the same host, but: relaxed placement, and a changed priority so as to place it into the relaxed list.

completed

public void completed()

Mark the request as completed (or canceled).

Current action: if a node is defined, its request count is decremented

shouldEscalate

public boolean shouldEscalate(long time)

Query to see if the request is available and ready to be escalated

Parameters:

time - time to check against

Returns:

true if escalation should begin

resourceRequirementsMatch

public boolean resourceRequirementsMatch(org.apache.hadoop.yarn.api.records.Resource resource)

Query for the resource requirements matching; always false before a request is issued

Parameters:

resource -

Returns:

toString

public String toString()

Overrides:

toString in class RoleHostnamePair

createCancelOperation

public CancelSingleRequest createCancelOperation()

Create a cancel operation

Returns:

an operation that can be used to cancel the request

validate

public void validate()
              throws org.apache.hadoop.yarn.client.api.InvalidContainerRequestException

Valid if a node label expression specified on container request is valid or not. Mimics the logic in AMRMClientImpl, so can be used for preflight checking and in mock tests

Throws:

org.apache.hadoop.yarn.client.api.InvalidContainerRequestException

getIndex

public RoleHostnamePair getIndex()

Create a new role/hostname pair for indexing.

Returns:

a new index.