blob: 76822496f5040fcf682fc2e2b188bf70739ea8e8 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>Uses of Class org.apache.pulsar.broker.loadbalance.ResourceDescription (Pulsar Broker 2.11.0-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="use: package: org.apache.pulsar.broker.loadbalance, class: ResourceDescription">
<meta name="generator" content="javadoc/ClassUseWriter">
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../script-dir/jquery-ui.min.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../jquery-ui.overrides.css" title="Style">
<script type="text/javascript" src="../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-3.5.1.min.js"></script>
<script type="text/javascript" src="../../../../../../script-dir/jquery-ui.min.js"></script>
</head>
<body class="class-use-page">
<script type="text/javascript">var pathtoroot = "../../../../../../";
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="flex-box">
<header role="banner" class="flex-header">
<nav role="navigation">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="top-nav" id="navbar-top">
<div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
<ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
<li><a href="../../../../../../index.html">Overview</a></li>
<li><a href="../package-summary.html">Package</a></li>
<li><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">Class</a></li>
<li class="nav-bar-cell1-rev">Use</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#use">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<div class="header">
<h1 title="Uses of Class org.apache.pulsar.broker.loadbalance.ResourceDescription" class="title">Uses of Class<br>org.apache.pulsar.broker.loadbalance.ResourceDescription</h1>
</div>
<div class="caption"><span>Packages that use <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></span></div>
<div class="summary-table two-column-summary">
<div class="table-header col-first">Package</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><a href="#org.apache.pulsar.broker.loadbalance">org.apache.pulsar.broker.loadbalance</a></div>
<div class="col-last even-row-color">
<div class="block">Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.</div>
</div>
<div class="col-first odd-row-color"><a href="#org.apache.pulsar.broker.loadbalance.impl">org.apache.pulsar.broker.loadbalance.impl</a></div>
<div class="col-last odd-row-color">
<div class="block">Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.</div>
</div>
</div>
<section class="class-uses">
<ul class="block-list">
<li>
<section class="detail" id="org.apache.pulsar.broker.loadbalance">
<h2>Uses of <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a> in <a href="../package-summary.html">org.apache.pulsar.broker.loadbalance</a></h2>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.pulsar.broker.loadbalance</a> that return <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ResourceUnit.</span><code><a href="../ResourceUnit.html#getAvailableResource()" class="member-name-link">getAvailableResource</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LoadCalculator.</span><code><a href="../LoadCalculator.html#getResourceDescription(org.apache.pulsar.broker.loadbalance.ServiceRequest)" class="member-name-link">getResourceDescription</a><wbr>(<a href="../ServiceRequest.html" title="class in org.apache.pulsar.broker.loadbalance">ServiceRequest</a>&nbsp;srvRequest)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>abstract <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">ServiceUnit.</span><code><a href="../ServiceUnit.html#getResourceDescription()" class="member-name-link">getResourceDescription</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">LoadReport.</span><code><a href="../LoadReport.html#getResourceUnitDescription()" class="member-name-link">getResourceUnitDescription</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../package-summary.html">org.apache.pulsar.broker.loadbalance</a> with parameters of type <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>abstract void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ResourceDescription.</span><code><a href="../ResourceDescription.html#addUsage(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">addUsage</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ResourceUnit.</span><code><a href="../ResourceUnit.html#canFit(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">canFit</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;resourceDescription)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>long</code></div>
<div class="col-second even-row-color"><span class="type-name-label">LoadRanker.</span><code><a href="../LoadRanker.html#getRank(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">getRank</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>abstract void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">ResourceDescription.</span><code><a href="../ResourceDescription.html#removeUsage(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">removeUsage</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>abstract void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ServiceUnit.</span><code><a href="../ServiceUnit.html#setResourceDescription(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">setResourceDescription</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;serviceUnitResourceUsage)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<li>
<section class="detail" id="org.apache.pulsar.broker.loadbalance.impl">
<h2>Uses of <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a> in <a href="../impl/package-summary.html">org.apache.pulsar.broker.loadbalance.impl</a></h2>
<div class="caption"><span>Subclasses of <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a> in <a href="../impl/package-summary.html">org.apache.pulsar.broker.loadbalance.impl</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Class</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>class&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/PulsarResourceDescription.html" class="type-name-link" title="class in org.apache.pulsar.broker.loadbalance.impl">PulsarResourceDescription</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.pulsar.broker.loadbalance.impl</a> that return <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SimpleResourceUnit.</span><code><a href="../impl/SimpleResourceUnit.html#getAvailableResource()" class="member-name-link">getAvailableResource</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">PulsarServiceUnit.</span><code><a href="../impl/PulsarServiceUnit.html#getResourceDescription()" class="member-name-link">getResourceDescription</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second even-row-color"><span class="type-name-label">SimpleLoadCalculatorImpl.</span><code><a href="../impl/SimpleLoadCalculatorImpl.html#getResourceDescription(org.apache.pulsar.broker.loadbalance.ServiceRequest)" class="member-name-link">getResourceDescription</a><wbr>(<a href="../ServiceRequest.html" title="class in org.apache.pulsar.broker.loadbalance">ServiceRequest</a>&nbsp;srvRequest)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code><a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></code></div>
<div class="col-second odd-row-color"><span class="type-name-label">PulsarLoadReportImpl.</span><code><a href="../impl/PulsarLoadReportImpl.html#getResourceUnitDescription()" class="member-name-link">getResourceUnitDescription</a>()</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Methods in <a href="../impl/package-summary.html">org.apache.pulsar.broker.loadbalance.impl</a> with parameters of type <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">PulsarResourceDescription.</span><code><a href="../impl/PulsarResourceDescription.html#addUsage(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">addUsage</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">SimpleResourceUnit.</span><code><a href="../impl/SimpleResourceUnit.html#canFit(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">canFit</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;resourceDescription)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>int</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ResourceAvailabilityRanker.</span><code><a href="../impl/ResourceAvailabilityRanker.html#compare(org.apache.pulsar.broker.loadbalance.ResourceDescription,org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">compare</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd1,
<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd2)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>int</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">PulsarResourceDescription.</span><code><a href="../impl/PulsarResourceDescription.html#compareTo(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">compareTo</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;o)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>long</code></div>
<div class="col-second even-row-color"><span class="type-name-label">ResourceAvailabilityRanker.</span><code><a href="../impl/ResourceAvailabilityRanker.html#getRank(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">getRank</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;resourceDescription)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>void</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">PulsarResourceDescription.</span><code><a href="../impl/PulsarResourceDescription.html#removeUsage(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">removeUsage</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
<div class="col-first even-row-color"><code>void</code></div>
<div class="col-second even-row-color"><span class="type-name-label">PulsarServiceUnit.</span><code><a href="../impl/PulsarServiceUnit.html#setResourceDescription(org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">setResourceDescription</a><wbr>(<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;rd)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="caption"><span>Constructors in <a href="../impl/package-summary.html">org.apache.pulsar.broker.loadbalance.impl</a> with parameters of type <a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a></span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier</div>
<div class="table-header col-second">Constructor</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="../impl/SimpleResourceUnit.html#%3Cinit%3E(java.lang.String,org.apache.pulsar.broker.loadbalance.ResourceDescription)" class="member-name-link">SimpleResourceUnit</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;resourceId,
<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;resourceDescription)</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>&nbsp;</code></div>
<div class="col-second odd-row-color"><code><a href="../impl/SimpleResourceUnit.html#%3Cinit%3E(java.lang.String,org.apache.pulsar.broker.loadbalance.ResourceDescription,java.util.Map)" class="member-name-link">SimpleResourceUnit</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;resourceId,
<a href="../ResourceDescription.html" title="class in org.apache.pulsar.broker.loadbalance">ResourceDescription</a>&nbsp;resourceDescription,
<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a>&lt;<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>&gt;&nbsp;properties)</code></div>
<div class="col-last odd-row-color">&nbsp;</div>
</div>
</section>
</li>
</ul>
</section>
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2017&#x2013;2022 <a href="http://www.apache.org/">Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>