blob: 60a6f32a793342dd8cb047e17d4f5973048c7641 [file] [log] [blame]
<!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>MetricRuleOrBuilder (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="MetricRuleOrBuilder (java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":38,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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/MetricRule.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/MonitoredResource.html" title="class in com.google.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/google/api/MetricRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="MetricRuleOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 MetricRuleOrBuilder" class="title">Interface MetricRuleOrBuilder</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/MetricRule.html" title="class in com.google.api">MetricRule</a>, <a href="../../../com/google/api/MetricRule.Builder.html" title="class in com.google.api">MetricRule.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MetricRuleOrBuilder</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</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/MetricRuleOrBuilder.html#containsMetricCosts-java.lang.String-">containsMetricCosts</a></span>(java.lang.String&nbsp;key)</code>
<div class="block">
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Long&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricRuleOrBuilder.html#getMetricCosts--">getMetricCosts</a></span>()</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricRuleOrBuilder.html#getMetricCostsCount--">getMetricCostsCount</a></span>()</code>
<div class="block">
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.util.Map&lt;java.lang.String,java.lang.Long&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricRuleOrBuilder.html#getMetricCostsMap--">getMetricCostsMap</a></span>()</code>
<div class="block">
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricRuleOrBuilder.html#getMetricCostsOrDefault-java.lang.String-long-">getMetricCostsOrDefault</a></span>(java.lang.String&nbsp;key,
long&nbsp;defaultValue)</code>
<div class="block">
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricRuleOrBuilder.html#getMetricCostsOrThrow-java.lang.String-">getMetricCostsOrThrow</a></span>(java.lang.String&nbsp;key)</code>
<div class="block">
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.</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/MetricRuleOrBuilder.html#getSelector--">getSelector</a></span>()</code>
<div class="block">
Selects the methods to which this rule applies.</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/MetricRuleOrBuilder.html#getSelectorBytes--">getSelectorBytes</a></span>()</code>
<div class="block">
Selects the methods to which this rule applies.</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&nbsp;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&nbsp;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="getSelector--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelector</h4>
<pre>java.lang.String&nbsp;getSelector()</pre>
<div class="block"><pre>
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
</pre>
<code>string selector = 1;</code></div>
</li>
</ul>
<a name="getSelectorBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSelectorBytes</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>&nbsp;getSelectorBytes()</pre>
<div class="block"><pre>
Selects the methods to which this rule applies.
Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
</pre>
<code>string selector = 1;</code></div>
</li>
</ul>
<a name="getMetricCostsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricCostsCount</h4>
<pre>int&nbsp;getMetricCostsCount()</pre>
<div class="block"><pre>
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.
The key of the map is the metric name, and the values are the amount
increased for the metric against which the quota limits are defined.
The value must not be negative.
</pre>
<code>map&lt;string, int64&gt; metric_costs = 2;</code></div>
</li>
</ul>
<a name="containsMetricCosts-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>containsMetricCosts</h4>
<pre>boolean&nbsp;containsMetricCosts(java.lang.String&nbsp;key)</pre>
<div class="block"><pre>
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.
The key of the map is the metric name, and the values are the amount
increased for the metric against which the quota limits are defined.
The value must not be negative.
</pre>
<code>map&lt;string, int64&gt; metric_costs = 2;</code></div>
</li>
</ul>
<a name="getMetricCosts--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricCosts</h4>
<pre>@Deprecated
java.util.Map&lt;java.lang.String,java.lang.Long&gt;&nbsp;getMetricCosts()</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;</div>
<div class="block">Use <a href="../../../com/google/api/MetricRuleOrBuilder.html#getMetricCostsMap--"><code>getMetricCostsMap()</code></a> instead.</div>
</li>
</ul>
<a name="getMetricCostsMap--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricCostsMap</h4>
<pre>java.util.Map&lt;java.lang.String,java.lang.Long&gt;&nbsp;getMetricCostsMap()</pre>
<div class="block"><pre>
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.
The key of the map is the metric name, and the values are the amount
increased for the metric against which the quota limits are defined.
The value must not be negative.
</pre>
<code>map&lt;string, int64&gt; metric_costs = 2;</code></div>
</li>
</ul>
<a name="getMetricCostsOrDefault-java.lang.String-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricCostsOrDefault</h4>
<pre>long&nbsp;getMetricCostsOrDefault(java.lang.String&nbsp;key,
long&nbsp;defaultValue)</pre>
<div class="block"><pre>
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.
The key of the map is the metric name, and the values are the amount
increased for the metric against which the quota limits are defined.
The value must not be negative.
</pre>
<code>map&lt;string, int64&gt; metric_costs = 2;</code></div>
</li>
</ul>
<a name="getMetricCostsOrThrow-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getMetricCostsOrThrow</h4>
<pre>long&nbsp;getMetricCostsOrThrow(java.lang.String&nbsp;key)</pre>
<div class="block"><pre>
Metrics to update when the selected methods are called, and the associated
cost applied to each metric.
The key of the map is the metric name, and the values are the amount
increased for the metric against which the quota limits are defined.
The value must not be negative.
</pre>
<code>map&lt;string, int64&gt; metric_costs = 2;</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/MetricRule.Builder.html" title="class in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/MonitoredResource.html" title="class in com.google.api"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/google/api/MetricRuleOrBuilder.html" target="_top">Frames</a></li>
<li><a href="MetricRuleOrBuilder.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>