All Classes

Class to construct instances of AllocateRequest with specific options.

Class to construct instances of AllocateResponse with specific options.

Command sent by the Resource Manager to the Application Master in the AllocateResponse

This entity represents an application attempt.

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.

The protocol between clients and the ResourceManager or ApplicationHistoryServer to get information on applications, application attempts and containers.

This is the API for the applications comprising of constants that YARN sets up for the applications and the containers.

Environment for Applications.

The protocol between clients and the ApplicationHistoryServer to get the information of completed applications etc.

Exception to be thrown when Client submit an application without providing ApplicationId in ApplicationSubmissionContext.

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.

This is a marker interface for a context object that is injected into the ApplicationMasterService processor.

Utility methods to be used by ApplicationMasterServiceProcessor.

ApplicationReport is a report of an application.

Enumeration that controls the scope of applications fetched

Initialization context for AuxiliaryService when stopping an application.

Application timeout type.

An Interface that can retrieve local directories to read from or write to.

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 protocol between clients and the SharedCacheManager to claim and release resources in the shared cache.

This entity represents a YARN cluster.

Response to Commit Container Request.

Manages a set of @link{ConfigurableAuxiliaryService} instances by starting and stopping them.

Container represents an allocated resource in the cluster.

This entity represents a container belonging to an application attempt.

ContainerId represents a globally unique identifier for a Container in the cluster.

ContainerLaunchContext represents all of the information needed by the NodeManager to launch a container.

Context class for ContainerLogAggregationPolicy.

This exception is thrown on (GetContainerReportRequest) API when the container doesn't exist in AHS

ContainerRetryContext indicates how container retry after it fails to run.

State of a Container.

Container Sub-State.

Container property encoding allocation and execution semantics.

The response sent by the NodeManager to the ApplicationMaster when asked to update container resource.

Interface for the CSI adaptor protocol.

CSI adaptor delegates all the calls from YARN to a CSI driver.

Class that allows to find RM address while using Custom RM HA

Holds an instance of default @link{YarnConfiguration}.

This class is utilized for responding to queue deletion requests and includes the provision of return information.

Enhanced head room in AllocateResponse.

An object of this class represents a specification of the execution guarantee of the Containers associated with a ResourceRequest.

The response sent by the ResourceManager to the client failing an application attempt.

Federation SubClusters.

The finalization request sent by the ApplicationMaster to inform the ResourceManager about its completion.

Entity that represents a record for flow activity.

Request class for getting all the resource profiles from the RM.

Request 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 request from clients to get a list of application attempt reports of an application from the ResourceManager.

The request sent by a client to the ResourceManager to get an ApplicationReport for an application.

The request from clients to get a report of Applications in the cluster from the ResourceManager.

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 request sent by clients to get cluster metrics from the ResourceManager.

The request from clients to get node attributes in the cluster from the ResourceManager.

The request from clients to get a report of all nodes in the cluster from the ResourceManager.

The request sent by a client to the ResourceManager to get an ContainerReport for a container.

The request from clients to get a list of container reports, which belong to an application attempt from the ResourceManager.

The request sent by the ApplicationMaster to the NodeManager to get ContainerStatus of requested containers.

The request issued by the client to get a delegation token from the ResourceManager.

The request sent by an application master to the node manager to get LocalizationStatuses of containers.

The request sent by clients to get a new ApplicationId for submitting an application.

The request sent by clients to get a new ReservationId for submitting an reservation.

The request from clients to get nodes to attributes mapping in the cluster from the ResourceManager.

Get plugin info request.

The request sent by clients to get queue information from the ResourceManager.

The request sent by clients to the ResourceManager to get queue acls for the current user.

Request class for getting the details for a particular resource profile.

The request sent by Application Master to the Node Manager to change the resource quota of a container.

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 containers allocated by a previous instance of the RM.

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 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.

LightWeightResource extends Resource to handle base resources such as memory and CPU.

Represents the localization status of a resource.

LocalResourceType specifies the type of a resource localized by the NodeManager.

LogAggregationContext represents all of the information needed by the NodeManager to handle the logs for an application.

The request sent by the client to the ResourceManager to move 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.

Node Attribute is a kind of a label which represents one of the attribute/feature of a Node.

Node AttributeKey uniquely identifies a given Node Attribute.

Type of a node Attribute.

The response sent by a CSI driver adaptor to the node manager after publishing a volume on the node.

