Package org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint

Class TargetApplicationsNamespace

java.lang.Object

org.apache.hadoop.yarn.server.resourcemanager.scheduler.constraint.TargetApplicationsNamespace

All Implemented Interfaces:

Evaluable<TargetApplications>

Direct Known Subclasses:

TargetApplicationsNamespace.All, TargetApplicationsNamespace.AppID, TargetApplicationsNamespace.AppTag, TargetApplicationsNamespace.NotSelf, TargetApplicationsNamespace.Self

public abstract class TargetApplicationsNamespace
extends java.lang.Object
implements Evaluable<TargetApplications>

Class to describe the namespace of allocation tags, used by AllocationTags. Each namespace can be evaluated against a target set applications, represented by TargetApplications. After evaluation, the namespace is interpreted to be a set of applications based on the namespace type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TargetApplicationsNamespace.All	Namespace to all applications in the cluster.
static class	TargetApplicationsNamespace.AppID	Namespace defined by a certain application ID.
static class	TargetApplicationsNamespace.AppTag	Namespace to applications that attached with a certain application tag.
static class	TargetApplicationsNamespace.NotSelf	Namespace to all applications except itself.
static class	TargetApplicationsNamespace.Self	Namespace within application itself.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NAMESPACE_DELIMITER

Constructor Summary

Constructors

Constructor	Description
TargetApplicationsNamespace(org.apache.hadoop.yarn.api.records.AllocationTagNamespaceType allocationTagNamespaceType)

Method Summary

Modifier and Type	Method	Description
void	evaluate(TargetApplications target)	Evaluate the namespace against given target applications if it is necessary.
java.util.Set<org.apache.hadoop.yarn.api.records.ApplicationId>	getNamespaceScope()	Get the scope of the namespace, in form of a set of applications.
org.apache.hadoop.yarn.api.records.AllocationTagNamespaceType	getNamespaceType()	Get the type of the namespace.
static TargetApplicationsNamespace	parse(java.lang.String namespaceStr)	Parse namespace from a string.
protected void	setScopeIfNotNull(java.util.Set<org.apache.hadoop.yarn.api.records.ApplicationId> appIds)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NAMESPACE_DELIMITER

public static final java.lang.String NAMESPACE_DELIMITER

See Also:

Constant Field Values

Constructor Detail

TargetApplicationsNamespace

public TargetApplicationsNamespace(org.apache.hadoop.yarn.api.records.AllocationTagNamespaceType allocationTagNamespaceType)

Method Detail

setScopeIfNotNull

protected void setScopeIfNotNull(java.util.Set<org.apache.hadoop.yarn.api.records.ApplicationId> appIds)

getNamespaceType

public org.apache.hadoop.yarn.api.records.AllocationTagNamespaceType getNamespaceType()

Get the type of the namespace.

Returns:

namespace type.

getNamespaceScope

public java.util.Set<org.apache.hadoop.yarn.api.records.ApplicationId> getNamespaceScope()

Get the scope of the namespace, in form of a set of applications.

Returns:

a set of applications.

evaluate

public void evaluate(TargetApplications target)
              throws InvalidAllocationTagsQueryException

Evaluate the namespace against given target applications if it is necessary. Only self/not-self/app-label namespace types require this evaluation step, because they are not binding to a specific scope during initiating. So we do lazy binding for them in this method.

Specified by:

evaluate in interface Evaluable<TargetApplications>

Parameters:

target - a generic type target that impacts this evaluation.

Throws:

InvalidAllocationTagsQueryException - if given string is not in valid format.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

parse

public static TargetApplicationsNamespace parse(java.lang.String namespaceStr)
                                         throws InvalidAllocationTagsQueryException

Parse namespace from a string. The string must be in legal format defined by each AllocationTagNamespaceType.

Parameters:

namespaceStr - namespace string.

Returns:

an instance of TargetApplicationsNamespace.

Throws:

InvalidAllocationTagsQueryException - if given string is not in valid format