| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:00:58 GMT 2021 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>org.apache.hadoop.yarn.service.api.records (Apache Hadoop Main 3.3.1 API)</title> |
| <meta name="date" content="2021-06-15"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="org.apache.hadoop.yarn.service.api.records (Apache Hadoop Main 3.3.1 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/service/api/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/service/component/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/service/api/records/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package org.apache.hadoop.yarn.service.api.records</h1> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/Artifact.html" title="class in org.apache.hadoop.yarn.service.api.records">Artifact</a></td> |
| <td class="colLast"> |
| <div class="block">Artifact of an service component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/BaseResource.html" title="class in org.apache.hadoop.yarn.service.api.records">BaseResource</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/Component.html" title="class in org.apache.hadoop.yarn.service.api.records">Component</a></td> |
| <td class="colLast"> |
| <div class="block">One or more components of the service.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ComponentContainers.html" title="class in org.apache.hadoop.yarn.service.api.records">ComponentContainers</a></td> |
| <td class="colLast"> |
| <div class="block">Containers of a component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ConfigFile.html" title="class in org.apache.hadoop.yarn.service.api.records">ConfigFile</a></td> |
| <td class="colLast"> |
| <div class="block">A config file that needs to be created and made available as a volume in an |
| service component container.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/Configuration.html" title="class in org.apache.hadoop.yarn.service.api.records">Configuration</a></td> |
| <td class="colLast"> |
| <div class="block">Set of configuration properties that can be injected into the service |
| components via envs, files and custom pluggable helper docker containers.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/Container.html" title="class in org.apache.hadoop.yarn.service.api.records">Container</a></td> |
| <td class="colLast"> |
| <div class="block">An instance of a running service container.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/Error.html" title="class in org.apache.hadoop.yarn.service.api.records">Error</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/KerberosPrincipal.html" title="class in org.apache.hadoop.yarn.service.api.records">KerberosPrincipal</a></td> |
| <td class="colLast"> |
| <div class="block">The kerberos principal of the service.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/LocalizationStatus.html" title="class in org.apache.hadoop.yarn.service.api.records">LocalizationStatus</a></td> |
| <td class="colLast"> |
| <div class="block">The status of localization.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/PlacementConstraint.html" title="class in org.apache.hadoop.yarn.service.api.records">PlacementConstraint</a></td> |
| <td class="colLast"> |
| <div class="block">Placement constraint details.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/PlacementPolicy.html" title="class in org.apache.hadoop.yarn.service.api.records">PlacementPolicy</a></td> |
| <td class="colLast"> |
| <div class="block">Advanced placement policy of the components of a service.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ReadinessCheck.html" title="class in org.apache.hadoop.yarn.service.api.records">ReadinessCheck</a></td> |
| <td class="colLast"> |
| <div class="block">A custom command or a pluggable helper container to determine the readiness |
| of a container of a component.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/Resource.html" title="class in org.apache.hadoop.yarn.service.api.records">Resource</a></td> |
| <td class="colLast"> |
| <div class="block">Resource determines the amount of resources (vcores, memory, network, etc.) |
| usable by a container.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/Service.html" title="class in org.apache.hadoop.yarn.service.api.records">Service</a></td> |
| <td class="colLast"> |
| <div class="block">An Service resource has the following attributes.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ServiceStatus.html" title="class in org.apache.hadoop.yarn.service.api.records">ServiceStatus</a></td> |
| <td class="colLast"> |
| <div class="block">The current status of a submitted service, returned as a response to the |
| GET API.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ComponentState.html" title="enum in org.apache.hadoop.yarn.service.api.records">ComponentState</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ConfigFormat.html" title="enum in org.apache.hadoop.yarn.service.api.records">ConfigFormat</a></td> |
| <td class="colLast"> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ContainerState.html" title="enum in org.apache.hadoop.yarn.service.api.records">ContainerState</a></td> |
| <td class="colLast"> |
| <div class="block">The current state of the container of an application.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/PlacementScope.html" title="enum in org.apache.hadoop.yarn.service.api.records">PlacementScope</a></td> |
| <td class="colLast"> |
| <div class="block">The scope of placement for the containers of a component.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/PlacementType.html" title="enum in org.apache.hadoop.yarn.service.api.records">PlacementType</a></td> |
| <td class="colLast"> |
| <div class="block">The type of placement - affinity/anti-affinity/affinity-with-cardinality with |
| containers of another component or containers of the same component (self).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../../../../../../org/apache/hadoop/yarn/service/api/records/ServiceState.html" title="enum in org.apache.hadoop.yarn.service.api.records">ServiceState</a></td> |
| <td class="colLast"> |
| <div class="block">The current state of an service.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/service/api/package-summary.html">Prev Package</a></li> |
| <li><a href="../../../../../../../org/apache/hadoop/yarn/service/component/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/hadoop/yarn/service/api/records/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
