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

- Packages that use Token
  Package | Description
  --- | ---
  org.apache.hadoop.mapreduce.v2.api.protocolrecords |
  org.apache.hadoop.yarn.api.protocolrecords |
  org.apache.hadoop.yarn.api.records |
  org.apache.hadoop.yarn.client.api |
  org.apache.hadoop.yarn.util |

- - ### Uses of Token in org.apache.hadoop.mapreduce.v2.api.protocolrecords

    Methods in org.apache.hadoop.mapreduce.v2.api.protocolrecords that return Token
    Modifier and Type | Method and Description
    --- | ---
    `Token` | CancelDelegationTokenRequest.`getDelegationToken()`
    `Token` | RenewDelegationTokenRequest.`getDelegationToken()`

    Methods in org.apache.hadoop.mapreduce.v2.api.protocolrecords with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `void` | CancelDelegationTokenRequest.`setDelegationToken(Token dToken)`
    `void` | RenewDelegationTokenRequest.`setDelegationToken(Token dToken)`

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

    Methods in org.apache.hadoop.yarn.api.protocolrecords that return Token
    Modifier and Type | Method and Description
    --- | ---
    `abstract Token` | AllocateResponse.`getAMRMToken()` The AMRMToken that belong to this attempt
    `abstract Token` | StartContainerRequest.`getContainerToken()` Get the container token to be used for authorization during starting container.
    `abstract Token` | GetDelegationTokenResponse.`getRMDelegationToken()` The Delegation tokens have a identifier which maps to `AbstractDelegationTokenIdentifier`.

    Methods in org.apache.hadoop.yarn.api.protocolrecords that return types with arguments of type Token
    Modifier and Type | Method and Description
    --- | ---
    `abstract List<Token>` | IncreaseContainersResourceRequest.`getContainersToIncrease()` Get a list of container tokens to be used for authorization during container resource increase.
    `abstract List<Token>` | ContainerUpdateRequest.`getContainersToUpdate()` Get a list of container tokens to be used for authorization during container resource update.

    Methods in org.apache.hadoop.yarn.api.protocolrecords with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `static StartContainerRequest` | StartContainerRequest.`newInstance(ContainerLaunchContext context, Token container)`
    `static AllocateResponse` | AllocateResponse.`newInstance(int responseId, List<ContainerStatus> completedContainers, List<Container> allocatedContainers, List<NodeReport> updatedNodes, Resource availResources, AMCommand command, int numClusterNodes, PreemptionMessage preempt, List<NMToken> nmTokens, Token amRMToken, List<UpdatedContainer> updatedContainers, CollectorInfo collectorInfo)`
    `abstract void` | StartContainerRequest.`setContainerToken(Token container)`

    Method parameters in org.apache.hadoop.yarn.api.protocolrecords with type arguments of type Token
    Modifier and Type | Method and Description
    --- | ---
    `static IncreaseContainersResourceRequest` | IncreaseContainersResourceRequest.`newInstance(List<Token> containersToIncrease)`
    `static ContainerUpdateRequest` | ContainerUpdateRequest.`newInstance(List<Token> containersToIncrease)`
    `abstract void` | IncreaseContainersResourceRequest.`setContainersToIncrease(List<Token> containersToIncrease)` Set container tokens to be used during container resource increase.
    `abstract void` | ContainerUpdateRequest.`setContainersToUpdate(List<Token> containersToUpdate)` Set container tokens to be used during container resource increase.

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

    Methods in org.apache.hadoop.yarn.api.records that return Token
    Modifier and Type | Method and Description
    --- | ---
    `abstract Token` | ApplicationReport.`getAMRMToken()` Get the AMRM token of the application.
    `abstract Token` | ApplicationReport.`getClientToAMToken()` Get the client token for communicating with the `ApplicationMaster`.
    `abstract Token` | CollectorInfo.`getCollectorToken()` Get delegation token for app collector which AM will use to publish entities.
    `abstract Token` | Container.`getContainerToken()` Get the `ContainerToken` for the container.
    `abstract Token` | NMToken.`getToken()` Get the `Token` used for authenticating with `NodeManager`

    Methods in org.apache.hadoop.yarn.api.records with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `static CollectorInfo` | CollectorInfo.`newInstance(String collectorAddr, Token token)`
    `abstract void` | CollectorInfo.`setCollectorToken(Token token)`
    `abstract void` | NMToken.`setToken(Token token)`

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

    Methods in org.apache.hadoop.yarn.client.api that return Token
    Modifier and Type | Method and Description
    --- | ---
    `static Token` | NMTokenCache.`getNMToken(String nodeAddr)` Returns NMToken, null if absent.
    `abstract Token` | YarnClient.`getRMDelegationToken(Text renewer)` Get a delegation token so as to be able to talk to YARN using those tokens.
    `Token` | NMTokenCache.`getToken(String nodeAddr)` Returns NMToken, null if absent

    Methods in org.apache.hadoop.yarn.client.api with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `static void` | NMTokenCache.`setNMToken(String nodeAddr, Token token)` Sets the NMToken for node address only in the singleton obtained from `NMTokenCache.getSingleton()`.
    `void` | NMTokenCache.`setToken(String nodeAddr, Token token)` Sets the NMToken for node address

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

    Methods in org.apache.hadoop.yarn.util with parameters of type Token
    Modifier and Type | Method and Description
    --- | ---
    `static <T extends TokenIdentifier> Token<T>` | ConverterUtils.`convertFromYarn(Token protoToken, InetSocketAddress serviceAddr)` Convert a protobuf token into a rpc token and set its service.
    `static <T extends TokenIdentifier> Token<T>` | ConverterUtils.`convertFromYarn(Token protoToken, Text service)` Convert a protobuf token into a rpc token and set its service.

Copyright © 2022 Apache Software Foundation. All rights reserved.