Package org.apache.hadoop.yarn.api.records
@Public
package org.apache.hadoop.yarn.api.records
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-
ClassDescriptionClass to describe all supported forms of namespaces for an allocation tag.Command sent by the Resource Manager to the Application Master in the AllocateResponseApplication access types.
ApplicationAttemptIddenotes the particular attempt of anApplicationMasterfor a givenApplicationId.ApplicationAttemptReportis a report of an application attempt.ApplicationIdrepresents the globally unique identifier for an application.ApplicationReportis a report of an application.Contains various scheduling metrics to be reported by UI and CLI.ApplicationSubmissionContextrepresents all of the information needed by theResourceManagerto launch theApplicationMasterfor an application.ApplicationTimeoutis a report for configured application timeouts.Application timeout type.Collector info containing collector address and collector token passed from RM to AM in Allocate Response.Containerrepresents an allocated resource in the cluster.Container exit statuses indicating special exit circumstances.ContainerIdrepresents a globally unique identifier for aContainerin the cluster.ContainerLaunchContextrepresents all of the information needed by theNodeManagerto launch a container.ContainerReportis a report of an container.ContainerRetryContextindicates how container retry after it fails to run.Retry policy for relaunching aContainer.State of aContainer.ContainerStatusrepresents the current status of aContainer.Container Sub-State.Encodes the type of Container Update.Specifies the different types of decommissioning of nodes.org.apache.hadoop.yarn.api.records.EnhancedHeadroomEnhanced 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.Enumeration of various final states of anApplication.State of localization.Represents the localization status of a resource.LocalResourcerepresents a local resource required to run a container.LocalResourceTypespecifies the type of a resource localized by theNodeManager.LocalResourceVisibilityspecifies the visibility of a resource localized by theNodeManager.LogAggregationContextrepresents all of the information needed by theNodeManagerto handle the logs for an application.Status of Log aggregation.The NMToken is used for authenticating communication withNodeManagerNode 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 anode Attribute.NodeIdis the unique identifier for a node.NodeReportis a summary of runtime information of a node in the cluster.State of aNode.Mapping of Attribute Value to a Node.Taxonomy of theNodeStatethat aNodemight transition into.Specific container requested back by theResourceManager.Description of resources requested back by theResourceManager.APreemptionMessageis part of the RM-AM protocol, and it is used by the RM to specify resources that the RM wants to reclaim from thisApplicationMaster(AM).Description of resources requested back by the cluster.The priority assigned to a ResourceRequest or Application or Container allocationQueueACLenumerates the various ACLs for queues.org.apache.hadoop.yarn.api.records.QueueConfigurationsQueueConfigurations contain information about the configuration percentages of a queue.QueueInfo is a report of the runtime information of the queue.State of a Queue.QueueUserACLInfoprovides informationQueueACLfor the given user.This encapsulates a Rejected SchedulingRequest.Reason for rejecting a Scheduling Request.ReservationACLenumerates the various ACLs for reservations.ReservationAllocationStaterepresents the reservation that is made by a user.ReservationDefinitioncaptures the set of resource and time constraints the user cares about regarding a reservation.ReservationIdrepresents the globally unique identifier for a reservation.ReservationRequestrepresents the request made by an application to theResourceManagerto reserveResources.Enumeration of various types of dependencies among multipleReservationRequestswithin oneReservationDefinition(from least constraining to most constraining).ReservationRequestscaptures the set of resource and constraints the user cares about regarding a reservation.Resourcemodels a set of computer resources in the cluster.ResourceAllocationRequestrepresents an allocation made for a reservation for the current state of the plan.ResourceBlacklistRequestencapsulates the list of resource-names which should be added or removed from the blacklist of resources for the application.org.apache.hadoop.yarn.api.records.ResourceInformationClass to encapsulate information about a Resource - the name of the resource, the units(milli, micro, etc), the type(countable), and the value.ResourceRequestrepresents the request made by an application to theResourceManagerto obtain variousContainerallocations.Class to construct instances ofResourceRequestwith specific options.ResourceSizingcontains information for the size of aSchedulingRequest, such as the number of requested allocations and the resources for each allocation.org.apache.hadoop.yarn.api.records.ResourceTypeInfoClass to encapsulate information about a ResourceType - the name of the resource, the units(milli, micro, etc), the type(countable).ResourceUtilizationmodels the utilization of a set of computer resources in the cluster.SchedulingRequestrepresents a request made by an application to theResourceManagerto obtain an allocation.Class to construct instances ofSchedulingRequestwith specific options.org.apache.hadoop.yarn.api.records.SerializedExceptionEnumeration of various signal container commands.Enumeration of various signal container commands.Enumeration of particular allocations to be reclaimed.Tokenis the security entity used by the framework to verify authenticity of any resource.UpdateContainerErroris used by the Scheduler to notify the ApplicationMaster of an UpdateContainerRequest it cannot satisfy due to an error in the request.UpdateContainerRequestrepresents the request made by an application to theResourceManagerto update an attribute of aContainersuch as its Resource allocation or (@code ExecutionType}An object that encapsulates an updated container and the type of Update.URLrepresents a serializableURL.Enumeration of various states of aRMAppAttempt.Enumeration of various states of anApplicationMaster.YarnClusterMetricsrepresents cluster metrics.