| Package | Description | 
|---|---|
| org.apache.hadoop.yarn.api.protocolrecords | |
| org.apache.hadoop.yarn.api.records | |
| org.apache.hadoop.yarn.api.records.timeline | Licensed to the Apache Software Foundation (ASF) under one
 or more contributor license agreements. | 
| org.apache.hadoop.yarn.client.api | |
| org.apache.hadoop.yarn.client.api.impl | |
| org.apache.hadoop.yarn.logaggregation.filecontroller | |
| org.apache.hadoop.yarn.service.client | Package org.apache.hadoop.yarn.service.client contains classes
 for YARN Services Client API. | 
| org.apache.hadoop.yarn.util | |
| org.apache.hadoop.yarn.util.timeline | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract ApplicationId | UseSharedCacheResourceRequest. getAppId()Get the  ApplicationIdof the resource to be used. | 
| abstract ApplicationId | ReleaseSharedCacheResourceRequest. getAppId()Get the  ApplicationIdof the resource to be released. | 
| abstract ApplicationId | UpdateApplicationTimeoutsRequest. getApplicationId()Get the  ApplicationIdof the application. | 
| abstract ApplicationId | KillApplicationRequest. getApplicationId()Get the  ApplicationIdof the application to be aborted. | 
| abstract ApplicationId | GetApplicationAttemptsRequest. getApplicationId()Get the  ApplicationIdof an application | 
| abstract ApplicationId | GetNewApplicationResponse. getApplicationId()Get the new  ApplicationIdallocated by theResourceManager. | 
| abstract ApplicationId | GetApplicationReportRequest. getApplicationId()Get the  ApplicationIdof the application. | 
| abstract ApplicationId | UpdateApplicationPriorityRequest. getApplicationId()Get the  ApplicationIdof the application. | 
| abstract ApplicationId | MoveApplicationAcrossQueuesRequest. getApplicationId()Get the  ApplicationIdof the application to be moved. | 
| Modifier and Type | Method and Description | 
|---|---|
| static KillApplicationRequest | KillApplicationRequest. newInstance(ApplicationId applicationId) | 
| static GetApplicationAttemptsRequest | GetApplicationAttemptsRequest. newInstance(ApplicationId applicationId) | 
| static GetApplicationReportRequest | GetApplicationReportRequest. newInstance(ApplicationId applicationId) | 
| static UpdateApplicationTimeoutsRequest | UpdateApplicationTimeoutsRequest. newInstance(ApplicationId applicationId,
           Map<ApplicationTimeoutType,String> applicationTimeouts) | 
| static UpdateApplicationPriorityRequest | UpdateApplicationPriorityRequest. newInstance(ApplicationId applicationId,
           Priority priority) | 
| static MoveApplicationAcrossQueuesRequest | MoveApplicationAcrossQueuesRequest. newInstance(ApplicationId appId,
           String queue) | 
| abstract void | UseSharedCacheResourceRequest. setAppId(ApplicationId id)Set the  ApplicationIdof the resource to be used. | 
| abstract void | ReleaseSharedCacheResourceRequest. setAppId(ApplicationId id)Set the  ApplicationIdof the resource to be released. | 
| abstract void | UpdateApplicationTimeoutsRequest. setApplicationId(ApplicationId applicationId)Set the  ApplicationIdof the application. | 
| abstract void | KillApplicationRequest. setApplicationId(ApplicationId applicationId) | 
| abstract void | GetApplicationAttemptsRequest. setApplicationId(ApplicationId applicationId)Set the  ApplicationIdof an application | 
| abstract void | GetApplicationReportRequest. setApplicationId(ApplicationId applicationId)Set the  ApplicationIdof the application | 
| abstract void | UpdateApplicationPriorityRequest. setApplicationId(ApplicationId applicationId)Set the  ApplicationIdof the application. | 
| abstract void | MoveApplicationAcrossQueuesRequest. setApplicationId(ApplicationId appId)Set the  ApplicationIdof the application to be moved. | 
| Modifier and Type | Method and Description | 
|---|---|
| static ApplicationId | ApplicationId. fromString(String appIdStr) | 
| abstract ApplicationId | ApplicationAttemptId. getApplicationId()Get the  ApplicationIdof theApplicationAttempId. | 
| abstract ApplicationId | ApplicationSubmissionContext. getApplicationId()Get the  ApplicationIdof the submitted application. | 
| abstract ApplicationId | ApplicationReport. getApplicationId()Get the  ApplicationIdof the application. | 
| static ApplicationId | ApplicationId. newInstance(long clusterTimestamp,
           int id) | 
