All Classes and Interfaces
Class
Description
The core request sent by the
ApplicationMaster to the
ResourceManager to obtain resources in the cluster.Class to construct instances of
AllocateRequest with specific
options.The response sent by the
ResourceManager the
ApplicationMaster during resource negotiation.Class to construct instances of
AllocateResponse with specific
options.Class to describe all supported forms of namespaces for an allocation tag.
Command sent by the Resource Manager to the Application Master in the
AllocateResponse
Application access types.
This entity represents an application attempt.
ApplicationAttemptId denotes the particular attempt
of an ApplicationMaster for a given ApplicationId.This exception is thrown on
(GetApplicationAttemptReportRequest)
API when the Application Attempt doesn't exist in Application History Server or
ApplicationMasterProtocol.allocate(AllocateRequest) if application
doesn't exist in RM.ApplicationAttemptReport is a report of an application attempt.
The protocol between clients and the
ResourceManager or
ApplicationHistoryServer to get information on applications,
application attempts and containers.The protocol between clients and the
ResourceManager
to submit/abort jobs and to get information on applications, cluster metrics,
nodes, queues and ACLs.This is the API for the applications comprising of constants that YARN sets
up for the applications and the containers.
The type of launch for the container.
Environment for Applications.
This entity represents an application.
The protocol between clients and the
ApplicationHistoryServer to
get the information of completed applications etc.ApplicationId represents the globally unique
identifier for an application.Exception to be thrown when Client submit an application without
providing
ApplicationId in ApplicationSubmissionContext.Initialization context for
AuxiliaryService when starting an
application.This exception is thrown when an Application Master tries to unregister by calling
ApplicationMasterProtocol.finishApplicationMaster(FinishApplicationMasterRequest)
API without first registering by calling
ApplicationMasterProtocol.registerApplicationMaster(RegisterApplicationMasterRequest)
or after an RM restart.The protocol between a live instance of
ApplicationMaster
and the ResourceManager.This is a marker interface for a context object that is injected into
the ApplicationMasterService processor.
Interface to abstract out the the actual processing logic of the
Application Master Service.
Utility methods to be used by
ApplicationMasterServiceProcessor.This exception is thrown on
(GetApplicationReportRequest) API
when the Application doesn't exist in RM and AHSApplicationReport is a report of an application.Contains various scheduling metrics to be reported by UI and CLI.
Enumeration that controls the scope of applications fetched
ApplicationSubmissionContext represents all of the
information needed by the ResourceManager to launch
the ApplicationMaster for an application.Initialization context for
AuxiliaryService when stopping an
application.ApplicationTimeout is a report for configured application timeouts.Application timeout type.
Type of node to attribute mapping operation.
An Interface that can retrieve local directories to read from or write to.
A generic service that will be started by the NodeManager.
In Federation mode,
we will support batch save queues policies to FederationStateStore.
The request issued by the client to the
ResourceManager to cancel a
delegation token.The response from the
ResourceManager to a cancelDelegationToken
request.
The protocol between clients and the
SharedCacheManager to claim
and release resources in the shared cache.This entity represents a YARN cluster.
Collector info containing collector address and collector token passed from
RM to AM in Allocate Response.
Response to Commit Container Request.
This exception is thrown on unrecoverable configuration errors.
Container represents an allocated resource in the cluster.Base context class for
AuxiliaryService initializing and stopping a
container.This entity represents a container belonging to an application attempt.
Container exit statuses indicating special exit circumstances.
ContainerId represents a globally unique identifier
for a Container in the cluster.Initialization context for
AuxiliaryService when starting a
container.ContainerLaunchContext represents all of the information
needed by the NodeManager to launch a container.This API is used by NodeManager to decide if a given container's logs
should be aggregated at run time.
Context class for
ContainerLogAggregationPolicy.The protocol between an
ApplicationMaster and a
NodeManager to start/stop and increase resource of containers
and to get status of running containers.This exception is thrown on
(GetContainerReportRequest)
API when the container doesn't exist in AHSContainerReport is a report of an container.ContainerRetryContext indicates how container retry after it fails
to run.Retry policy for relaunching a
Container.State of a
Container.ContainerStatus represents the current status of a
Container.Container Sub-State.
Termination context for
AuxiliaryService when stopping a
container.Container property encoding allocation and execution semantics.
The request sent by
Application Master to the
Node Manager to change the resource quota of a container.
The response sent by the
NodeManager to the
ApplicationMaster when asked to update container resource.Encodes the type of Container Update.
Interface for the CSI adaptor protocol.
csi-adaptor is a plugin, user can provide customized implementation
according to this interface.
CSI adaptor delegates all the calls from YARN to a CSI driver.
Utility class for CSI in the API level.
Specifies the different types of decommissioning of nodes.
This class is used for cleaning up an application that exists in the FederationStateStore.
This class is used for handling queue policy deletion requests,
which include the queues that need to be removed.
This class is utilized for responding to queue deletion requests
and includes the provision of return information.
Enhanced head room in AllocateResponse.
Container property encoding execution semantics.
An object of this class represents a specification of the execution
guarantee of the Containers associated with a ResourceRequest.
The request sent by the client to the
ResourceManager
to fail an application attempt.The response sent by the
ResourceManager to the client
failing an application attempt.Queue weights for representing Federation.
Federation SubClusters.
Enumeration of various final states of an
Application.The finalization request sent by the
ApplicationMaster to
inform the ResourceManager about its completion.The response sent by the
ResourceManager to a
ApplicationMaster on it's completion.Entity that represents a record for flow activity.
This entity represents a flow run.
Request class for getting all the resource profiles from the RM.
Response class for getting all the resource profiles from the RM.
Request class for getting all the resource profiles from the RM.
Response class for getting all the resource profiles from the RM.
The request sent by a client to the
ResourceManager to get an
ApplicationAttemptReport for an application attempt.
The response sent by the
ResourceManager to a client requesting
an application attempt report.
The request from clients to get a list of application attempt reports of an
application from the
ResourceManager.
The response sent by the
ResourceManager to a client requesting
a list of ApplicationAttemptReport for application attempts.The request sent by a client to the
ResourceManager to
get an ApplicationReport for an application.The response sent by the
ResourceManager to a client
requesting an application report.The request from clients to get a report of Applications
in the cluster from the
ResourceManager.The response sent by the
ResourceManager to a client
requesting an ApplicationReport for applications.
The request from clients to get node to attribute value mapping for all or
given set of Node AttributeKey's in the cluster from the
ResourceManager.
The response sent by the
ResourceManager to a client requesting
node to attribute value mapping for all or given set of Node AttributeKey's.The request sent by clients to get cluster metrics from the
ResourceManager.The response sent by the
ResourceManager to a client
requesting cluster metrics.
The request from clients to get node attributes in the cluster from the
ResourceManager.
The response sent by the
ResourceManager to a client requesting
a node attributes in cluster.The request from clients to get a report of all nodes
in the cluster from the
ResourceManager.The response sent by the
ResourceManager to a client
requesting a NodeReport for all nodes.
The request sent by a client to the
ResourceManager to get an
ContainerReport for a container.
The response sent by the
ResourceManager to a client requesting
a container report.
The request from clients to get a list of container reports, which belong to
an application attempt from the
ResourceManager.
The response sent by the
ResourceManager to a client requesting
a list of ContainerReport for containers.The request sent by the
ApplicationMaster to the
NodeManager to get ContainerStatus of requested
containers.The response sent by the
NodeManager to the
ApplicationMaster when asked to obtain the
ContainerStatus of requested containers.The request issued by the client to get a delegation token from
the
ResourceManager.Response to a
GetDelegationTokenRequest request
from the client.The request sent by an application master to the node manager to get
LocalizationStatuses of containers.The response sent by the node manager to an application master when
localization statuses are requested.
The request sent by clients to get a new
ApplicationId for
submitting an application.The response sent by the
ResourceManager to the client for
a request to get a new ApplicationId for submitting applications.The request sent by clients to get a new
ReservationId for
submitting an reservation.The response sent by the
ResourceManager to the client for
a request to get a new ReservationId for submitting reservations.
The request from clients to get nodes to attributes mapping
in the cluster from the
ResourceManager.
The response sent by the
ResourceManager to a client requesting
nodes to attributes mapping.Get plugin info request.
Get plugin info response.
The request sent by clients to get queue information
from the
ResourceManager.The response sent by the
ResourceManager to a client
requesting information about queues in the system.The request sent by clients to the
ResourceManager to
get queue acls for the current user.The response sent by the
ResourceManager to clients
seeking queue acls for the user.Request class for getting the details for a particular resource profile.
Response class for getting the details for a particular resource profile.
This class extends timeline entity and defines parent-child relationships
with other entities.
The request sent by
Application Master to the
Node Manager to change the resource quota of a container.
The response sent by the
NodeManager to the
ApplicationMaster when asked to increase container resource.This exception is thrown when an ApplicationMaster asks for resources by
calling
ApplicationMasterProtocol.allocate(AllocateRequest)
without first registering by calling
ApplicationMasterProtocol.registerApplicationMaster(RegisterApplicationMasterRequest)
or if it tries to register more than once.This exception is thrown by a NodeManager that is rejecting start-container
requests via
ContainerManagementProtocol.startContainers(StartContainersRequest)
for auxservices does not exist.This exception is thrown by a NodeManager that is rejecting start-container
requests via
ContainerManagementProtocol.startContainers(StartContainersRequest)
for containers allocated by a previous instance of the RM.This exception is thrown when an Application Master tries to release
containers not belonging to it using
ApplicationMasterProtocol.allocate(AllocateRequest) API.This exception is thrown when a resource requested via
ResourceRequest in the
ApplicationMasterProtocol.allocate(AllocateRequest) when requested
label is not having permission to access.This exception is thrown when an application provides an invalid
ResourceBlacklistRequest specification for blacklisting of resources
in ApplicationMasterProtocol.allocate(AllocateRequest) API.This exception is thrown when a resource requested via
ResourceRequest in the
ApplicationMasterProtocol.allocate(AllocateRequest) API is out of the
range of the configured lower and upper limits on resources.The request sent by the client to the
ResourceManager
to abort a submitted application.The response sent by the
ResourceManager to the client aborting
a submitted application.LightWeightResource extends Resource to handle base resources such
as memory and CPU.State of localization.
Represents the localization status of a resource.
LocalResource represents a local resource required to
run a container.LocalResourceType specifies the type
of a resource localized by the NodeManager.LocalResourceVisibility specifies the visibility
of a resource localized by the NodeManager.LogAggregationContext represents all of the
information needed by the NodeManager to handle
the logs for an application.Status of Log aggregation.
The request sent by the client to the
ResourceManager
to move a submitted application to a different queue.
The response sent by the
ResourceManager to the client moving
a submitted application to a different queue.This exception is thrown on
ContainerManagementProtocol.startContainers(StartContainersRequest) API
when an NM starts from scratch but has not yet connected with RM.The NMToken is used for authenticating communication with
NodeManager
Node Attribute is a kind of a label which represents one of the
attribute/feature of a Node.
Node Attribute Info describes a NodeAttribute.
Node AttributeKey uniquely identifies a given Node Attribute.
Enumeration of various node attribute op codes.
Type of a
node Attribute.NodeId is the unique identifier for a node.The request sent by node manager to CSI driver adaptor
to publish a volume on a node.
The response sent by a CSI driver adaptor to the node manager
after publishing a volume on the node.
NodeReport is a summary of runtime information of a node
in the cluster.State of a
Node.list of node-attribute mapping request info.
NodesToAttributesMappingResponse holds response object for attribute
mapping.
Represents a mapping of Node id to list of attributes.
Mapping of Attribute Value to a Node.
The request sent by node manager to CSI driver adaptor
to un-publish a volume on a node.
The response sent by a CSI driver adaptor to the node manager
after un-publishing a volume on the node.
Taxonomy of the
NodeState that a
Node might transition into.PlacementConstraint represents a placement constraint for a resource
allocation.Abstract class that acts as the superclass of all placement constraint
classes.
Class that represents a composite constraint that is a conjunction of other
constraints.
Class that represents a cardinality constraint.
Class that represents composite constraints, which comprise other
constraints, forming a constraint tree.
Class that represents a composite constraint that comprises a list of timed
placement constraints (see
PlacementConstraint.TimedPlacementConstraint).Class that represents a composite constraint that is a disjunction of other
constraints.
Consider a set of nodes N that belongs to the scope specified in the
constraint.
Class that represents a target constraint.
Class representing the target expressions that are used in placement
constraints.
Enum specifying the type of the target expression.
Represents a timed placement constraint that has to be satisfied within a
time window.
The unit of scheduling delay.
Interface used to enable the elements of the constraint tree to be visited.
Visitor API for a constraint tree.
Exception when the placement constraint parser fails to parse an expression.
Placement constraint expression parser.
A basic tokenizer that splits an expression by a given delimiter.
Constraint parser used to parse a given target expression, such as
"cardinality, NODE, foo, 0, 1".
Parser used to parse conjunction form of constraints, such as
AND(A, ..., B), OR(A, ..., B).
Tokenizer used to parse conjunction form of a constraint expression,
[AND|OR](C1:C2:...
Constraint Parser used to parse placement constraints from a
given expression.
Tokenizer interface that used to parse an expression.
Tokenizer used to handle a placement spec composed by multiple
constraint expressions.
Constraint parser used to parse a given target expression.
A helper class to encapsulate source tags and allocations in the
placement specification.
Tokenizer used to parse allocation tags expression, which should be
in tag(numOfAllocations) syntax.
Constraint parser used to parse a given target expression, such as
"NOTIN, NODE, foo, bar".
This class contains various static methods for the applications to create
placement constraints (see also
PlacementConstraint).Class with static methods for constructing target expressions to be used in
placement constraints.
Specific container requested back by the
ResourceManager.Description of resources requested back by the
ResourceManager.A
PreemptionMessage is part of the RM-AM protocol, and it is used by
the RM to specify resources that the RM wants to reclaim from this
ApplicationMaster (AM).Description of resources requested back by the cluster.
The priority assigned to a ResourceRequest or Application or Container
allocation
Request for querying Federation Queue Policies.
This is the QueryFederationQueuePoliciesResponse, which contains the following information:
1.
QueueACL enumerates the various ACLs for queues.QueueConfigurations contain information about the configuration percentages
of a queue.
This entity represents a queue.
QueueInfo is a report of the runtime information of the queue.
State of a Queue.
QueueUserACLInfo provides information QueueACL for
the given user.Convenient API record utils
Request to refresh the resources of a node.
Response to a request to refresh the resources of a node.
The request sent by the
ApplicationMaster to ResourceManager
on registration.The response sent by the
ResourceManager to a new
ApplicationMaster on registration.This encapsulates all the required fields needed for a Container
ReInitialization.
The response to the
ReInitializeContainerRequest.This encapsulates a Rejected SchedulingRequest.
Reason for rejecting a Scheduling Request.
The request from clients to release a resource in the shared cache.
The response to clients from the
SharedCacheManager when
releasing a resource in the shared cache.The request issued by the client to renew a delegation token from
the
ResourceManager.The response to a renewDelegationToken call to the
ResourceManager.ReservationACL enumerates the various ACLs for reservations.ReservationAllocationState represents the reservation that is
made by a user.ReservationDefinition captures the set of resource and time
constraints the user cares about regarding a reservation.ReservationDeleteRequest captures the set of requirements the user
has to delete an existing reservation.ReservationDeleteResponse contains the answer of the admission
control system in the ResourceManager to a reservation delete
operation.ReservationId represents the globally unique identifier for
a reservation.ReservationListRequest captures the set of requirements the
user has to list reservations.ReservationListResponse captures the list of reservations that the
user has queried.ReservationRequest represents the request made by an application to
the ResourceManager to reserve Resources.Enumeration of various types of dependencies among multiple
ReservationRequests within one ReservationDefinition (from
least constraining to most constraining).ReservationRequests captures the set of resource and constraints the
user cares about regarding a reservation.ReservationSubmissionRequest captures the set of requirements the
user has to create a reservation.The response sent by the
ResourceManager to a client on
reservation submission.ReservationUpdateRequest captures the set of requirements the user
has to update an existing reservation.ReservationUpdateResponse contains the answer of the admission
control system in the ResourceManager to a reservation update
operation.Resource models a set of computer resources in the
cluster.ResourceAllocationRequest represents an allocation
made for a reservation for the current state of the plan.ResourceBlacklistRequest encapsulates the list of resource-names
which should be added or removed from the blacklist of resources
for the application.Class to encapsulate information about a Resource - the name of the resource,
the units(milli, micro, etc), the type(countable), and the value.
The request sent by the ApplicationMaster to ask for localizing resources.
The response to the
ResourceLocalizationRequestThis exception is thrown when details of an unknown resource type
are requested.
This exception is thrown when the client requests information about
ResourceProfiles in the
ApplicationClientProtocol but resource
profiles is not enabled on the RM.ResourceRequest represents the request made
by an application to the ResourceManager
to obtain various Container allocations.Class to construct instances of
ResourceRequest with specific
options.ResourceSizing contains information for the size of a
SchedulingRequest, such as the number of requested allocations and
the resources for each allocation.Class to encapsulate information about a ResourceType - the name of the
resource, the units(milli, micro, etc), the type(countable).
Enum which represents the resource type.
ResourceUtilization models the utilization of a set of computer
resources in the cluster.Helper class to read the resource-types to be supported by the system.
The response to a restart Container request.
Response to a Rollback request.
The request from admin to ask the
SharedCacheManager to run
cleaner service right away.
The response to admin from the
SharedCacheManager when
is asked to run the cleaner service.In Yarn Federation mode, this class is used to save the queue policy interface.
This exception is thrown when any issue inside scheduler to handle a new or
updated
SchedulingRequest/
ResourceRequest add to the
scheduler.SchedulingRequest represents a request made by an application to the
ResourceManager to obtain an allocation.Class to construct instances of
SchedulingRequest with specific
options.
The protocol between administrators and the
SharedCacheManagerEnumeration of various signal container commands.
Enumeration of various signal container commands.
The request sent by the client to the
ResourceManager
or by the ApplicationMaster to the NodeManager
to signal a container.The response sent by the
ResourceManager to the client
signalling a container.The request sent by the
ApplicationMaster to the
NodeManager to start a container.
The request which contains a list of
StartContainerRequest sent by
the ApplicationMaster to the NodeManager to
start containers.
The response sent by the
NodeManager to the
ApplicationMaster when asked to start an allocated
container.The request sent by the
ApplicationMaster to the
NodeManager to stop containers.
The response sent by the
NodeManager to the
ApplicationMaster when asked to stop allocated
containers.Enumeration of particular allocations to be reclaimed.
This entity represents a user defined entities to be stored under sub
application table.
The request sent by a client to submit an application to the
ResourceManager.The response sent by the
ResourceManager to a client on
application submission.The response of delegation token related request
This class contains the information about a timeline domain, which is used
to a user to host a number of timeline entities, isolating them from others'.
This class contains the information about a timeline service domain, which is
used to a user to host a number of timeline entities, isolating them from
others'.
We have defined a dedicated Reader for TimelineDomain,
aimed at adapting to the Jersey2 framework
to ensure that JSON can be converted into TimelineDomain.
We have defined a dedicated Reader for TimelineDomain,
aimed at adapting to the Jersey2 framework
to ensure that JSON can be converted into TimelineDomain.
The class that hosts a list of timeline domains.
We have defined a dedicated Writer for TimelineDomains,
aimed at adapting to the Jersey2 framework to ensure
that TimelineDomains can be converted into JSON format.
We have defined a dedicated Writer for TimelineDomain,
aimed at adapting to the Jersey2 framework to ensure
that TimelineDomain can be converted into JSON format.
We have defined a dedicated Writer for TimelineDomain,
aimed at adapting to the Jersey2 framework to ensure
that TimelineDomain can be converted into JSON format.
The class that hosts a list of timeline entities.
This class hosts a set of timeline entities.
We have defined a dedicated Reader for TimelineEntities,
aimed at adapting to the Jersey2 framework
to ensure that JSON can be converted into TimelineEntities.
We have defined a dedicated Reader for TimelineEntities,
aimed at adapting to the Jersey2 framework
to ensure that JSON can be converted into TimelineEntities.
We have defined a dedicated Writer for TimelineEntities,
aimed at adapting to the Jersey2 framework to ensure
that TimelineEntities can be converted into JSON format.
We have defined a dedicated Writer for TimelineEntities,
aimed at adapting to the Jersey2 framework to ensure
that TimelineEntities can be converted into JSON format.
The class that contains the the meta information of some conceptual entity
and its related events.
The basic timeline entity data structure for timeline service v2.
Identifier of timeline entity(entity id + entity type).
TimelineEntityGroupId is an abstract way for
timeline service users to represent “a group of related timeline data.We have defined a dedicated Reader for TimelineEntity,
aimed at adapting to the Jersey2 framework
to ensure that JSON can be converted into TimelineEntity.
We have defined a dedicated Reader for TimelineEntity,
aimed at adapting to the Jersey2 framework
to ensure that JSON can be converted into TimelineEntity.
We have defined a dedicated Writer for TimelineEntity,
aimed at adapting to the Jersey2 framework to ensure
that TimelineEntity can be converted into JSON format.
Defines type of entity.
We have defined a dedicated Writer for TimelineEntity,
aimed at adapting to the Jersey2 framework to ensure
that TimelineEntity can be converted into JSON format.
We have defined a dedicated Writer for TimelineEntity,
aimed at adapting to the Jersey2 framework to ensure
that TimelineEntity can be converted into JSON format.
The class that contains the information of an event that is related to some
conceptual entity of an application.
This class contains the information of an event that belongs to an entity.
The class that hosts a list of events, which are categorized according to
their related entities.
The class that hosts a list of events that are only related to one entity.
We have defined a dedicated Writer for TimelineEvents,
aimed at adapting to the Jersey2 framework to ensure
that TimelineEvents can be converted into JSON format.
This class holds health information for ATS.
Timline health status.
We have defined a dedicated Writer for TimelineHealth,
aimed at adapting to the Jersey2 framework to ensure
that TimelineHealth can be converted into JSON format.
This class contains the information of a metric that is related to some
entity.
Type of metric.
A calculator for timeline metrics.
Aggregation operations.
A class that holds a list of put errors.
A class that holds the error code for one entity.
We have defined a dedicated Reader for TimelinePutResponse,
aimed at adapting to the Jersey2 framework
to ensure that JSON can be converted into TimelinePutResponse.
We have defined a dedicated Writer for TimelinePutResponse,
aimed at adapting to the Jersey2 framework to ensure
that TimelinePutResponse can be converted into JSON format.
Helper class for Timeline service.
A class that holds a list of put errors.
A class that holds the error code for one entity.
Token is the security entity used by the framework
to verify authenticity of any resource.A util to convert values in one unit to another.
Helper class for encapsulating conversion values.
The request sent by the client to the
ResourceManager to set or
update the application priority.
The response sent by the
ResourceManager to the client on update
the application priority.
The request sent by the client to the
ResourceManager to set or
update the application timeout.
The response sent by the
ResourceManager to the client on update
application timeout.UpdateContainerError is used by the Scheduler to notify the
ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to
an error in the request.UpdateContainerRequest represents the request made by an
application to the ResourceManager to update an attribute of a
Container such as its Resource allocation or (@code ExecutionType}An object that encapsulates an updated container and the
type of Update.
The request sent by admin to change a list of nodes' resource to the
ResourceManager.The response sent by the
ResourceManager to Admin client on
node resource change.URL represents a serializable URL.This entity represents a user.
The request from clients to the
SharedCacheManager that claims a
resource in the shared cache.
The response from the SharedCacheManager to the client that indicates whether
a requested resource exists in the cache.
YARN internal message used to validate volume capabilities
with a CSI driver controller plugin.
Volume access mode.
Volume capability.
Volume type.
YARN internal message used to represent the response of
volume capabilities validation with a CSI driver controller plugin.
Enumeration of various states of a
RMAppAttempt.Enumeration of various states of an
ApplicationMaster.YarnClusterMetrics represents cluster metrics.YarnException indicates exceptions from yarn servers.
This exception is thrown when a feature is being used which is not enabled
yet.
Base YARN Exception.