blob: 15a2076ab59d03e3ef791e1f696e3f0b6717ae10 [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 &mdash; Apache Beam 2.38.0 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" />
</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 class="version">
2.38.0
</div>
<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>
<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"><a class="reference internal" href="../../../../apache_beam.portability.html">apache_beam.portability package</a></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="../../../index.html">Module code</a> &raquo;</li>
<li>apache_beam.portability.api.metrics_pb2_urns</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for apache_beam.portability.api.metrics_pb2_urns</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">..utils</span> <span class="kn">import</span> <span class="n">PropertiesFromEnumValue</span>
<span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">metrics_pb2</span>
<span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span> <span class="o">=</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">()</span>
<span class="n">EMPTY_MONITORING_INFO_SPEC</span> <span class="o">=</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">()</span>
<div class="viewcode-block" id="MonitoringInfo"><a class="viewcode-back" href="../../../../apache_beam.portability.api.metrics_pb2_urns.html#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo">[docs]</a><span class="k">class</span> <span class="nc">MonitoringInfo</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<div class="viewcode-block" id="MonitoringInfo.MonitoringInfoLabels"><a class="viewcode-back" href="../../../../apache_beam.portability.api.metrics_pb2_urns.html#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels">[docs]</a> <span class="k">class</span> <span class="nc">MonitoringInfoLabels</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">TRANSFORM</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">))</span>
<span class="n">PCOLLECTION</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;PCOLLECTION&#39;</span><span class="p">))</span>
<span class="n">WINDOWING_STRATEGY</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;WINDOWING_STRATEGY&#39;</span><span class="p">))</span>
<span class="n">CODER</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;CODER&#39;</span><span class="p">))</span>
<span class="n">ENVIRONMENT</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;ENVIRONMENT&#39;</span><span class="p">))</span>
<span class="n">NAMESPACE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;NAMESPACE&#39;</span><span class="p">))</span>
<span class="n">NAME</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;NAME&#39;</span><span class="p">))</span>
<span class="n">SERVICE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;SERVICE&#39;</span><span class="p">))</span>
<span class="n">METHOD</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;METHOD&#39;</span><span class="p">))</span>
<span class="n">RESOURCE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;RESOURCE&#39;</span><span class="p">))</span>
<span class="n">STATUS</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;STATUS&#39;</span><span class="p">))</span>
<span class="n">BIGQUERY_PROJECT_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;BIGQUERY_PROJECT_ID&#39;</span><span class="p">))</span>
<span class="n">BIGQUERY_DATASET</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;BIGQUERY_DATASET&#39;</span><span class="p">))</span>
<span class="n">BIGQUERY_TABLE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;BIGQUERY_TABLE&#39;</span><span class="p">))</span>
<span class="n">BIGQUERY_VIEW</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;BIGQUERY_VIEW&#39;</span><span class="p">))</span>
<span class="n">BIGQUERY_QUERY_NAME</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;BIGQUERY_QUERY_NAME&#39;</span><span class="p">))</span>
<span class="n">GCS_BUCKET</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;GCS_BUCKET&#39;</span><span class="p">))</span>
<span class="n">GCS_PROJECT_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;GCS_PROJECT_ID&#39;</span><span class="p">))</span>
<span class="n">DATASTORE_PROJECT</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;DATASTORE_PROJECT&#39;</span><span class="p">))</span>
<span class="n">DATASTORE_NAMESPACE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;DATASTORE_NAMESPACE&#39;</span><span class="p">))</span>
<span class="n">BIGTABLE_PROJECT_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;BIGTABLE_PROJECT_ID&#39;</span><span class="p">))</span>
<span class="n">INSTANCE_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;INSTANCE_ID&#39;</span><span class="p">))</span>
<span class="n">TABLE_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;TABLE_ID&#39;</span><span class="p">))</span>
<span class="n">SPANNER_PROJECT_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;SPANNER_PROJECT_ID&#39;</span><span class="p">))</span>
<span class="n">SPANNER_DATABASE_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;SPANNER_DATABASE_ID&#39;</span><span class="p">))</span>
<span class="n">SPANNER_TABLE_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;SPANNER_TABLE_ID&#39;</span><span class="p">))</span>
<span class="n">SPANNER_INSTANCE_ID</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;SPANNER_INSTANCE_ID&#39;</span><span class="p">))</span>
<span class="n">SPANNER_QUERY_NAME</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoLabelProps</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">&#39;SPANNER_QUERY_NAME&#39;</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="MonitoringInfoSpecs"><a class="viewcode-back" href="../../../../apache_beam.portability.api.metrics_pb2_urns.html#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs">[docs]</a><span class="k">class</span> <span class="nc">MonitoringInfoSpecs</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<div class="viewcode-block" id="MonitoringInfoSpecs.Enum"><a class="viewcode-back" href="../../../../apache_beam.portability.api.metrics_pb2_urns.html#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoSpecs.Enum">[docs]</a> <span class="k">class</span> <span class="nc">Enum</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">USER_SUM_INT64</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:sum_int64:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_SUM_DOUBLE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:sum_double:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_double:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_DISTRIBUTION_INT64</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:distribution_int64:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:distribution_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_DISTRIBUTION_DOUBLE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:distribution_double:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:distribution_double:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_LATEST_INT64</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:latest_int64:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:latest_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_LATEST_DOUBLE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:latest_double:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:latest_double:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_TOP_N_INT64</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:top_n_int64:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:top_n_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_TOP_N_DOUBLE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:top_n_double:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:top_n_double:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_BOTTOM_N_INT64</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:bottom_n_int64:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:bottom_n_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">USER_BOTTOM_N_DOUBLE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:user:bottom_n_double:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:bottom_n_double:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;NAMESPACE&#39;</span><span class="p">,</span> <span class="s1">&#39;NAME&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;URN utilized to report user metric.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">ELEMENT_COUNT</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:element_count:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PCOLLECTION&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;The total elements output to a Pcollection by a PTransform.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">SAMPLED_BYTE_SIZE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:sampled_byte_size:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:distribution_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PCOLLECTION&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;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.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">START_BUNDLE_MSECS</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:pardo_execution_time:start_bundle_msecs:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;The total estimated execution time of the start bundlefunction in a pardo&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">PROCESS_BUNDLE_MSECS</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:pardo_execution_time:process_bundle_msecs:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;The total estimated execution time of the process bundlefunction in a pardo&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">FINISH_BUNDLE_MSECS</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:pardo_execution_time:finish_bundle_msecs:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;The total estimated execution time of the finish bundle function in a pardo&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">TOTAL_MSECS</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:ptransform_execution_time:total_msecs:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;The total estimated execution time of the ptransform&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">WORK_REMAINING</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:ptransform_progress:remaining:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:progress:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;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.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">WORK_COMPLETED</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:ptransform_progress:completed:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:progress:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;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.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">DATA_CHANNEL_READ_INDEX</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:data_channel:read_index:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;The read index of the data channel.&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">API_REQUEST_COUNT</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:io:api_request_count:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;SERVICE&#39;</span><span class="p">,</span> <span class="s1">&#39;METHOD&#39;</span><span class="p">,</span> <span class="s1">&#39;RESOURCE&#39;</span><span class="p">,</span> <span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">,</span> <span class="s1">&#39;STATUS&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;Request counts with status made to IO service APIs to batch read or write elements.&#39;</span><span class="p">),</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;process_metric&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;true&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">API_REQUEST_LATENCIES</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">MonitoringInfoSpec</span><span class="p">(</span><span class="n">urn</span><span class="o">=</span><span class="s1">&#39;beam:metric:io:api_request_latencies:v1&#39;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;beam:metrics:histogram_int64:v1&#39;</span><span class="p">,</span> <span class="n">required_labels</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;SERVICE&#39;</span><span class="p">,</span> <span class="s1">&#39;METHOD&#39;</span><span class="p">,</span> <span class="s1">&#39;RESOURCE&#39;</span><span class="p">,</span> <span class="s1">&#39;PTRANSFORM&#39;</span><span class="p">],</span> <span class="n">annotations</span><span class="o">=</span><span class="p">[</span><span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;description&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;Histogram counts for request latencies made to IO service APIs to batch read or write elements.&#39;</span><span class="p">),</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;units&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;Milliseconds&#39;</span><span class="p">),</span> <span class="n">metrics_pb2</span><span class="o">.</span><span class="n">Annotation</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="s1">&#39;process_metric&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="s1">&#39;true&#39;</span><span class="p">)]),</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="MonitoringInfoTypeUrns"><a class="viewcode-back" href="../../../../apache_beam.portability.api.metrics_pb2_urns.html#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns">[docs]</a><span class="k">class</span> <span class="nc">MonitoringInfoTypeUrns</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<div class="viewcode-block" id="MonitoringInfoTypeUrns.Enum"><a class="viewcode-back" href="../../../../apache_beam.portability.api.metrics_pb2_urns.html#apache_beam.portability.api.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum">[docs]</a> <span class="k">class</span> <span class="nc">Enum</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="n">SUM_INT64_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:sum_int64:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">SUM_DOUBLE_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:sum_double:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">DISTRIBUTION_INT64_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:distribution_int64:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">DISTRIBUTION_DOUBLE_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:distribution_double:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">LATEST_INT64_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:latest_int64:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">LATEST_DOUBLE_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:latest_double:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">TOP_N_INT64_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:top_n_int64:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">TOP_N_DOUBLE_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:top_n_double:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">BOTTOM_N_INT64_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:bottom_n_int64:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">BOTTOM_N_DOUBLE_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:bottom_n_double:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span>
<span class="n">PROGRESS_TYPE</span> <span class="o">=</span> <span class="n">PropertiesFromEnumValue</span><span class="p">(</span><span class="s1">&#39;beam:metrics:progress:v1&#39;</span><span class="p">,</span> <span class="s1">&#39;&#39;</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_SPEC</span><span class="p">,</span> <span class="n">EMPTY_MONITORING_INFO_LABEL_PROPS</span><span class="p">)</span></div></div>
</pre></div>
</div>
</div>
<footer>
<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>