@InterfaceAudience.Public

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

Class Summary

Class	Description
ApplicationAttemptId	ApplicationAttemptId denotes the particular attempt of an ApplicationMaster for a given ApplicationId.
ApplicationAttemptReport	ApplicationAttemptReport is a report of an application attempt.
ApplicationId	ApplicationId represents the globally unique identifier for an application.
ApplicationReport	ApplicationReport is a report of an application.
ApplicationResourceUsageReport	Contains various scheduling metrics to be reported by UI and CLI.
ApplicationSubmissionContext	ApplicationSubmissionContext represents all of the information needed by the ResourceManager to launch the ApplicationMaster for an application.
ApplicationTimeout	ApplicationTimeout is a report for configured application timeouts.
CollectorInfo	Collector info containing collector address and collector token passed from RM to AM in Allocate Response.
Container	Container represents an allocated resource in the cluster.
ContainerExitStatus	Container exit statuses indicating special exit circumstances.
ContainerId	ContainerId represents a globally unique identifier for a Container in the cluster.
ContainerLaunchContext	ContainerLaunchContext represents all of the information needed by the NodeManager to launch a container.
ContainerReport	ContainerReport is a report of an container.
ContainerRetryContext	ContainerRetryContext indicates how container retry after it fails to run.
ContainerStatus	ContainerStatus represents the current status of a Container.
ExecutionTypeRequest	An object of this class represents a specification of the execution guarantee of the Containers associated with a ResourceRequest.
LocalResource	LocalResource represents a local resource required to run a container.
LogAggregationContext	LogAggregationContext represents all of the information needed by the NodeManager to handle the logs for an application.
NMToken	The NMToken is used for authenticating communication with NodeManager
NodeId	NodeId is the unique identifier for a node.
NodeLabel
NodeReport	NodeReport is a summary of runtime information of a node in the cluster.
PreemptionContainer	Specific container requested back by the ResourceManager.
PreemptionContract	Description of resources requested back by the ResourceManager.
PreemptionMessage	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).
PreemptionResourceRequest	Description of resources requested back by the cluster.
Priority	The priority assigned to a ResourceRequest or Application or Container allocation
QueueInfo	QueueInfo is a report of the runtime information of the queue.
QueueStatistics
QueueUserACLInfo	QueueUserACLInfo provides information QueueACL for the given user.
ReservationAllocationState	ReservationAllocationState represents the reservation that is made by a user.
ReservationDefinition	ReservationDefinition captures the set of resource and time constraints the user cares about regarding a reservation.
ReservationId	ReservationId represents the globally unique identifier for a reservation.
ReservationRequest	ReservationRequest represents the request made by an application to the ResourceManager to reserve Resources.
ReservationRequest.ReservationRequestComparator
ReservationRequests	ReservationRequests captures the set of resource and constraints the user cares about regarding a reservation.
Resource	Resource models a set of computer resources in the cluster.
ResourceAllocationRequest	ResourceAllocationRequest represents an allocation made for a reservation for the current state of the plan.
ResourceBlacklistRequest	ResourceBlacklistRequest encapsulates the list of resource-names which should be added or removed from the blacklist of resources for the application.
ResourceOption
ResourceRequest	ResourceRequest represents the request made by an application to the ResourceManager to obtain various Container allocations.
ResourceRequest.ResourceRequestBuilder	Class to construct instances of ResourceRequest with specific options.
ResourceRequest.ResourceRequestComparator
ResourceUtilization	ResourceUtilization models the utilization of a set of computer resources in the cluster.
StrictPreemptionContract	Enumeration of particular allocations to be reclaimed.
Token	Token is the security entity used by the framework to verify authenticity of any resource.
UpdateContainerError	UpdateContainerError is used by the Scheduler to notify the ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to an error in the request.
UpdateContainerRequest	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}
UpdatedContainer	An object that encapsulates an updated container and the type of Update.
URL	URL represents a serializable URL.
YarnClusterMetrics	YarnClusterMetrics represents cluster metrics.

Enum Summary

Enum	Description
AMCommand	Command sent by the Resource Manager to the Application Master in the AllocateResponse
ApplicationAccessType	Application access types.
ApplicationTimeoutType	Application timeout type.
ContainerRetryPolicy	Retry policy for relaunching a Container.
ContainerState	State of a Container.
ContainerSubState	Container Sub-State.
ContainerUpdateType	Encodes the type of Container Update.
ExecutionType	Container property encoding execution semantics.
FinalApplicationStatus	Enumeration of various final states of an Application.
LocalResourceType	LocalResourceType specifies the type of a resource localized by the NodeManager.
LocalResourceVisibility	LocalResourceVisibility specifies the visibility of a resource localized by the NodeManager.
NodeState	State of a Node.
QueueACL	QueueACL enumerates the various ACLs for queues.
QueueState	State of a Queue.
ReservationACL	ReservationACL enumerates the various ACLs for reservations.
ReservationRequestInterpreter	Enumeration of various types of dependencies among multiple ReservationRequests within one ReservationDefinition (from least constraining to most constraining).
SignalContainerCommand	Enumeration of various signal container commands.
YarnApplicationAttemptState	Enumeration of various states of a RMAppAttempt.
YarnApplicationState	Enumeration of various states of an ApplicationMaster.