State of a Node.

NodesToAttributesMappingResponse holds response object for attribute mapping.

Mapping of Attribute Value to a Node.

The response sent by a CSI driver adaptor to the node manager after un-publishing a volume on the node.

PlacementConstraint represents a placement constraint for a resource allocation.

Class that represents a composite constraint that is a conjunction of other constraints.

Class that represents composite constraints, which comprise other constraints, forming a constraint tree.

Class that represents a composite constraint that is a disjunction of other constraints.

Class that represents a target constraint.

Enum specifying the type of the target expression.

The unit of scheduling delay.

Visitor API for a constraint tree.

Placement constraint expression parser.

Constraint parser used to parse a given target expression, such as "cardinality, NODE, foo, 0, 1".

Tokenizer used to parse conjunction form of a constraint expression, [AND|OR](C1:C2:...:Cn).

Tokenizer interface that used to parse an expression.

Constraint parser used to parse a given target expression.

Tokenizer used to parse allocation tags expression, which should be in tag(numOfAllocations) syntax.

This class contains various static methods for the applications to create placement constraints (see also PlacementConstraint).

Specific container 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).

The priority assigned to a ResourceRequest or Application or Container allocation

This is the QueryFederationQueuePoliciesResponse, which contains the following information: 1.

QueueConfigurations contain information about the configuration percentages of a queue.

QueueInfo is a report of the runtime information of the queue.

Convenient API record utils

Request to refresh the resources of a node.

The response sent by the ResourceManager to a new ApplicationMaster on registration.

The response to the ReInitializeContainerRequest.

Reason for rejecting a Scheduling Request.

The response to clients from the SharedCacheManager when releasing a resource in the shared cache.

The response to a renewDelegationToken call to the ResourceManager.

ReservationAllocationState represents the reservation that is made by a user.

ReservationDeleteRequest captures the set of requirements the user has to delete an existing reservation.

ReservationId represents the globally unique identifier for a reservation.

ReservationListResponse captures the list of reservations that the user has queried.

ReservationRequests captures the set of resource and constraints the user cares about regarding a reservation.

The response sent by the ResourceManager to a client on reservation submission.

ReservationUpdateResponse contains the answer of the admission control system in the ResourceManager to a reservation update operation.

ResourceAllocationRequest represents an allocation made for a reservation for the current state of the plan.

Class to encapsulate information about a Resource - the name of the resource, the units(milli, micro, etc), the type(countable), and the value.

The response to the ResourceLocalizationRequest

This 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.

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.

Enum which represents the resource type.

Helper class to read the resource-types to be supported by the system.

Class to load custom RMAddressFinder ideally all the loading should be done in the constructor but there are issues with static initialization ordering that dictated loading this class over "get" method and make it synchronized to prevent from double loading

The request from admin to ask the SharedCacheManager to run cleaner service right away.

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.

Class to construct instances of SchedulingRequest with specific options.

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 request sent by the ApplicationMaster to the NodeManager to start a container.

The response sent by the NodeManager to the ApplicationMaster when asked to start an allocated container.

The response sent by the NodeManager to the ApplicationMaster when asked to stop allocated containers.

This entity represents a user defined entities to be stored under sub application table.

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 service domain, which is used to a user to host a number of timeline entities, isolating them from others'.

The class that hosts a list of timeline entities.

The class that contains the the meta information of some conceptual entity and its related events.

Identifier of timeline entity(entity id + entity type).

Defines type of entity.

This class contains the information of an event that belongs to an entity.

The class that hosts a list of events that are only related to one entity.

Timline health status.

Type of metric.

Aggregation operations.

A class that holds the error code for one entity.

A class that holds a list of put errors.

Token is the security entity used by the framework to verify authenticity of any resource.

Helper class for encapsulating conversion values.

The response sent by the ResourceManager to the client on update the application priority.

The response sent by the ResourceManager to the client on update application timeout.

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}

The request sent by admin to change a list of nodes' resource to the ResourceManager.

URL represents a serializable URL.

The request from clients to the SharedCacheManager that claims a resource in the shared cache.

YARN internal message used to validate volume capabilities with a CSI driver controller plugin.

Volume capability.

YARN internal message used to represent the response of volume capabilities validation with a CSI driver controller plugin.

Enumeration of various states of an ApplicationMaster.

YarnException indicates exceptions from yarn servers.

Base YARN Exception.