org.apache.hadoop.yarn.api.protocolrecords (Apache Hadoop YARN API 3.5.0 API)
Description: declaration: package: org.apache.hadoop.yarn.api.protocolrecords

# Package org.apache.hadoop.yarn.api.protocolrecords

@Public package org.apache.hadoop.yarn.api.protocolrecords
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.

- Related Packages
  Package
  Description
  org.apache.hadoop.yarn.api
  Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.yarn.api.records
  Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements.
  org.apache.hadoop.yarn.api.resource
  API related to resources.
- Class
  Description
  AllocateRequest
  The core request sent by the `ApplicationMaster` to the `ResourceManager` to obtain resources in the cluster.
  AllocateRequest.AllocateRequestBuilder
  Class to construct instances of `AllocateRequest` with specific options.
  AllocateResponse
  The response sent by the `ResourceManager` the `ApplicationMaster` during resource negotiation.
  AllocateResponse.AllocateResponseBuilder
  Class to construct instances of `AllocateResponse` with specific options.
  ApplicationsRequestScope
  Enumeration that controls the scope of applications fetched
  CancelDelegationTokenRequest
  The request issued by the client to the `ResourceManager` to cancel a delegation token.
  CancelDelegationTokenResponse
  The response from the `ResourceManager` to a cancelDelegationToken request.
  CommitResponse
  Response to Commit Container Request.
  ContainerUpdateRequest
  The request sent by `Application Master` to the `Node Manager` to change the resource quota of a container.
  ContainerUpdateResponse
  The response sent by the `NodeManager` to the `ApplicationMaster` when asked to update container resource.
  FailApplicationAttemptRequest
  The request sent by the client to the `ResourceManager` to fail an application attempt.
  FailApplicationAttemptResponse
  The response sent by the `ResourceManager` to the client failing an application attempt.
  FinishApplicationMasterRequest
  The finalization request sent by the `ApplicationMaster` to inform the `ResourceManager` about its completion.
  FinishApplicationMasterResponse
  The response sent by the `ResourceManager` to a `ApplicationMaster` on it's completion.
  GetAllResourceProfilesRequest
  Request class for getting all the resource profiles from the RM.
  GetAllResourceProfilesResponse
  Response class for getting all the resource profiles from the RM.
  GetAllResourceTypeInfoRequest
  Request class for getting all the resource profiles from the RM.
  GetAllResourceTypeInfoResponse
  Response class for getting all the resource profiles from the RM.
  GetApplicationAttemptReportRequest
  The request sent by a client to the `ResourceManager` to get an `ApplicationAttemptReport` for an application attempt.
  GetApplicationAttemptReportResponse
  The response sent by the `ResourceManager` to a client requesting an application attempt report.
  GetApplicationAttemptsRequest
  The request from clients to get a list of application attempt reports of an application from the `ResourceManager`.
  GetApplicationAttemptsResponse
  The response sent by the `ResourceManager` to a client requesting a list of `ApplicationAttemptReport` for application attempts.
  GetApplicationReportRequest
  The request sent by a client to the `ResourceManager` to get an `ApplicationReport` for an application.
  GetApplicationReportResponse
  The response sent by the `ResourceManager` to a client requesting an application report.
  GetApplicationsRequest
  The request from clients to get a report of Applications in the cluster from the `ResourceManager`.
  GetApplicationsResponse
  The response sent by the `ResourceManager` to a client requesting an `ApplicationReport` for applications.
  GetAttributesToNodesRequest
  The request from clients to get node to attribute value mapping for all or given set of Node AttributeKey's in the cluster from the `ResourceManager`.
  GetAttributesToNodesResponse
  The response sent by the `ResourceManager` to a client requesting node to attribute value mapping for all or given set of Node AttributeKey's.
  GetClusterMetricsRequest
  The request sent by clients to get cluster metrics from the `ResourceManager`.
  GetClusterMetricsResponse
  The response sent by the `ResourceManager` to a client requesting cluster metrics.
  GetClusterNodeAttributesRequest
  The request from clients to get node attributes in the cluster from the `ResourceManager`.
  GetClusterNodeAttributesResponse
  The response sent by the `ResourceManager` to a client requesting a node attributes in cluster.
  GetClusterNodeLabelsRequest
  GetClusterNodeLabelsResponse
  GetClusterNodesRequest
  The request from clients to get a report of all nodes in the cluster from the `ResourceManager`.
  GetClusterNodesResponse
  The response sent by the `ResourceManager` to a client requesting a `NodeReport` for all nodes.
  GetContainerReportRequest
  The request sent by a client to the `ResourceManager` to get an `ContainerReport` for a container.
  GetContainerReportResponse
  The response sent by the `ResourceManager` to a client requesting a container report.
  GetContainersRequest
  The request from clients to get a list of container reports, which belong to an application attempt from the `ResourceManager`.
  GetContainersResponse
  The response sent by the `ResourceManager` to a client requesting a list of `ContainerReport` for containers.
  GetContainerStatusesRequest
  The request sent by the `ApplicationMaster` to the `NodeManager` to get `ContainerStatus` of requested containers.
  GetContainerStatusesResponse
  The response sent by the `NodeManager` to the `ApplicationMaster` when asked to obtain the `ContainerStatus` of requested containers.
  GetDelegationTokenRequest
  The request issued by the client to get a delegation token from the `ResourceManager`.
  GetDelegationTokenResponse
  Response to a `GetDelegationTokenRequest` request from the client.
  GetLabelsToNodesRequest
  GetLabelsToNodesResponse
  GetLocalizationStatusesRequest
  The request sent by an application master to the node manager to get `LocalizationStatus`es of containers.
  GetLocalizationStatusesResponse
  The response sent by the node manager to an application master when localization statuses are requested.
  GetNewApplicationRequest
  The request sent by clients to get a new `ApplicationId` for submitting an application.
  GetNewApplicationResponse
  The response sent by the `ResourceManager` to the client for a request to get a new `ApplicationId` for submitting applications.
  GetNewReservationRequest
  The request sent by clients to get a new `ReservationId` for submitting an reservation.
  GetNewReservationResponse
  The response sent by the `ResourceManager` to the client for a request to get a new `ReservationId` for submitting reservations.
  GetNodesToAttributesRequest
  The request from clients to get nodes to attributes mapping in the cluster from the `ResourceManager`.
  GetNodesToAttributesResponse
  The response sent by the `ResourceManager` to a client requesting nodes to attributes mapping.
  GetNodesToLabelsRequest
  GetNodesToLabelsResponse
  GetPluginInfoRequest
  Get plugin info request.
  GetPluginInfoResponse
  Get plugin info response.
  GetQueueInfoRequest
  The request sent by clients to get queue information from the `ResourceManager`.
  GetQueueInfoResponse
  The response sent by the `ResourceManager` to a client requesting information about queues in the system.
  GetQueueUserAclsInfoRequest
  The request sent by clients to the `ResourceManager` to get queue acls for the current user.
  GetQueueUserAclsInfoResponse
  The response sent by the `ResourceManager` to clients seeking queue acls for the user.
  GetResourceProfileRequest
  Request class for getting the details for a particular resource profile.
  GetResourceProfileResponse
  Response class for getting the details for a particular resource profile.
  IncreaseContainersResourceRequest
  The request sent by `Application Master` to the `Node Manager` to change the resource quota of a container.
  IncreaseContainersResourceResponse
  The response sent by the `NodeManager` to the `ApplicationMaster` when asked to increase container resource.
  KillApplicationRequest
  The request sent by the client to the `ResourceManager` to abort a submitted application.
  KillApplicationResponse
  The response sent by the `ResourceManager` to the client aborting a submitted application.
  MoveApplicationAcrossQueuesRequest
  The request sent by the client to the `ResourceManager` to move a submitted application to a different queue.
  MoveApplicationAcrossQueuesResponse
  The response sent by the `ResourceManager` to the client moving a submitted application to a different queue.
  NodePublishVolumeRequest
  The request sent by node manager to CSI driver adaptor to publish a volume on a node.
  NodePublishVolumeResponse
  The response sent by a CSI driver adaptor to the node manager after publishing a volume on the node.
  NodeUnpublishVolumeRequest
  The request sent by node manager to CSI driver adaptor to un-publish a volume on a node.
  NodeUnpublishVolumeResponse
  The response sent by a CSI driver adaptor to the node manager after un-publishing a volume on the node.
  RegisterApplicationMasterRequest
  The request sent by the `ApplicationMaster` to `ResourceManager` on registration.
  RegisterApplicationMasterResponse
  The response sent by the `ResourceManager` to a new `ApplicationMaster` on registration.
  ReInitializeContainerRequest
  This encapsulates all the required fields needed for a Container ReInitialization.
  ReInitializeContainerResponse
  The response to the `ReInitializeContainerRequest`.
  ReleaseSharedCacheResourceRequest
  The request from clients to release a resource in the shared cache.
  ReleaseSharedCacheResourceResponse
  The response to clients from the `SharedCacheManager` when releasing a resource in the shared cache.
  RenewDelegationTokenRequest
  The request issued by the client to renew a delegation token from the `ResourceManager`.
  RenewDelegationTokenResponse
  The response to a renewDelegationToken call to the `ResourceManager`.
  ReservationDeleteRequest
  `ReservationDeleteRequest` captures the set of requirements the user has to delete an existing reservation.
  ReservationDeleteResponse
  `ReservationDeleteResponse` contains the answer of the admission control system in the `ResourceManager` to a reservation delete operation.
  ReservationListRequest
  `ReservationListRequest` captures the set of requirements the user has to list reservations.
  ReservationListResponse
  `ReservationListResponse` captures the list of reservations that the user has queried.
  ReservationSubmissionRequest
  `ReservationSubmissionRequest` captures the set of requirements the user has to create a reservation.
  ReservationSubmissionResponse
  The response sent by the `ResourceManager` to a client on reservation submission.
  ReservationUpdateRequest
  `ReservationUpdateRequest` captures the set of requirements the user has to update an existing reservation.
  ReservationUpdateResponse
  `ReservationUpdateResponse` contains the answer of the admission control system in the `ResourceManager` to a reservation update operation.
  ResourceLocalizationRequest
  The request sent by the ApplicationMaster to ask for localizing resources.
  ResourceLocalizationResponse
  The response to the `ResourceLocalizationRequest`
  ResourceTypes
  Enum which represents the resource type.
  RestartContainerResponse
  The response to a restart Container request.
  RollbackResponse
  Response to a Rollback request.
  SignalContainerRequest
  The request sent by the client to the `ResourceManager` or by the `ApplicationMaster` to the `NodeManager` to signal a container.
  SignalContainerResponse
  The response sent by the `ResourceManager` to the client signalling a container.
  StartContainerRequest
  The request sent by the `ApplicationMaster` to the `NodeManager` to start a container.
  StartContainersRequest
  The request which contains a list of `StartContainerRequest` sent by the `ApplicationMaster` to the `NodeManager` to start containers.
  StartContainersResponse
  The response sent by the `NodeManager` to the `ApplicationMaster` when asked to start an allocated container.
  StopContainersRequest
  The request sent by the `ApplicationMaster` to the `NodeManager` to stop containers.
  StopContainersResponse
  The response sent by the `NodeManager` to the `ApplicationMaster` when asked to stop allocated containers.
  SubmitApplicationRequest
  The request sent by a client to submit an application to the `ResourceManager`.
  SubmitApplicationResponse
  The response sent by the `ResourceManager` to a client on application submission.
  UpdateApplicationPriorityRequest
  The request sent by the client to the `ResourceManager` to set or update the application priority.
  UpdateApplicationPriorityResponse
  The response sent by the `ResourceManager` to the client on update the application priority.
  UpdateApplicationTimeoutsRequest
  The request sent by the client to the `ResourceManager` to set or update the application timeout.
  UpdateApplicationTimeoutsResponse
  The response sent by the `ResourceManager` to the client on update application timeout.
  UseSharedCacheResourceRequest
  The request from clients to the `SharedCacheManager` that claims a resource in the shared cache.
  UseSharedCacheResourceResponse
  The response from the SharedCacheManager to the client that indicates whether a requested resource exists in the cache.
  ValidateVolumeCapabilitiesRequest
  YARN internal message used to validate volume capabilities with a CSI driver controller plugin.
  ValidateVolumeCapabilitiesRequest.AccessMode
  Volume access mode.
  ValidateVolumeCapabilitiesRequest.VolumeCapability
  Volume capability.
  ValidateVolumeCapabilitiesRequest.VolumeType
  Volume type.
  ValidateVolumeCapabilitiesResponse
  YARN internal message used to represent the response of volume capabilities validation with a CSI driver controller plugin.