| Modifier and Type | Method and Description | 
|---|---|
| int | ApplicationId. compareTo(ApplicationId other) | 
| static ApplicationAttemptId | ApplicationAttemptId. newInstance(ApplicationId appId,
           int attemptId) | 
| static ApplicationSubmissionContext | ApplicationSubmissionContext. newInstance(ApplicationId applicationId,
           String applicationName,
           String queue,
           ContainerLaunchContext amContainer,
           boolean isUnmanagedAM,
           boolean cancelTokensWhenComplete,
           int maxAppAttempts,
           String applicationType,
           boolean keepContainers,
           String appLabelExpression,
           ResourceRequest resourceRequest) | 
| static ApplicationSubmissionContext | ApplicationSubmissionContext. newInstance(ApplicationId applicationId,
           String applicationName,
           String queue,
           Priority priority,
           ContainerLaunchContext amContainer,
           boolean isUnmanagedAM,
           boolean cancelTokensWhenComplete,
           int maxAppAttempts,
           Resource resource) | 
| static ApplicationSubmissionContext | ApplicationSubmissionContext. newInstance(ApplicationId applicationId,
           String applicationName,
           String queue,
           Priority priority,
           ContainerLaunchContext amContainer,
           boolean isUnmanagedAM,
           boolean cancelTokensWhenComplete,
           int maxAppAttempts,
           Resource resource,
           String applicationType) | 
| static ApplicationSubmissionContext | ApplicationSubmissionContext. newInstance(ApplicationId applicationId,
           String applicationName,
           String queue,
           Priority priority,
           ContainerLaunchContext amContainer,
           boolean isUnmanagedAM,
           boolean cancelTokensWhenComplete,
           int maxAppAttempts,
           Resource resource,
           String applicationType,
           boolean keepContainers) | 
| static ApplicationSubmissionContext | ApplicationSubmissionContext. newInstance(ApplicationId applicationId,
           String applicationName,
           String queue,
           Priority priority,
           ContainerLaunchContext amContainer,
           boolean isUnmanagedAM,
           boolean cancelTokensWhenComplete,
           int maxAppAttempts,
           Resource resource,
           String applicationType,
           boolean keepContainers,
           LogAggregationContext logAggregationContext) | 
| static ApplicationSubmissionContext | ApplicationSubmissionContext. newInstance(ApplicationId applicationId,
           String applicationName,
           String queue,
           Priority priority,
           ContainerLaunchContext amContainer,
           boolean isUnmanagedAM,
           boolean cancelTokensWhenComplete,
           int maxAppAttempts,
           Resource resource,
           String applicationType,
           boolean keepContainers,
           long attemptFailuresValidityInterval) | 
| static ApplicationSubmissionContext | ApplicationSubmissionContext. newInstance(ApplicationId applicationId,
           String applicationName,
           String queue,
           Priority priority,
           ContainerLaunchContext amContainer,
           boolean isUnmanagedAM,
           boolean cancelTokensWhenComplete,
           int maxAppAttempts,
           Resource resource,
           String applicationType,
           boolean keepContainers,
           String appLabelExpression,
           String amContainerLabelExpression) | 
| abstract void | ApplicationSubmissionContext. setApplicationId(ApplicationId applicationId)Set the  ApplicationIdof the submitted application. | 
| Modifier and Type | Method and Description | 
|---|---|
| ApplicationId | TimelineEntityGroupId. getApplicationId()Get the  ApplicationIdof theTimelineEntityGroupId. | 
| Modifier and Type | Method and Description | 
|---|---|
| static TimelineEntityGroupId | TimelineEntityGroupId. newInstance(ApplicationId applicationId,
           String id) | 
| void | TimelineEntityGroupId. setApplicationId(ApplicationId appID) | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract ApplicationId | YarnClient. submitApplication(ApplicationSubmissionContext appContext)
 Submit a new application to  YARN.It is a blocking call - it
 will not returnApplicationIduntil the submitted application is
 submitted successfully and accepted by the ResourceManager. | 
| Modifier and Type | Method and Description | 
|---|---|
| abstract Token<AMRMTokenIdentifier> | YarnClient. getAMRMToken(ApplicationId appId)Get the AMRM token of the application. | 
| abstract List<TimelineEntity> | TimelineReaderClient. getApplicationAttemptEntities(ApplicationId appId,
                             String fields,
                             Map<String,String> filters,
                             long limit,
                             String fromId)Gets application attempt entities. | 
| abstract List<ApplicationAttemptReport> | YarnClient. getApplicationAttempts(ApplicationId applicationId)
 Get a report of all (ApplicationAttempts) of Application in the cluster. | 
