| <!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.7.0_131) on Wed Mar 29 10:24:33 UTC 2017 --> |
| <title>Protos.RateLimitOrBuilder</title> |
| <meta name="date" content="2017-03-29"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="Protos.RateLimitOrBuilder"; |
| } |
| } |
| 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><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../org/apache/mesos/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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/mesos/Protos.RateLimit.Builder.html" title="class in org.apache.mesos"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/mesos/Protos.RateLimits.html" title="class in org.apache.mesos"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/mesos/Protos.RateLimitOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Protos.RateLimitOrBuilder.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.mesos</div> |
| <h2 title="Interface Protos.RateLimitOrBuilder" class="title">Interface Protos.RateLimitOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../org/apache/mesos/Protos.RateLimit.html" title="class in org.apache.mesos">Protos.RateLimit</a>, <a href="../../../org/apache/mesos/Protos.RateLimit.Builder.html" title="class in org.apache.mesos">Protos.RateLimit.Builder</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../org/apache/mesos/Protos.html" title="class in org.apache.mesos">Protos</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <span class="strong">Protos.RateLimitOrBuilder</span></pre> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.RateLimitOrBuilder.html#getCapacity()">getCapacity</a></strong>()</code> |
| <div class="block"><code>optional uint64 capacity = 3;</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.RateLimitOrBuilder.html#getPrincipal()">getPrincipal</a></strong>()</code> |
| <div class="block"><code>required string principal = 2;</code></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>com.google.protobuf.ByteString</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.RateLimitOrBuilder.html#getPrincipalBytes()">getPrincipalBytes</a></strong>()</code> |
| <div class="block"><code>required string principal = 2;</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.RateLimitOrBuilder.html#getQps()">getQps</a></strong>()</code> |
| <div class="block"><code>optional double qps = 1;</code></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.RateLimitOrBuilder.html#hasCapacity()">hasCapacity</a></strong>()</code> |
| <div class="block"><code>optional uint64 capacity = 3;</code></div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.RateLimitOrBuilder.html#hasPrincipal()">hasPrincipal</a></strong>()</code> |
| <div class="block"><code>required string principal = 2;</code></div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../org/apache/mesos/Protos.RateLimitOrBuilder.html#hasQps()">hasQps</a></strong>()</code> |
| <div class="block"><code>optional double qps = 1;</code></div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="hasQps()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasQps</h4> |
| <pre>boolean hasQps()</pre> |
| <div class="block"><code>optional double qps = 1;</code> |
| |
| <pre> |
| Leaving QPS unset gives it unlimited rate (i.e., not throttled), |
| which also implies unlimited capacity. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="getQps()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQps</h4> |
| <pre>double getQps()</pre> |
| <div class="block"><code>optional double qps = 1;</code> |
| |
| <pre> |
| Leaving QPS unset gives it unlimited rate (i.e., not throttled), |
| which also implies unlimited capacity. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="hasPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasPrincipal</h4> |
| <pre>boolean hasPrincipal()</pre> |
| <div class="block"><code>required string principal = 2;</code> |
| |
| <pre> |
| Principal of framework(s) to be throttled. Should match |
| FrameworkInfo.principal and Credential.principal (if using authentication). |
| </pre></div> |
| </li> |
| </ul> |
| <a name="getPrincipal()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipal</h4> |
| <pre>java.lang.String getPrincipal()</pre> |
| <div class="block"><code>required string principal = 2;</code> |
| |
| <pre> |
| Principal of framework(s) to be throttled. Should match |
| FrameworkInfo.principal and Credential.principal (if using authentication). |
| </pre></div> |
| </li> |
| </ul> |
| <a name="getPrincipalBytes()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrincipalBytes</h4> |
| <pre>com.google.protobuf.ByteString getPrincipalBytes()</pre> |
| <div class="block"><code>required string principal = 2;</code> |
| |
| <pre> |
| Principal of framework(s) to be throttled. Should match |
| FrameworkInfo.principal and Credential.principal (if using authentication). |
| </pre></div> |
| </li> |
| </ul> |
| <a name="hasCapacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasCapacity</h4> |
| <pre>boolean hasCapacity()</pre> |
| <div class="block"><code>optional uint64 capacity = 3;</code> |
| |
| <pre> |
| Max number of outstanding messages from frameworks of this principal |
| allowed by master before the next message is dropped and an error is sent |
| back to the sender. Messages received before the capacity is reached are |
| still going to be processed after the error is sent. |
| If unspecified, this principal is assigned unlimited capacity. |
| NOTE: This value is ignored if 'qps' is not set. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="getCapacity()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCapacity</h4> |
| <pre>long getCapacity()</pre> |
| <div class="block"><code>optional uint64 capacity = 3;</code> |
| |
| <pre> |
| Max number of outstanding messages from frameworks of this principal |
| allowed by master before the next message is dropped and an error is sent |
| back to the sender. Messages received before the capacity is reached are |
| still going to be processed after the error is sent. |
| If unspecified, this principal is assigned unlimited capacity. |
| NOTE: This value is ignored if 'qps' is not set. |
| </pre></div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../org/apache/mesos/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</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/mesos/Protos.RateLimit.Builder.html" title="class in org.apache.mesos"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/mesos/Protos.RateLimits.html" title="class in org.apache.mesos"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/mesos/Protos.RateLimitOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="Protos.RateLimitOrBuilder.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> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
