Google Git
Sign in
apache / beam-site / 2319bdc64590ef0568e12df9bd27c67faffa3ff7 / . / pydoc / 2.31.0 / apache_beam.portability.api.metrics_pb2_urns.html
blob: 872ab7c3e45eb0bd17ce76c29710991cbffa157b [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>apache_beam.portability.api.metrics_pb2_urns module &mdash; Apache Beam documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="apache_beam.portability.api.schema_pb2_grpc module" href="apache_beam.portability.api.schema_pb2_grpc.html" />
<link rel="prev" title="apache_beam.portability.api.metrics_pb2_grpc module" href="apache_beam.portability.api.metrics_pb2_grpc.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home"> Apache Beam
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.portability.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.portability.api.html">apache_beam.portability.api package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.portability.api.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.portability.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Apache Beam</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> &raquo;</li>
<li><a href="apache_beam.portability.html">apache_beam.portability package</a> &raquo;</li>
<li><a href="apache_beam.portability.api.html">apache_beam.portability.api package</a> &raquo;</li>
<li>apache_beam.portability.api.metrics_pb2_urns module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.portability.api.metrics_pb2_urns.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-apache_beam.portability.api.metrics_pb2_urns">
<span id="apache-beam-portability-api-metrics-pb2-urns-module"></span><h1>apache_beam.portability.api.metrics_pb2_urns module<a class="headerlink" href="#module-apache_beam.portability.api.metrics_pb2_urns" title="Permalink to this headline"></a></h1>
<dl class="class">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.metrics_pb2_urns.</code><code class="descname">MonitoringInfo</code><a class="reference internal" href="_modules/apache_beam/portability/api/metrics_pb2_urns.html#MonitoringInfo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="class">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels">
<em class="property">class </em><code class="descname">MonitoringInfoLabels</code><a class="reference internal" href="_modules/apache_beam/portability/api/metrics_pb2_urns.html#MonitoringInfo.MonitoringInfoLabels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.TRANSFORM">
<code class="descname">TRANSFORM</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;PTRANSFORM&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.TRANSFORM" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.PCOLLECTION">
<code class="descname">PCOLLECTION</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;PCOLLECTION&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.PCOLLECTION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.WINDOWING_STRATEGY">
<code class="descname">WINDOWING_STRATEGY</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;WINDOWING_STRATEGY&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.WINDOWING_STRATEGY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.CODER">
<code class="descname">CODER</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;CODER&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.CODER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.ENVIRONMENT">
<code class="descname">ENVIRONMENT</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;ENVIRONMENT&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.ENVIRONMENT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAMESPACE">
<code class="descname">NAMESPACE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;NAMESPACE&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAMESPACE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAME">
<code class="descname">NAME</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;NAME&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAME" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SERVICE">
<code class="descname">SERVICE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;SERVICE&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SERVICE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.METHOD">
<code class="descname">METHOD</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;METHOD&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.METHOD" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.RESOURCE">
<code class="descname">RESOURCE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;RESOURCE&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.RESOURCE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.STATUS">
<code class="descname">STATUS</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;STATUS&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.STATUS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_PROJECT_ID">
<code class="descname">BIGQUERY_PROJECT_ID</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;BIGQUERY_PROJECT_ID&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_PROJECT_ID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_DATASET">
<code class="descname">BIGQUERY_DATASET</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;BIGQUERY_DATASET&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_DATASET" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_TABLE">
<code class="descname">BIGQUERY_TABLE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;BIGQUERY_TABLE&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_TABLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_VIEW">
<code class="descname">BIGQUERY_VIEW</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;BIGQUERY_VIEW&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_VIEW" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_QUERY_NAME">
<code class="descname">BIGQUERY_QUERY_NAME</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=, label_props=name: &quot;BIGQUERY_QUERY_NAME&quot; )</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_QUERY_NAME" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.metrics_pb2_urns.</code><code class="descname">MonitoringInfoSpecs</code><a class="reference internal" href="_modules/apache_beam/portability/api/metrics_pb2_urns.html#MonitoringInfoSpecs"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="class">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum">
<em class="property">class </em><code class="descname">Enum</code><a class="reference internal" href="_modules/apache_beam/portability/api/metrics_pb2_urns.html#MonitoringInfoSpecs.Enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_INT64">
<code class="descname">USER_SUM_INT64</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:sum_int64:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_INT64" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_DOUBLE">
<code class="descname">USER_SUM_DOUBLE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:sum_double:v1&quot; type: &quot;beam:metrics:sum_double:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_DOUBLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_INT64">
<code class="descname">USER_DISTRIBUTION_INT64</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:distribution_int64:v1&quot; type: &quot;beam:metrics:distribution_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_INT64" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_DOUBLE">
<code class="descname">USER_DISTRIBUTION_DOUBLE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:distribution_double:v1&quot; type: &quot;beam:metrics:distribution_double:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_DOUBLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_INT64">
<code class="descname">USER_LATEST_INT64</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:latest_int64:v1&quot; type: &quot;beam:metrics:latest_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_INT64" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_DOUBLE">
<code class="descname">USER_LATEST_DOUBLE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:latest_double:v1&quot; type: &quot;beam:metrics:latest_double:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_DOUBLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_INT64">
<code class="descname">USER_TOP_N_INT64</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:top_n_int64:v1&quot; type: &quot;beam:metrics:top_n_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_INT64" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_DOUBLE">
<code class="descname">USER_TOP_N_DOUBLE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:top_n_double:v1&quot; type: &quot;beam:metrics:top_n_double:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_DOUBLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_INT64">
<code class="descname">USER_BOTTOM_N_INT64</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:bottom_n_int64:v1&quot; type: &quot;beam:metrics:bottom_n_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_INT64" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_DOUBLE">
<code class="descname">USER_BOTTOM_N_DOUBLE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:user:bottom_n_double:v1&quot; type: &quot;beam:metrics:bottom_n_double:v1&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;NAMESPACE&quot; required_labels: &quot;NAME&quot; annotations { key: &quot;description&quot; value: &quot;URN utilized to report user metric.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_DOUBLE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.ELEMENT_COUNT">
<code class="descname">ELEMENT_COUNT</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:element_count:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;PCOLLECTION&quot; annotations { key: &quot;description&quot; value: &quot;The total elements output to a Pcollection by a PTransform.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.ELEMENT_COUNT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.SAMPLED_BYTE_SIZE">
<code class="descname">SAMPLED_BYTE_SIZE</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:sampled_byte_size:v1&quot; type: &quot;beam:metrics:distribution_int64:v1&quot; required_labels: &quot;PCOLLECTION&quot; annotations { key: &quot;description&quot; value: &quot;The total byte size and count of a sampled set (or all) of elements in the pcollection. Sampling is used because calculating the byte count involves serializing the elements which is CPU intensive.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.SAMPLED_BYTE_SIZE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.START_BUNDLE_MSECS">
<code class="descname">START_BUNDLE_MSECS</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:pardo_execution_time:start_bundle_msecs:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;The total estimated execution time of the start bundlefunction in a pardo&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.START_BUNDLE_MSECS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.PROCESS_BUNDLE_MSECS">
<code class="descname">PROCESS_BUNDLE_MSECS</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:pardo_execution_time:process_bundle_msecs:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;The total estimated execution time of the process bundlefunction in a pardo&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.PROCESS_BUNDLE_MSECS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.FINISH_BUNDLE_MSECS">
<code class="descname">FINISH_BUNDLE_MSECS</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:pardo_execution_time:finish_bundle_msecs:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;The total estimated execution time of the finish bundle function in a pardo&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.FINISH_BUNDLE_MSECS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.TOTAL_MSECS">
<code class="descname">TOTAL_MSECS</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:ptransform_execution_time:total_msecs:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;The total estimated execution time of the ptransform&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.TOTAL_MSECS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_REMAINING">
<code class="descname">WORK_REMAINING</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:ptransform_progress:remaining:v1&quot; type: &quot;beam:metrics:progress:v1&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;The remaining amount of work for each active element. Each active element represents an independent amount of work not shared with any other active element.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_REMAINING" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_COMPLETED">
<code class="descname">WORK_COMPLETED</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:ptransform_progress:completed:v1&quot; type: &quot;beam:metrics:progress:v1&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;The remaining amount of work for each active element. Each active element represents an independent amount of work not shared with any other active element.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_COMPLETED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.DATA_CHANNEL_READ_INDEX">
<code class="descname">DATA_CHANNEL_READ_INDEX</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:data_channel:read_index:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;The read index of the data channel.&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.DATA_CHANNEL_READ_INDEX" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_COUNT">
<code class="descname">API_REQUEST_COUNT</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:io:api_request_count:v1&quot; type: &quot;beam:metrics:sum_int64:v1&quot; required_labels: &quot;SERVICE&quot; required_labels: &quot;METHOD&quot; required_labels: &quot;RESOURCE&quot; required_labels: &quot;PTRANSFORM&quot; required_labels: &quot;STATUS&quot; annotations { key: &quot;description&quot; value: &quot;Request counts with status made to IO service APIs to batch read or write elements.&quot; } annotations { key: &quot;process_metric&quot; value: &quot;true&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_COUNT" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_LATENCIES">
<code class="descname">API_REQUEST_LATENCIES</code><em class="property"> = PropertiesFromEnumValue(urn='', constant='', spec=urn: &quot;beam:metric:io:api_request_latencies:v1&quot; type: &quot;beam:metrics:histogram_int64:v1&quot; required_labels: &quot;SERVICE&quot; required_labels: &quot;METHOD&quot; required_labels: &quot;RESOURCE&quot; required_labels: &quot;PTRANSFORM&quot; annotations { key: &quot;description&quot; value: &quot;Histogram counts for request latencies made to IO service APIs to batch read or write elements.&quot; } annotations { key: &quot;units&quot; value: &quot;Milliseconds&quot; } annotations { key: &quot;process_metric&quot; value: &quot;true&quot; } , label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_LATENCIES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.metrics_pb2_urns.</code><code class="descname">MonitoringInfoTypeUrns</code><a class="reference internal" href="_modules/apache_beam/portability/api/metrics_pb2_urns.html#MonitoringInfoTypeUrns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="class">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum">
<em class="property">class </em><code class="descname">Enum</code><a class="reference internal" href="_modules/apache_beam/portability/api/metrics_pb2_urns.html#MonitoringInfoTypeUrns.Enum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_INT64_TYPE">
<code class="descname">SUM_INT64_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:sum_int64:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_INT64_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_DOUBLE_TYPE">
<code class="descname">SUM_DOUBLE_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:sum_double:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_DOUBLE_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_INT64_TYPE">
<code class="descname">DISTRIBUTION_INT64_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:distribution_int64:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_INT64_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_DOUBLE_TYPE">
<code class="descname">DISTRIBUTION_DOUBLE_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:distribution_double:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_DOUBLE_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_INT64_TYPE">
<code class="descname">LATEST_INT64_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:latest_int64:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_INT64_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_DOUBLE_TYPE">
<code class="descname">LATEST_DOUBLE_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:latest_double:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_DOUBLE_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_INT64_TYPE">
<code class="descname">TOP_N_INT64_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:top_n_int64:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_INT64_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_DOUBLE_TYPE">
<code class="descname">TOP_N_DOUBLE_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:top_n_double:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_DOUBLE_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_INT64_TYPE">
<code class="descname">BOTTOM_N_INT64_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:bottom_n_int64:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_INT64_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_DOUBLE_TYPE">
<code class="descname">BOTTOM_N_DOUBLE_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:bottom_n_double:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_DOUBLE_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.PROGRESS_TYPE">
<code class="descname">PROGRESS_TYPE</code><em class="property"> = PropertiesFromEnumValue(urn='beam:metrics:progress:v1', constant='', spec=, label_props=)</em><a class="headerlink" href="#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.PROGRESS_TYPE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.portability.api.schema_pb2_grpc.html" class="btn btn-neutral float-right" title="apache_beam.portability.api.schema_pb2_grpc module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.portability.api.metrics_pb2_grpc.html" class="btn btn-neutral float-left" title="apache_beam.portability.api.metrics_pb2_grpc module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
&copy; Copyright
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>