## Uses of Class
org.apache.hadoop.yarn.api.records.ApplicationId

- Packages that use ApplicationId
  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 |

- - ### Uses of ApplicationId in org.apache.hadoop.yarn.api.protocolrecords

    Methods in org.apache.hadoop.yarn.api.protocolrecords that return ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `abstract ApplicationId` | UseSharedCacheResourceRequest.`getAppId()` Get the `ApplicationId` of the resource to be used.
    `abstract ApplicationId` | ReleaseSharedCacheResourceRequest.`getAppId()` Get the `ApplicationId` of the resource to be released.
    `abstract ApplicationId` | GetApplicationAttemptsRequest.`getApplicationId()` Get the `ApplicationId` of an application
    `abstract ApplicationId` | UpdateApplicationPriorityRequest.`getApplicationId()` Get the `ApplicationId` of the application.
    `abstract ApplicationId` | UpdateApplicationTimeoutsRequest.`getApplicationId()` Get the `ApplicationId` of the application.
    `abstract ApplicationId` | GetApplicationReportRequest.`getApplicationId()` Get the `ApplicationId` of the application.
    `abstract ApplicationId` | KillApplicationRequest.`getApplicationId()` Get the `ApplicationId` of the application to be aborted.
    `abstract ApplicationId` | GetNewApplicationResponse.`getApplicationId()` Get the new `ApplicationId` allocated by the `ResourceManager`.
    `abstract ApplicationId` | MoveApplicationAcrossQueuesRequest.`getApplicationId()` Get the `ApplicationId` of the application to be moved.

    Methods in org.apache.hadoop.yarn.api.protocolrecords with parameters of type ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `static GetApplicationAttemptsRequest` | GetApplicationAttemptsRequest.`newInstance(ApplicationId applicationId)`
    `static GetApplicationReportRequest` | GetApplicationReportRequest.`newInstance(ApplicationId applicationId)`
    `static KillApplicationRequest` | KillApplicationRequest.`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 `ApplicationId` of the resource to be used.
    `abstract void` | ReleaseSharedCacheResourceRequest.`setAppId(ApplicationId id)` Set the `ApplicationId` of the resource to be released.
    `abstract void` | GetApplicationAttemptsRequest.`setApplicationId(ApplicationId applicationId)` Set the `ApplicationId` of an application
    `abstract void` | UpdateApplicationPriorityRequest.`setApplicationId(ApplicationId applicationId)` Set the `ApplicationId` of the application.
    `abstract void` | UpdateApplicationTimeoutsRequest.`setApplicationId(ApplicationId applicationId)` Set the `ApplicationId` of the application.
    `abstract void` | GetApplicationReportRequest.`setApplicationId(ApplicationId applicationId)` Set the `ApplicationId` of the application
    `abstract void` | KillApplicationRequest.`setApplicationId(ApplicationId applicationId)`
    `abstract void` | MoveApplicationAcrossQueuesRequest.`setApplicationId(ApplicationId appId)` Set the `ApplicationId` of the application to be moved.

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.api.records

    Methods in org.apache.hadoop.yarn.api.records that return ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `static ApplicationId` | ApplicationId.`fromString(String appIdStr)`
    `abstract ApplicationId` | ApplicationSubmissionContext.`getApplicationId()` Get the `ApplicationId` of the submitted application.
    `abstract ApplicationId` | ApplicationReport.`getApplicationId()` Get the `ApplicationId` of the application.
    `abstract ApplicationId` | ApplicationAttemptId.`getApplicationId()` Get the `ApplicationId` of the `ApplicationAttempId`.
    `static ApplicationId` | ApplicationId.`newInstance(long clusterTimestamp, int id)`

    Methods in org.apache.hadoop.yarn.api.records with parameters of type ApplicationId
    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 `ApplicationId` of the submitted application.

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.api.records.timeline

    Methods in org.apache.hadoop.yarn.api.records.timeline that return ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `ApplicationId` | TimelineEntityGroupId.`getApplicationId()` Get the `ApplicationId` of the `TimelineEntityGroupId`.

    Methods in org.apache.hadoop.yarn.api.records.timeline with parameters of type ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `static TimelineEntityGroupId` | TimelineEntityGroupId.`newInstance(ApplicationId applicationId, String id)`
    `void` | TimelineEntityGroupId.`setApplicationId(ApplicationId appID)`

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.client.api

    Methods in org.apache.hadoop.yarn.client.api that return ApplicationId
    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 return `ApplicationId` until the submitted application is submitted successfully and accepted by the ResourceManager.

    Methods in org.apache.hadoop.yarn.client.api with parameters of type ApplicationId
    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>` | AHSClient.`getApplicationAttempts(ApplicationId applicationId)` Get a report of all (ApplicationAttempts) of Application in the cluster.
    `abstract List<ApplicationAttemptReport>` | YarnClient.`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` | AHSClient.`getApplicationReport(ApplicationId appId)` Get a report of the given Application.
    `abstract ApplicationReport` | YarnClient.`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 an `ApplicationId` to identify which application will be using the resource.

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.client.api.impl

    Methods in org.apache.hadoop.yarn.client.api.impl with parameters of type ApplicationId
    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)`

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.logaggregation.filecontroller

    Methods in org.apache.hadoop.yarn.logaggregation.filecontroller with parameters of type ApplicationId
    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.`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.

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.service.client

    Methods in org.apache.hadoop.yarn.service.client with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `ApplicationId` | ServiceClient.`actionCreate(Service service)`
    `ApplicationId` | ServiceClient.`actionStartAndGetId(String serviceName)`
    `ApplicationId` | ServiceClient.`getAppId(String serviceName)`

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.util

    Methods in org.apache.hadoop.yarn.util that return ApplicationId
    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.

    Methods in org.apache.hadoop.yarn.util with parameters of type ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `static String` | ConverterUtils.`toString(ApplicationId appId)` Deprecated.

  - ### Uses of ApplicationId in org.apache.hadoop.yarn.util.timeline

    Methods in org.apache.hadoop.yarn.util.timeline with parameters of type ApplicationId
    Modifier and Type | Method and Description
    --- | ---
    `static String` | TimelineUtils.`generateDefaultFlowName(String appName, ApplicationId appId)`

Copyright © 2022 Apache Software Foundation. All rights reserved.