| abstract List<ApplicationAttemptReport> | AHSClient. getApplicationAttempts(ApplicationId applicationId)
 Get a report of all (ApplicationAttempts) of Application in the cluster. | 
| abstract TimelineEntity | TimelineReaderClient. getApplicationEntity(ApplicationId appId,
                    String fields,
                    Map<String,String> filters)Gets application entity. | 
| abstract ApplicationReport | YarnClient. getApplicationReport(ApplicationId appId)
 Get a report of the given Application. | 
| abstract ApplicationReport | AHSClient. getApplicationReport(ApplicationId appId)Get a report of the given Application. | 
| abstract List<TimelineEntity> | TimelineReaderClient. getContainerEntities(ApplicationId appId,
                    String fields,
                    Map<String,String> filters,
                    long limit,
                    String fromId)Gets container entities for an application. | 
| abstract void | YarnClient. killApplication(ApplicationId applicationId)
 Kill an application identified by given ID. | 
| abstract void | YarnClient. killApplication(ApplicationId applicationId,
               String diagnostics)
 Kill an application identified by given ID. | 
| abstract void | YarnClient. moveApplicationAcrossQueues(ApplicationId appId,
                           String queue)
 Attempts to move the given application to the given queue. | 
| abstract void | SharedCacheClient. release(ApplicationId applicationId,
       String resourceKey)
 The method to release a resource with the  SharedCacheManager.This method is called once an application is no longer using a claimed
 resource in the shared cache. | 
| abstract Priority | YarnClient. updateApplicationPriority(ApplicationId applicationId,
                         Priority priority)
 The interface used by client to set priority of an application | 
| abstract URL | SharedCacheClient. use(ApplicationId applicationId,
   String resourceKey)
 The method to claim a resource with the  SharedCacheManager.The client uses a checksum to identify the resource and anApplicationIdto identify which application will be using the
 resource. | 
| Modifier and Type | Method and Description | 
|---|---|
| List<TimelineEntity> | TimelineReaderClientImpl. getApplicationAttemptEntities(ApplicationId appId,
                             String fields,
                             Map<String,String> filters,
                             long limit,
                             String fromId) | 
| TimelineEntity | TimelineReaderClientImpl. getApplicationEntity(ApplicationId appId,
                    String fields,
                    Map<String,String> filters) | 
| List<TimelineEntity> | TimelineReaderClientImpl. getContainerEntities(ApplicationId appId,
                    String fields,
                    Map<String,String> filters,
                    long limit,
                    String fromId) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | LogAggregationFileController. createAppDir(String user,
            ApplicationId appId,
            UserGroupInformation userUgi)Create remote Application directory for log aggregation. | 
| abstract Map<ApplicationAccessType,String> | LogAggregationFileController. getApplicationAcls(Path aggregatedLogPath,
                  ApplicationId appId)Returns ACLs for the application. | 
| abstract String | LogAggregationFileController. getApplicationOwner(Path aggregatedLogPath,
                   ApplicationId appId)Returns the owner of the application. | 
| Path | LogAggregationFileController. getOlderRemoteAppLogDir(ApplicationId appId,
                       String appOwner)Get the older remote application directory for log aggregation. | 
| Path | LogAggregationFileController. getRemoteAppLogDir(ApplicationId appId,
                  String appOwner)Get the remote application directory for log aggregation. | 
| Path | LogAggregationFileController. getRemoteNodeLogFileForApp(ApplicationId appId,
                          String user,
                          NodeId nodeId)Get the remote aggregated log path. | 
| Modifier and Type | Method and Description | 
|---|---|
| ApplicationId | ServiceClient. actionCreate(Service service) | 
| ApplicationId | ServiceClient. actionStartAndGetId(String serviceName) | 
| ApplicationId | ServiceClient. getAppId(String serviceName) | 
| Modifier and Type | Method and Description | 
|---|---|
| static ApplicationId | ConverterUtils. toApplicationId(org.apache.hadoop.yarn.factories.RecordFactory recordFactory,
               String applicationIdStr)Deprecated.  | 
| static ApplicationId | ConverterUtils. toApplicationId(String appIdStr)Deprecated.  | 
| Modifier and Type | Method and Description | 
|---|---|
| static String | ConverterUtils. toString(ApplicationId appId)Deprecated.  | 
| Modifier and Type | Method and Description | 
|---|---|
| static String | TimelineUtils. generateDefaultFlowName(String appName,
                       ApplicationId appId) | 
Copyright © 2023 Apache Software Foundation. All rights reserved.