Google Git
Sign in
fuchsia / third_party / googleapis / upstream/gh-pages / . / java / all / latest / apidocs / com / google / api / MetricDescriptorOrBuilder.html
blob: 524aefceefba8daefa49d56e3c93b672f7f56913 [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:54 PDT 2019 -->
<title>MetricDescriptorOrBuilder (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="MetricDescriptorOrBuilder (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":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6,"i22":6,"i23":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/MetricDescriptor.ValueType.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/MetricOrBuilder.html" title="interface 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/MetricDescriptorOrBuilder.html" target="_top">Frames</a></li>
<li><a href="MetricDescriptorOrBuilder.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 MetricDescriptorOrBuilder" class="title">Interface MetricDescriptorOrBuilder</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/MetricDescriptor.html" title="class in com.google.api">MetricDescriptor</a>, <a href="../../../com/google/api/MetricDescriptor.Builder.html" title="class in com.google.api">MetricDescriptor.Builder</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">MetricDescriptorOrBuilder</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></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>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getDescription--">getDescription</a></span>()</code>
<div class="block">
A detailed description of the metric, which can be used in documentation.</div>
</td>
</tr>
<tr id="i1" 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/MetricDescriptorOrBuilder.html#getDescriptionBytes--">getDescriptionBytes</a></span>()</code>
<div class="block">
A detailed description of the metric, which can be used in documentation.</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/MetricDescriptorOrBuilder.html#getDisplayName--">getDisplayName</a></span>()</code>
<div class="block">
A concise name for the metric, which can be displayed in user interfaces.</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/MetricDescriptorOrBuilder.html#getDisplayNameBytes--">getDisplayNameBytes</a></span>()</code>
<div class="block">
A concise name for the metric, which can be displayed in user interfaces.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../com/google/api/LabelDescriptor.html" title="class in com.google.api">LabelDescriptor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getLabels-int-">getLabels</a></span>(int&nbsp;index)</code>
<div class="block">
The set of labels that can be used to describe a specific
instance of this metric type.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getLabelsCount--">getLabelsCount</a></span>()</code>
<div class="block">
The set of labels that can be used to describe a specific
instance of this metric type.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>java.util.List&lt;<a href="../../../com/google/api/LabelDescriptor.html" title="class in com.google.api">LabelDescriptor</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getLabelsList--">getLabelsList</a></span>()</code>
<div class="block">
The set of labels that can be used to describe a specific
instance of this metric type.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/LabelDescriptorOrBuilder.html" title="interface in com.google.api">LabelDescriptorOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getLabelsOrBuilder-int-">getLabelsOrBuilder</a></span>(int&nbsp;index)</code>
<div class="block">
The set of labels that can be used to describe a specific
instance of this metric type.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.util.List&lt;? extends <a href="../../../com/google/api/LabelDescriptorOrBuilder.html" title="interface in com.google.api">LabelDescriptorOrBuilder</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getLabelsOrBuilderList--">getLabelsOrBuilderList</a></span>()</code>
<div class="block">
The set of labels that can be used to describe a specific
instance of this metric type.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/LaunchStage.html" title="enum in com.google.api">LaunchStage</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getLaunchStage--">getLaunchStage</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getLaunchStageValue--">getLaunchStageValue</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/MetricDescriptor.MetricDescriptorMetadata.html" title="class in com.google.api">MetricDescriptor.MetricDescriptorMetadata</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getMetadata--">getMetadata</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="../../../com/google/api/MetricDescriptor.MetricDescriptorMetadataOrBuilder.html" title="interface in com.google.api">MetricDescriptor.MetricDescriptorMetadataOrBuilder</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getMetadataOrBuilder--">getMetadataOrBuilder</a></span>()</code>
<div class="block">
Optional.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/MetricDescriptor.MetricKind.html" title="enum in com.google.api">MetricDescriptor.MetricKind</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getMetricKind--">getMetricKind</a></span>()</code>
<div class="block">
Whether the metric records instantaneous values, changes to a value, etc.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getMetricKindValue--">getMetricKindValue</a></span>()</code>
<div class="block">
Whether the metric records instantaneous values, changes to a value, etc.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getName--">getName</a></span>()</code>
<div class="block">
The resource name of the metric descriptor.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<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/MetricDescriptorOrBuilder.html#getNameBytes--">getNameBytes</a></span>()</code>
<div class="block">
The resource name of the metric descriptor.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getType--">getType</a></span>()</code>
<div class="block">
The metric type, including its DNS name prefix.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<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/MetricDescriptorOrBuilder.html#getTypeBytes--">getTypeBytes</a></span>()</code>
<div class="block">
The metric type, including its DNS name prefix.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getUnit--">getUnit</a></span>()</code>
<div class="block">
The unit in which the metric value is reported.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<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/MetricDescriptorOrBuilder.html#getUnitBytes--">getUnitBytes</a></span>()</code>
<div class="block">
The unit in which the metric value is reported.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code><a href="../../../com/google/api/MetricDescriptor.ValueType.html" title="enum in com.google.api">MetricDescriptor.ValueType</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getValueType--">getValueType</a></span>()</code>
<div class="block">
Whether the measurement is an integer, a floating-point number, etc.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#getValueTypeValue--">getValueTypeValue</a></span>()</code>
<div class="block">
Whether the measurement is an integer, a floating-point number, etc.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/api/MetricDescriptorOrBuilder.html#hasMetadata--">hasMetadata</a></span>()</code>
<div class="block">
Optional.</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="getName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>java.lang.String&nbsp;getName()</pre>
<div class="block"><pre>
The resource name of the metric descriptor.
</pre>
<code>string name = 1;</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>&nbsp;getNameBytes()</pre>
<div class="block"><pre>
The resource name of the metric descriptor.
</pre>
<code>string name = 1;</code></div>
</li>
</ul>
<a name="getType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getType</h4>
<pre>java.lang.String&nbsp;getType()</pre>
<div class="block"><pre>
The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
`custom.googleapis.com` or `external.googleapis.com`. Metric types should
use a natural hierarchical grouping. For example:
"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"
</pre>
<code>string type = 8;</code></div>
</li>
</ul>
<a name="getTypeBytes--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTypeBytes</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;getTypeBytes()</pre>
<div class="block"><pre>
The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined metric types have the DNS name
`custom.googleapis.com` or `external.googleapis.com`. Metric types should
use a natural hierarchical grouping. For example:
"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"
</pre>
<code>string type = 8;</code></div>
</li>
</ul>
<a name="getLabelsList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsList</h4>
<pre>java.util.List&lt;<a href="../../../com/google/api/LabelDescriptor.html" title="class in com.google.api">LabelDescriptor</a>&gt;&nbsp;getLabelsList()</pre>
<div class="block"><pre>
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
`appengine.googleapis.com/http/server/response_latencies` metric
type has a label for the HTTP response code, `response_code`, so
you can look at latencies for successful responses or just
for responses that failed.
</pre>
<code>repeated .google.api.LabelDescriptor labels = 2;</code></div>
</li>
</ul>
<a name="getLabels-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabels</h4>
<pre><a href="../../../com/google/api/LabelDescriptor.html" title="class in com.google.api">LabelDescriptor</a>&nbsp;getLabels(int&nbsp;index)</pre>
<div class="block"><pre>
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
`appengine.googleapis.com/http/server/response_latencies` metric
type has a label for the HTTP response code, `response_code`, so
you can look at latencies for successful responses or just
for responses that failed.
</pre>
<code>repeated .google.api.LabelDescriptor labels = 2;</code></div>
</li>
</ul>
<a name="getLabelsCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsCount</h4>
<pre>int&nbsp;getLabelsCount()</pre>
<div class="block"><pre>
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
`appengine.googleapis.com/http/server/response_latencies` metric
type has a label for the HTTP response code, `response_code`, so
you can look at latencies for successful responses or just
for responses that failed.
</pre>
<code>repeated .google.api.LabelDescriptor labels = 2;</code></div>
</li>
</ul>
<a name="getLabelsOrBuilderList--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsOrBuilderList</h4>
<pre>java.util.List&lt;? extends <a href="../../../com/google/api/LabelDescriptorOrBuilder.html" title="interface in com.google.api">LabelDescriptorOrBuilder</a>&gt;&nbsp;getLabelsOrBuilderList()</pre>
<div class="block"><pre>
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
`appengine.googleapis.com/http/server/response_latencies` metric
type has a label for the HTTP response code, `response_code`, so
you can look at latencies for successful responses or just
for responses that failed.
</pre>
<code>repeated .google.api.LabelDescriptor labels = 2;</code></div>
</li>
</ul>
<a name="getLabelsOrBuilder-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabelsOrBuilder</h4>
<pre><a href="../../../com/google/api/LabelDescriptorOrBuilder.html" title="interface in com.google.api">LabelDescriptorOrBuilder</a>&nbsp;getLabelsOrBuilder(int&nbsp;index)</pre>
<div class="block"><pre>
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
`appengine.googleapis.com/http/server/response_latencies` metric
type has a label for the HTTP response code, `response_code`, so
you can look at latencies for successful responses or just
for responses that failed.
</pre>
<code>repeated .google.api.LabelDescriptor labels = 2;</code></div>
</li>
</ul>
<a name="getMetricKindValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricKindValue</h4>
<pre>int&nbsp;getMetricKindValue()</pre>
<div class="block"><pre>
Whether the metric records instantaneous values, changes to a value, etc.
Some combinations of `metric_kind` and `value_type` might not be supported.
</pre>
<code>.google.api.MetricDescriptor.MetricKind metric_kind = 3;</code></div>
</li>
</ul>
<a name="getMetricKind--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetricKind</h4>
<pre><a href="../../../com/google/api/MetricDescriptor.MetricKind.html" title="enum in com.google.api">MetricDescriptor.MetricKind</a>&nbsp;getMetricKind()</pre>
<div class="block"><pre>
Whether the metric records instantaneous values, changes to a value, etc.
Some combinations of `metric_kind` and `value_type` might not be supported.
</pre>
<code>.google.api.MetricDescriptor.MetricKind metric_kind = 3;</code></div>
</li>
</ul>
<a name="getValueTypeValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueTypeValue</h4>
<pre>int&nbsp;getValueTypeValue()</pre>
<div class="block"><pre>
Whether the measurement is an integer, a floating-point number, etc.
Some combinations of `metric_kind` and `value_type` might not be supported.
</pre>
<code>.google.api.MetricDescriptor.ValueType value_type = 4;</code></div>
</li>
</ul>
<a name="getValueType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueType</h4>
<pre><a href="../../../com/google/api/MetricDescriptor.ValueType.html" title="enum in com.google.api">MetricDescriptor.ValueType</a>&nbsp;getValueType()</pre>
<div class="block"><pre>
Whether the measurement is an integer, a floating-point number, etc.
Some combinations of `metric_kind` and `value_type` might not be supported.
</pre>
<code>.google.api.MetricDescriptor.ValueType value_type = 4;</code></div>
</li>
</ul>
<a name="getUnit--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnit</h4>
<pre>java.lang.String&nbsp;getUnit()</pre>
<div class="block"><pre>
The unit in which the metric value is reported. It is only applicable
if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
supported units are a subset of [The Unified Code for Units of
Measure](http://unitsofmeasure.org/ucum.html) standard:
**Basic units (UNIT)**
* `bit` bit
* `By` byte
* `s` second
* `min` minute
* `h` hour
* `d` day
**Prefixes (PREFIX)**
* `k` kilo (10**3)
* `M` mega (10**6)
* `G` giga (10**9)
* `T` tera (10**12)
* `P` peta (10**15)
* `E` exa (10**18)
* `Z` zetta (10**21)
* `Y` yotta (10**24)
* `m` milli (10**-3)
* `u` micro (10**-6)
* `n` nano (10**-9)
* `p` pico (10**-12)
* `f` femto (10**-15)
* `a` atto (10**-18)
* `z` zepto (10**-21)
* `y` yocto (10**-24)
* `Ki` kibi (2**10)
* `Mi` mebi (2**20)
* `Gi` gibi (2**30)
* `Ti` tebi (2**40)
**Grammar**
The grammar also includes these connectors:
* `/` division (as an infix operator, e.g. `1/s`).
* `.` multiplication (as an infix operator, e.g. `GBy.d`)
The grammar for a unit is as follows:
Expression = Component { "." Component } { "/" Component } ;
Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
| Annotation
| "1"
;
Annotation = "{" NAME "}" ;
Notes:
* `Annotation` is just a comment if it follows a `UNIT` and is
equivalent to `1` if it is used alone. For examples,
`{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
* `NAME` is a sequence of non-blank printable ASCII characters not
containing '{' or '}'.
* `1` represents dimensionless value 1, such as in `1/s`.
* `%` represents dimensionless value 1/100, and annotates values giving
a percentage.
</pre>
<code>string unit = 5;</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>&nbsp;getUnitBytes()</pre>
<div class="block"><pre>
The unit in which the metric value is reported. It is only applicable
if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
supported units are a subset of [The Unified Code for Units of
Measure](http://unitsofmeasure.org/ucum.html) standard:
**Basic units (UNIT)**
* `bit` bit
* `By` byte
* `s` second
* `min` minute
* `h` hour
* `d` day
**Prefixes (PREFIX)**
* `k` kilo (10**3)
* `M` mega (10**6)
* `G` giga (10**9)
* `T` tera (10**12)
* `P` peta (10**15)
* `E` exa (10**18)
* `Z` zetta (10**21)
* `Y` yotta (10**24)
* `m` milli (10**-3)
* `u` micro (10**-6)
* `n` nano (10**-9)
* `p` pico (10**-12)
* `f` femto (10**-15)
* `a` atto (10**-18)
* `z` zepto (10**-21)
* `y` yocto (10**-24)
* `Ki` kibi (2**10)
* `Mi` mebi (2**20)
* `Gi` gibi (2**30)
* `Ti` tebi (2**40)
**Grammar**
The grammar also includes these connectors:
* `/` division (as an infix operator, e.g. `1/s`).
* `.` multiplication (as an infix operator, e.g. `GBy.d`)
The grammar for a unit is as follows:
Expression = Component { "." Component } { "/" Component } ;
Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
| Annotation
| "1"
;
Annotation = "{" NAME "}" ;
Notes:
* `Annotation` is just a comment if it follows a `UNIT` and is
equivalent to `1` if it is used alone. For examples,
`{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
* `NAME` is a sequence of non-blank printable ASCII characters not
containing '{' or '}'.
* `1` represents dimensionless value 1, such as in `1/s`.
* `%` represents dimensionless value 1/100, and annotates values giving
a percentage.
</pre>
<code>string unit = 5;</code></div>
</li>
</ul>
<a name="getDescription--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDescription</h4>
<pre>java.lang.String&nbsp;getDescription()</pre>
<div class="block"><pre>
A detailed description of the metric, which can be used in documentation.
</pre>
<code>string description = 6;</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>&nbsp;getDescriptionBytes()</pre>
<div class="block"><pre>
A detailed description of the metric, which can be used in documentation.
</pre>
<code>string description = 6;</code></div>
</li>
</ul>
<a name="getDisplayName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDisplayName</h4>
<pre>java.lang.String&nbsp;getDisplayName()</pre>
<div class="block"><pre>
A concise name for the metric, which can be displayed in user interfaces.
Use sentence case without an ending period, for example "Request count".
This field is optional but it is recommended to be set for any metrics
associated with user-visible concepts, such as Quota.
</pre>
<code>string display_name = 7;</code></div>
</li>
</ul>
<a name="getDisplayNameBytes--">
<!-- -->
</a>
<ul class="blockList">
<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>&nbsp;getDisplayNameBytes()</pre>
<div class="block"><pre>
A concise name for the metric, which can be displayed in user interfaces.
Use sentence case without an ending period, for example "Request count".
This field is optional but it is recommended to be set for any metrics
associated with user-visible concepts, such as Quota.
</pre>
<code>string display_name = 7;</code></div>
</li>
</ul>
<a name="hasMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasMetadata</h4>
<pre>boolean&nbsp;hasMetadata()</pre>
<div class="block"><pre>
Optional. Metadata which can be used to guide usage of the metric.
</pre>
<code>.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;</code></div>
</li>
</ul>
<a name="getMetadata--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadata</h4>
<pre><a href="../../../com/google/api/MetricDescriptor.MetricDescriptorMetadata.html" title="class in com.google.api">MetricDescriptor.MetricDescriptorMetadata</a>&nbsp;getMetadata()</pre>
<div class="block"><pre>
Optional. Metadata which can be used to guide usage of the metric.
</pre>
<code>.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;</code></div>
</li>
</ul>
<a name="getMetadataOrBuilder--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetadataOrBuilder</h4>
<pre><a href="../../../com/google/api/MetricDescriptor.MetricDescriptorMetadataOrBuilder.html" title="interface in com.google.api">MetricDescriptor.MetricDescriptorMetadataOrBuilder</a>&nbsp;getMetadataOrBuilder()</pre>
<div class="block"><pre>
Optional. Metadata which can be used to guide usage of the metric.
</pre>
<code>.google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;</code></div>
</li>
</ul>
<a name="getLaunchStageValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLaunchStageValue</h4>
<pre>int&nbsp;getLaunchStageValue()</pre>
<div class="block"><pre>
Optional. The launch stage of the metric definition.
</pre>
<code>.google.api.LaunchStage launch_stage = 12;</code></div>
</li>
</ul>
<a name="getLaunchStage--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLaunchStage</h4>
<pre><a href="../../../com/google/api/LaunchStage.html" title="enum in com.google.api">LaunchStage</a>&nbsp;getLaunchStage()</pre>
<div class="block"><pre>
Optional. The launch stage of the metric definition.
</pre>
<code>.google.api.LaunchStage launch_stage = 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/MetricDescriptor.ValueType.html" title="enum in com.google.api"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../com/google/api/MetricOrBuilder.html" title="interface 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/MetricDescriptorOrBuilder.html" target="_top">Frames</a></li>
<li><a href="MetricDescriptorOrBuilder.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>