| <!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_181-google-v7) on Fri Oct 04 15:32:55 PDT 2019 --> |
| <title>QuotaLimitOrBuilder (java API)</title> |
| <meta name="date" content="2019-10-04"> |
| <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="QuotaLimitOrBuilder (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":38,"i17":6,"i18":6,"i19":6,"i20":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </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><a href="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="../../../com/google/api/QuotaLimit.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/api/QuotaOrBuilder.html" title="interface in com.google.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/api/QuotaLimitOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="QuotaLimitOrBuilder.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">com.google.api</div> |
| <h2 title="Interface QuotaLimitOrBuilder" class="title">Interface QuotaLimitOrBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../com/google/api/QuotaLimit.html" title="class in com.google.api">QuotaLimit</a>, <a href="../../../com/google/api/QuotaLimit.Builder.html" title="class in com.google.api">QuotaLimit.Builder</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">QuotaLimitOrBuilder</span> |
| extends <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#containsValues-java.lang.String-">containsValues</a></span>(java.lang.String key)</code> |
| <div class="block"> |
| Tiered limit values.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getDefaultLimit--">getDefaultLimit</a></span>()</code> |
| <div class="block"> |
| Default number of tokens that can be consumed during the specified |
| duration.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getDescription--">getDescription</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getDescriptionBytes--">getDescriptionBytes</a></span>()</code> |
| <div class="block"> |
| Optional.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getDisplayName--">getDisplayName</a></span>()</code> |
| <div class="block"> |
| User-visible display name for this limit.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getDisplayNameBytes--">getDisplayNameBytes</a></span>()</code> |
| <div class="block"> |
| User-visible display name for this limit.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getDuration--">getDuration</a></span>()</code> |
| <div class="block"> |
| Duration of this limit in textual notation.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getDurationBytes--">getDurationBytes</a></span>()</code> |
| <div class="block"> |
| Duration of this limit in textual notation.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getFreeTier--">getFreeTier</a></span>()</code> |
| <div class="block"> |
| Free tier value displayed in the Developers Console for this limit.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getMaxLimit--">getMaxLimit</a></span>()</code> |
| <div class="block"> |
| Maximum number of tokens that can be consumed during the specified |
| duration.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getMetric--">getMetric</a></span>()</code> |
| <div class="block"> |
| The name of the metric this quota limit applies to.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getMetricBytes--">getMetricBytes</a></span>()</code> |
| <div class="block"> |
| The name of the metric this quota limit applies to.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getName--">getName</a></span>()</code> |
| <div class="block"> |
| Name of the quota limit.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getNameBytes--">getNameBytes</a></span>()</code> |
| <div class="block"> |
| Name of the quota limit.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getUnit--">getUnit</a></span>()</code> |
| <div class="block"> |
| Specify the unit of the quota limit.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getUnitBytes--">getUnitBytes</a></span>()</code> |
| <div class="block"> |
| Specify the unit of the quota limit.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getValues--">getValues</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getValuesCount--">getValuesCount</a></span>()</code> |
| <div class="block"> |
| Tiered limit values.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.Long></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getValuesMap--">getValuesMap</a></span>()</code> |
| <div class="block"> |
| Tiered limit values.</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getValuesOrDefault-java.lang.String-long-">getValuesOrDefault</a></span>(java.lang.String key, |
| long defaultValue)</code> |
| <div class="block"> |
| Tiered limit values.</div> |
| </td> |
| </tr> |
| <tr id="i20" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/QuotaLimitOrBuilder.html#getValuesOrThrow-java.lang.String-">getValuesOrThrow</a></span>(java.lang.String key)</code> |
| <div class="block"> |
| Tiered limit values.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#findInitializationErrors--" title="class or interface in com.google.protobuf">findInitializationErrors</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getAllFields--" title="class or interface in com.google.protobuf">getAllFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDefaultInstanceForType--" title="class or interface in com.google.protobuf">getDefaultInstanceForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getDescriptorForType--" title="class or interface in com.google.protobuf">getDescriptorForType</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getInitializationErrorString--" title="class or interface in com.google.protobuf">getInitializationErrorString</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getOneofFieldDescriptor-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">getOneofFieldDescriptor</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedField-com.google.protobuf.Descriptors.FieldDescriptor-int-" title="class or interface in com.google.protobuf">getRepeatedField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getRepeatedFieldCount-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">getRepeatedFieldCount</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#getUnknownFields--" title="class or interface in com.google.protobuf">getUnknownFields</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasField-com.google.protobuf.Descriptors.FieldDescriptor-" title="class or interface in com.google.protobuf">hasField</a>, <a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageOrBuilder.html?is-external=true#hasOneof-com.google.protobuf.Descriptors.OneofDescriptor-" title="class or interface in com.google.protobuf">hasOneof</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.com.google.protobuf.MessageLiteOrBuilder"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface com.google.protobuf.<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true" title="class or interface in com.google.protobuf">MessageLiteOrBuilder</a></h3> |
| <code><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/MessageLiteOrBuilder.html?is-external=true#isInitialized--" title="class or interface in com.google.protobuf">isInitialized</a></code></li> |
| </ul> |
| </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="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>java.lang.String getName()</pre> |
| <div class="block"><pre> |
| Name of the quota limit. |
| The name must be provided, and it must be unique within the service. The |
| name can only include alphanumeric characters as well as '-'. |
| The maximum length of the limit name is 64 characters. |
| </pre> |
| |
| <code>string name = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getNameBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getNameBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getNameBytes()</pre> |
| <div class="block"><pre> |
| Name of the quota limit. |
| The name must be provided, and it must be unique within the service. The |
| name can only include alphanumeric characters as well as '-'. |
| The maximum length of the limit name is 64 characters. |
| </pre> |
| |
| <code>string name = 6;</code></div> |
| </li> |
| </ul> |
| <a name="getDescription--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescription</h4> |
| <pre>java.lang.String getDescription()</pre> |
| <div class="block"><pre> |
| Optional. User-visible, extended description for this quota limit. |
| Should be used only when more context is needed to understand this limit |
| than provided by the limit's display name (see: `display_name`). |
| </pre> |
| |
| <code>string description = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getDescriptionBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDescriptionBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getDescriptionBytes()</pre> |
| <div class="block"><pre> |
| Optional. User-visible, extended description for this quota limit. |
| Should be used only when more context is needed to understand this limit |
| than provided by the limit's display name (see: `display_name`). |
| </pre> |
| |
| <code>string description = 2;</code></div> |
| </li> |
| </ul> |
| <a name="getDefaultLimit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDefaultLimit</h4> |
| <pre>long getDefaultLimit()</pre> |
| <div class="block"><pre> |
| Default number of tokens that can be consumed during the specified |
| duration. This is the number of tokens assigned when a client |
| application developer activates the service for his/her project. |
| Specifying a value of 0 will block all requests. This can be used if you |
| are provisioning quota to selected consumers and blocking others. |
| Similarly, a value of -1 will indicate an unlimited quota. No other |
| negative values are allowed. |
| Used by group-based quotas only. |
| </pre> |
| |
| <code>int64 default_limit = 3;</code></div> |
| </li> |
| </ul> |
| <a name="getMaxLimit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxLimit</h4> |
| <pre>long getMaxLimit()</pre> |
| <div class="block"><pre> |
| Maximum number of tokens that can be consumed during the specified |
| duration. Client application developers can override the default limit up |
| to this maximum. If specified, this value cannot be set to a value less |
| than the default limit. If not specified, it is set to the default limit. |
| To allow clients to apply overrides with no upper bound, set this to -1, |
| indicating unlimited maximum quota. |
| Used by group-based quotas only. |
| </pre> |
| |
| <code>int64 max_limit = 4;</code></div> |
| </li> |
| </ul> |
| <a name="getFreeTier--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFreeTier</h4> |
| <pre>long getFreeTier()</pre> |
| <div class="block"><pre> |
| Free tier value displayed in the Developers Console for this limit. |
| The free tier is the number of tokens that will be subtracted from the |
| billed amount when billing is enabled. |
| This field can only be set on a limit with duration "1d", in a billable |
| group; it is invalid on any other limit. If this field is not set, it |
| defaults to 0, indicating that there is no free tier for this service. |
| Used by group-based quotas only. |
| </pre> |
| |
| <code>int64 free_tier = 7;</code></div> |
| </li> |
| </ul> |
| <a name="getDuration--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDuration</h4> |
| <pre>java.lang.String getDuration()</pre> |
| <div class="block"><pre> |
| Duration of this limit in textual notation. Example: "100s", "24h", "1d". |
| For duration longer than a day, only multiple of days is supported. We |
| support only "100s" and "1d" for now. Additional support will be added in |
| the future. "0" indicates indefinite duration. |
| Used by group-based quotas only. |
| </pre> |
| |
| <code>string duration = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getDurationBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDurationBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getDurationBytes()</pre> |
| <div class="block"><pre> |
| Duration of this limit in textual notation. Example: "100s", "24h", "1d". |
| For duration longer than a day, only multiple of days is supported. We |
| support only "100s" and "1d" for now. Additional support will be added in |
| the future. "0" indicates indefinite duration. |
| Used by group-based quotas only. |
| </pre> |
| |
| <code>string duration = 5;</code></div> |
| </li> |
| </ul> |
| <a name="getMetric--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetric</h4> |
| <pre>java.lang.String getMetric()</pre> |
| <div class="block"><pre> |
| The name of the metric this quota limit applies to. The quota limits with |
| the same metric will be checked together during runtime. The metric must be |
| defined within the service config. |
| </pre> |
| |
| <code>string metric = 8;</code></div> |
| </li> |
| </ul> |
| <a name="getMetricBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMetricBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getMetricBytes()</pre> |
| <div class="block"><pre> |
| The name of the metric this quota limit applies to. The quota limits with |
| the same metric will be checked together during runtime. The metric must be |
| defined within the service config. |
| </pre> |
| |
| <code>string metric = 8;</code></div> |
| </li> |
| </ul> |
| <a name="getUnit--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnit</h4> |
| <pre>java.lang.String getUnit()</pre> |
| <div class="block"><pre> |
| Specify the unit of the quota limit. It uses the same syntax as |
| [Metric.unit][]. The supported unit kinds are determined by the quota |
| backend system. |
| Here are some examples: |
| * "1/min/{project}" for quota per minute per project. |
| Note: the order of unit components is insignificant. |
| The "1" at the beginning is required to follow the metric unit syntax. |
| </pre> |
| |
| <code>string unit = 9;</code></div> |
| </li> |
| </ul> |
| <a name="getUnitBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getUnitBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getUnitBytes()</pre> |
| <div class="block"><pre> |
| Specify the unit of the quota limit. It uses the same syntax as |
| [Metric.unit][]. The supported unit kinds are determined by the quota |
| backend system. |
| Here are some examples: |
| * "1/min/{project}" for quota per minute per project. |
| Note: the order of unit components is insignificant. |
| The "1" at the beginning is required to follow the metric unit syntax. |
| </pre> |
| |
| <code>string unit = 9;</code></div> |
| </li> |
| </ul> |
| <a name="getValuesCount--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValuesCount</h4> |
| <pre>int getValuesCount()</pre> |
| <div class="block"><pre> |
| Tiered limit values. You must specify this as a key:value pair, with an |
| integer value that is the maximum number of requests allowed for the |
| specified unit. Currently only STANDARD is supported. |
| </pre> |
| |
| <code>map<string, int64> values = 10;</code></div> |
| </li> |
| </ul> |
| <a name="containsValues-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>containsValues</h4> |
| <pre>boolean containsValues(java.lang.String key)</pre> |
| <div class="block"><pre> |
| Tiered limit values. You must specify this as a key:value pair, with an |
| integer value that is the maximum number of requests allowed for the |
| specified unit. Currently only STANDARD is supported. |
| </pre> |
| |
| <code>map<string, int64> values = 10;</code></div> |
| </li> |
| </ul> |
| <a name="getValues--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValues</h4> |
| <pre>@Deprecated |
| java.util.Map<java.lang.String,java.lang.Long> getValues()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Use <a href="../../../com/google/api/QuotaLimitOrBuilder.html#getValuesMap--"><code>getValuesMap()</code></a> instead.</div> |
| </li> |
| </ul> |
| <a name="getValuesMap--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValuesMap</h4> |
| <pre>java.util.Map<java.lang.String,java.lang.Long> getValuesMap()</pre> |
| <div class="block"><pre> |
| Tiered limit values. You must specify this as a key:value pair, with an |
| integer value that is the maximum number of requests allowed for the |
| specified unit. Currently only STANDARD is supported. |
| </pre> |
| |
| <code>map<string, int64> values = 10;</code></div> |
| </li> |
| </ul> |
| <a name="getValuesOrDefault-java.lang.String-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValuesOrDefault</h4> |
| <pre>long getValuesOrDefault(java.lang.String key, |
| long defaultValue)</pre> |
| <div class="block"><pre> |
| Tiered limit values. You must specify this as a key:value pair, with an |
| integer value that is the maximum number of requests allowed for the |
| specified unit. Currently only STANDARD is supported. |
| </pre> |
| |
| <code>map<string, int64> values = 10;</code></div> |
| </li> |
| </ul> |
| <a name="getValuesOrThrow-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getValuesOrThrow</h4> |
| <pre>long getValuesOrThrow(java.lang.String key)</pre> |
| <div class="block"><pre> |
| Tiered limit values. You must specify this as a key:value pair, with an |
| integer value that is the maximum number of requests allowed for the |
| specified unit. Currently only STANDARD is supported. |
| </pre> |
| |
| <code>map<string, int64> values = 10;</code></div> |
| </li> |
| </ul> |
| <a name="getDisplayName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDisplayName</h4> |
| <pre>java.lang.String getDisplayName()</pre> |
| <div class="block"><pre> |
| User-visible display name for this limit. |
| Optional. If not set, the UI will provide a default display name based on |
| the quota configuration. This field can be used to override the default |
| display name generated from the configuration. |
| </pre> |
| |
| <code>string display_name = 12;</code></div> |
| </li> |
| </ul> |
| <a name="getDisplayNameBytes--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getDisplayNameBytes</h4> |
| <pre><a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/ByteString.html?is-external=true" title="class or interface in com.google.protobuf">ByteString</a> getDisplayNameBytes()</pre> |
| <div class="block"><pre> |
| User-visible display name for this limit. |
| Optional. If not set, the UI will provide a default display name based on |
| the quota configuration. This field can be used to override the default |
| display name generated from the configuration. |
| </pre> |
| |
| <code>string display_name = 12;</code></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> |
| <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><a href="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="../../../com/google/api/QuotaLimit.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/api/QuotaOrBuilder.html" title="interface in com.google.api"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/api/QuotaLimitOrBuilder.html" target="_top">Frames</a></li> |
| <li><a href="QuotaLimitOrBuilder.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> |