| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns module — Apache Beam 2.68.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=2388e03a"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.schema_pb2_grpc module" href="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.schema_pb2_grpc.html" /> |
| <link rel="prev" title="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_grpc module" href="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.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" aria-label="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="Navigation menu"> |
| <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#subpackages">Subpackages</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.testing.html">apache_beam.testing 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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml 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="Mobile navigation menu" > |
| <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="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.html">apache_beam.portability package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.api.html">apache_beam.portability.api package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.api.org.html">apache_beam.portability.api.org package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.api.org.apache.html">apache_beam.portability.api.org.apache package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.api.org.apache.beam.html">apache_beam.portability.api.org.apache.beam package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.api.org.apache.beam.model.html">apache_beam.portability.api.org.apache.beam.model package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.api.org.apache.beam.model.pipeline.html">apache_beam.portability.api.org.apache.beam.model.pipeline package</a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.html">apache_beam.portability.api.org.apache.beam.model.pipeline.v1 package</a></li> |
| <li class="breadcrumb-item active">apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns module</li> |
| <li class="wy-breadcrumbs-aside"> |
| <a href="_sources/apache_beam.portability.api.org.apache.beam.model.pipeline.v1.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"> |
| |
| <section id="module-apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns"> |
| <span id="apache-beam-portability-api-org-apache-beam-model-pipeline-v1-metrics-pb2-urns-module"></span><h1>apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns module<a class="headerlink" href="#module-apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns" title="Link to this heading"></a></h1> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.</span></span><span class="sig-name descname"><span class="pre">MonitoringInfo</span></span><a class="reference internal" href="_modules/apache_beam/portability/api/org/apache/beam/model/pipeline/v1/metrics_pb2_urns.html#MonitoringInfo"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MonitoringInfoLabels</span></span><a class="reference internal" href="_modules/apache_beam/portability/api/org/apache/beam/model/pipeline/v1/metrics_pb2_urns.html#MonitoringInfo.MonitoringInfoLabels"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.TRANSFORM"> |
| <span class="sig-name descname"><span class="pre">TRANSFORM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.TRANSFORM" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.PCOLLECTION"> |
| <span class="sig-name descname"><span class="pre">PCOLLECTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"PCOLLECTION"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.PCOLLECTION" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.WINDOWING_STRATEGY"> |
| <span class="sig-name descname"><span class="pre">WINDOWING_STRATEGY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"WINDOWING_STRATEGY"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.WINDOWING_STRATEGY" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.CODER"> |
| <span class="sig-name descname"><span class="pre">CODER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"CODER"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.CODER" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.ENVIRONMENT"> |
| <span class="sig-name descname"><span class="pre">ENVIRONMENT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"ENVIRONMENT"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.ENVIRONMENT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAMESPACE"> |
| <span class="sig-name descname"><span class="pre">NAMESPACE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAMESPACE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAME"> |
| <span class="sig-name descname"><span class="pre">NAME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"NAME"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.NAME" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SERVICE"> |
| <span class="sig-name descname"><span class="pre">SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"SERVICE"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SERVICE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.METHOD"> |
| <span class="sig-name descname"><span class="pre">METHOD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"METHOD"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.METHOD" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.RESOURCE"> |
| <span class="sig-name descname"><span class="pre">RESOURCE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"RESOURCE"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.RESOURCE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.STATUS"> |
| <span class="sig-name descname"><span class="pre">STATUS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"STATUS"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.STATUS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_PROJECT_ID"> |
| <span class="sig-name descname"><span class="pre">BIGQUERY_PROJECT_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"BIGQUERY_PROJECT_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_PROJECT_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_DATASET"> |
| <span class="sig-name descname"><span class="pre">BIGQUERY_DATASET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"BIGQUERY_DATASET"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_DATASET" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_TABLE"> |
| <span class="sig-name descname"><span class="pre">BIGQUERY_TABLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"BIGQUERY_TABLE"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_TABLE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_VIEW"> |
| <span class="sig-name descname"><span class="pre">BIGQUERY_VIEW</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"BIGQUERY_VIEW"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_VIEW" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_QUERY_NAME"> |
| <span class="sig-name descname"><span class="pre">BIGQUERY_QUERY_NAME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"BIGQUERY_QUERY_NAME"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGQUERY_QUERY_NAME" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.GCS_BUCKET"> |
| <span class="sig-name descname"><span class="pre">GCS_BUCKET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"GCS_BUCKET"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.GCS_BUCKET" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.GCS_PROJECT_ID"> |
| <span class="sig-name descname"><span class="pre">GCS_PROJECT_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"GCS_PROJECT_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.GCS_PROJECT_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.DATASTORE_PROJECT"> |
| <span class="sig-name descname"><span class="pre">DATASTORE_PROJECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"DATASTORE_PROJECT"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.DATASTORE_PROJECT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.DATASTORE_NAMESPACE"> |
| <span class="sig-name descname"><span class="pre">DATASTORE_NAMESPACE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"DATASTORE_NAMESPACE"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.DATASTORE_NAMESPACE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGTABLE_PROJECT_ID"> |
| <span class="sig-name descname"><span class="pre">BIGTABLE_PROJECT_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"BIGTABLE_PROJECT_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.BIGTABLE_PROJECT_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.INSTANCE_ID"> |
| <span class="sig-name descname"><span class="pre">INSTANCE_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"INSTANCE_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.INSTANCE_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.TABLE_ID"> |
| <span class="sig-name descname"><span class="pre">TABLE_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"TABLE_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.TABLE_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_PROJECT_ID"> |
| <span class="sig-name descname"><span class="pre">SPANNER_PROJECT_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"SPANNER_PROJECT_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_PROJECT_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_DATABASE_ID"> |
| <span class="sig-name descname"><span class="pre">SPANNER_DATABASE_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"SPANNER_DATABASE_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_DATABASE_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_TABLE_ID"> |
| <span class="sig-name descname"><span class="pre">SPANNER_TABLE_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"SPANNER_TABLE_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_TABLE_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_INSTANCE_ID"> |
| <span class="sig-name descname"><span class="pre">SPANNER_INSTANCE_ID</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"SPANNER_INSTANCE_ID"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_INSTANCE_ID" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_QUERY_NAME"> |
| <span class="sig-name descname"><span class="pre">SPANNER_QUERY_NAME</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"SPANNER_QUERY_NAME"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.SPANNER_QUERY_NAME" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.PER_WORKER_METRIC"> |
| <span class="sig-name descname"><span class="pre">PER_WORKER_METRIC</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">name:</span> <span class="pre">"PER_WORKER_METRIC"</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfo.MonitoringInfoLabels.PER_WORKER_METRIC" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.</span></span><span class="sig-name descname"><span class="pre">MonitoringInfoSpecs</span></span><a class="reference internal" href="_modules/apache_beam/portability/api/org/apache/beam/model/pipeline/v1/metrics_pb2_urns.html#MonitoringInfoSpecs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Enum</span></span><a class="reference internal" href="_modules/apache_beam/portability/api/org/apache/beam/model/pipeline/v1/metrics_pb2_urns.html#MonitoringInfoSpecs.Enum"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_INT64"> |
| <span class="sig-name descname"><span class="pre">USER_SUM_INT64</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:sum_int64:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_INT64" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_DOUBLE"> |
| <span class="sig-name descname"><span class="pre">USER_SUM_DOUBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:sum_double:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_double:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SUM_DOUBLE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_INT64"> |
| <span class="sig-name descname"><span class="pre">USER_DISTRIBUTION_INT64</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:distribution_int64:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:distribution_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_INT64" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_DOUBLE"> |
| <span class="sig-name descname"><span class="pre">USER_DISTRIBUTION_DOUBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:distribution_double:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:distribution_double:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_DISTRIBUTION_DOUBLE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_INT64"> |
| <span class="sig-name descname"><span class="pre">USER_LATEST_INT64</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:latest_int64:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:latest_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_INT64" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_DOUBLE"> |
| <span class="sig-name descname"><span class="pre">USER_LATEST_DOUBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:latest_double:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:latest_double:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_LATEST_DOUBLE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_INT64"> |
| <span class="sig-name descname"><span class="pre">USER_TOP_N_INT64</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:top_n_int64:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:top_n_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_INT64" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_DOUBLE"> |
| <span class="sig-name descname"><span class="pre">USER_TOP_N_DOUBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:top_n_double:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:top_n_double:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_TOP_N_DOUBLE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_INT64"> |
| <span class="sig-name descname"><span class="pre">USER_BOTTOM_N_INT64</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:bottom_n_int64:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:bottom_n_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_INT64" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_DOUBLE"> |
| <span class="sig-name descname"><span class="pre">USER_BOTTOM_N_DOUBLE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:bottom_n_double:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:bottom_n_double:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOTTOM_N_DOUBLE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SET_STRING"> |
| <span class="sig-name descname"><span class="pre">USER_SET_STRING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:set_string:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:set_string:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_SET_STRING" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOUNDED_TRIE"> |
| <span class="sig-name descname"><span class="pre">USER_BOUNDED_TRIE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:bounded_trie:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:bounded_trie:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">user</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_BOUNDED_TRIE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.ELEMENT_COUNT"> |
| <span class="sig-name descname"><span class="pre">ELEMENT_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:element_count:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PCOLLECTION"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">total</span> <span class="pre">elements</span> <span class="pre">output</span> <span class="pre">to</span> <span class="pre">a</span> <span class="pre">Pcollection</span> <span class="pre">by</span> <span class="pre">a</span> <span class="pre">PTransform."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.ELEMENT_COUNT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.SAMPLED_BYTE_SIZE"> |
| <span class="sig-name descname"><span class="pre">SAMPLED_BYTE_SIZE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:sampled_byte_size:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:distribution_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PCOLLECTION"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">total</span> <span class="pre">byte</span> <span class="pre">size</span> <span class="pre">and</span> <span class="pre">count</span> <span class="pre">of</span> <span class="pre">a</span> <span class="pre">sampled</span>  <span class="pre">set</span> <span class="pre">(or</span> <span class="pre">all)</span> <span class="pre">of</span> <span class="pre">elements</span> <span class="pre">in</span> <span class="pre">the</span> <span class="pre">pcollection.</span> <span class="pre">Sampling</span> <span class="pre">is</span> <span class="pre">used</span>  <span class="pre">because</span> <span class="pre">calculating</span> <span class="pre">the</span> <span class="pre">byte</span> <span class="pre">count</span> <span class="pre">involves</span> <span class="pre">serializing</span> <span class="pre">the</span>  <span class="pre">elements</span> <span class="pre">which</span> <span class="pre">is</span> <span class="pre">CPU</span> <span class="pre">intensive."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.SAMPLED_BYTE_SIZE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.START_BUNDLE_MSECS"> |
| <span class="sig-name descname"><span class="pre">START_BUNDLE_MSECS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:pardo_execution_time:start_bundle_msecs:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">total</span> <span class="pre">estimated</span> <span class="pre">execution</span> <span class="pre">time</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">start</span> <span class="pre">bundlefunction</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">pardo"</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.START_BUNDLE_MSECS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.PROCESS_BUNDLE_MSECS"> |
| <span class="sig-name descname"><span class="pre">PROCESS_BUNDLE_MSECS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:pardo_execution_time:process_bundle_msecs:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">total</span> <span class="pre">estimated</span> <span class="pre">execution</span> <span class="pre">time</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">process</span> <span class="pre">bundlefunction</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">pardo"</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.PROCESS_BUNDLE_MSECS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.FINISH_BUNDLE_MSECS"> |
| <span class="sig-name descname"><span class="pre">FINISH_BUNDLE_MSECS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:pardo_execution_time:finish_bundle_msecs:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">total</span> <span class="pre">estimated</span> <span class="pre">execution</span> <span class="pre">time</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">finish</span> <span class="pre">bundle</span> <span class="pre">function</span> <span class="pre">in</span> <span class="pre">a</span> <span class="pre">pardo"</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.FINISH_BUNDLE_MSECS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.TOTAL_MSECS"> |
| <span class="sig-name descname"><span class="pre">TOTAL_MSECS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:ptransform_execution_time:total_msecs:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">total</span> <span class="pre">estimated</span> <span class="pre">execution</span> <span class="pre">time</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">ptransform"</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.TOTAL_MSECS" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_REMAINING"> |
| <span class="sig-name descname"><span class="pre">WORK_REMAINING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:ptransform_progress:remaining:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:progress:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">remaining</span> <span class="pre">amount</span> <span class="pre">of</span> <span class="pre">work</span> <span class="pre">for</span> <span class="pre">each</span> <span class="pre">active</span> <span class="pre">element.</span> <span class="pre">Each</span> <span class="pre">active</span> <span class="pre">element</span> <span class="pre">represents</span> <span class="pre">an</span> <span class="pre">independent</span> <span class="pre">amount</span> <span class="pre">of</span> <span class="pre">work</span> <span class="pre">not</span> <span class="pre">shared</span> <span class="pre">with</span> <span class="pre">any</span> <span class="pre">other</span> <span class="pre">active</span> <span class="pre">element."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_REMAINING" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_COMPLETED"> |
| <span class="sig-name descname"><span class="pre">WORK_COMPLETED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:ptransform_progress:completed:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:progress:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">remaining</span> <span class="pre">amount</span> <span class="pre">of</span> <span class="pre">work</span> <span class="pre">for</span> <span class="pre">each</span> <span class="pre">active</span> <span class="pre">element.</span> <span class="pre">Each</span> <span class="pre">active</span> <span class="pre">element</span> <span class="pre">represents</span> <span class="pre">an</span> <span class="pre">independent</span> <span class="pre">amount</span> <span class="pre">of</span> <span class="pre">work</span> <span class="pre">not</span> <span class="pre">shared</span> <span class="pre">with</span> <span class="pre">any</span> <span class="pre">other</span> <span class="pre">active</span> <span class="pre">element."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.WORK_COMPLETED" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.DATA_CHANNEL_READ_INDEX"> |
| <span class="sig-name descname"><span class="pre">DATA_CHANNEL_READ_INDEX</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:data_channel:read_index:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"The</span> <span class="pre">read</span> <span class="pre">index</span> <span class="pre">of</span> <span class="pre">the</span> <span class="pre">data</span> <span class="pre">channel."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.DATA_CHANNEL_READ_INDEX" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_COUNT"> |
| <span class="sig-name descname"><span class="pre">API_REQUEST_COUNT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:io:api_request_count:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:sum_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"SERVICE"</span> <span class="pre">required_labels:</span> <span class="pre">"METHOD"</span> <span class="pre">required_labels:</span> <span class="pre">"RESOURCE"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"STATUS"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"Request</span> <span class="pre">counts</span> <span class="pre">with</span> <span class="pre">status</span> <span class="pre">made</span> <span class="pre">to</span> <span class="pre">IO</span> <span class="pre">service</span> <span class="pre">APIs</span> <span class="pre">to</span> <span class="pre">batch</span> <span class="pre">read</span> <span class="pre">or</span> <span class="pre">write</span> <span class="pre">elements."</span> <span class="pre">}</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"process_metric"</span>   <span class="pre">value:</span> <span class="pre">"true"</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_COUNT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_LATENCIES"> |
| <span class="sig-name descname"><span class="pre">API_REQUEST_LATENCIES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:io:api_request_latencies:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:histogram_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"SERVICE"</span> <span class="pre">required_labels:</span> <span class="pre">"METHOD"</span> <span class="pre">required_labels:</span> <span class="pre">"RESOURCE"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"Histogram</span> <span class="pre">counts</span> <span class="pre">for</span> <span class="pre">request</span> <span class="pre">latencies</span> <span class="pre">made</span> <span class="pre">to</span> <span class="pre">IO</span> <span class="pre">service</span> <span class="pre">APIs</span> <span class="pre">to</span> <span class="pre">batch</span> <span class="pre">read</span> <span class="pre">or</span> <span class="pre">write</span> <span class="pre">elements."</span> <span class="pre">}</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"units"</span>   <span class="pre">value:</span> <span class="pre">"Milliseconds"</span> <span class="pre">}</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"process_metric"</span>   <span class="pre">value:</span> <span class="pre">"true"</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.API_REQUEST_LATENCIES" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_HISTOGRAM"> |
| <span class="sig-name descname"><span class="pre">USER_HISTOGRAM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('',</span> <span class="pre">'',</span> <span class="pre">urn:</span> <span class="pre">"beam:metric:user:histogram_int64:v1"</span> <span class="pre">type:</span> <span class="pre">"beam:metrics:histogram_int64:v1"</span> <span class="pre">required_labels:</span> <span class="pre">"PTRANSFORM"</span> <span class="pre">required_labels:</span> <span class="pre">"NAMESPACE"</span> <span class="pre">required_labels:</span> <span class="pre">"NAME"</span> <span class="pre">annotations</span> <span class="pre">{</span>   <span class="pre">key:</span> <span class="pre">"description"</span>   <span class="pre">value:</span> <span class="pre">"URN</span> <span class="pre">utilized</span> <span class="pre">to</span> <span class="pre">report</span> <span class="pre">histogram</span> <span class="pre">metric."</span> <span class="pre">}</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoSpecs.Enum.USER_HISTOGRAM" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.</span></span><span class="sig-name descname"><span class="pre">MonitoringInfoTypeUrns</span></span><a class="reference internal" href="_modules/apache_beam/portability/api/org/apache/beam/model/pipeline/v1/metrics_pb2_urns.html#MonitoringInfoTypeUrns"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Enum</span></span><a class="reference internal" href="_modules/apache_beam/portability/api/org/apache/beam/model/pipeline/v1/metrics_pb2_urns.html#MonitoringInfoTypeUrns.Enum"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum" title="Link 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.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_INT64_TYPE"> |
| <span class="sig-name descname"><span class="pre">SUM_INT64_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:sum_int64:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_INT64_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_DOUBLE_TYPE"> |
| <span class="sig-name descname"><span class="pre">SUM_DOUBLE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:sum_double:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SUM_DOUBLE_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_INT64_TYPE"> |
| <span class="sig-name descname"><span class="pre">DISTRIBUTION_INT64_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:distribution_int64:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_INT64_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_DOUBLE_TYPE"> |
| <span class="sig-name descname"><span class="pre">DISTRIBUTION_DOUBLE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:distribution_double:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.DISTRIBUTION_DOUBLE_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_INT64_TYPE"> |
| <span class="sig-name descname"><span class="pre">LATEST_INT64_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:latest_int64:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_INT64_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_DOUBLE_TYPE"> |
| <span class="sig-name descname"><span class="pre">LATEST_DOUBLE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:latest_double:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.LATEST_DOUBLE_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_INT64_TYPE"> |
| <span class="sig-name descname"><span class="pre">TOP_N_INT64_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:top_n_int64:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_INT64_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_DOUBLE_TYPE"> |
| <span class="sig-name descname"><span class="pre">TOP_N_DOUBLE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:top_n_double:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.TOP_N_DOUBLE_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_INT64_TYPE"> |
| <span class="sig-name descname"><span class="pre">BOTTOM_N_INT64_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:bottom_n_int64:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_INT64_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_DOUBLE_TYPE"> |
| <span class="sig-name descname"><span class="pre">BOTTOM_N_DOUBLE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:bottom_n_double:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOTTOM_N_DOUBLE_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.PROGRESS_TYPE"> |
| <span class="sig-name descname"><span class="pre">PROGRESS_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:progress:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.PROGRESS_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SET_STRING_TYPE"> |
| <span class="sig-name descname"><span class="pre">SET_STRING_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:set_string:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.SET_STRING_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOUNDED_TRIE_TYPE"> |
| <span class="sig-name descname"><span class="pre">BOUNDED_TRIE_TYPE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:bounded_trie:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.BOUNDED_TRIE_TYPE" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.HISTOGRAM"> |
| <span class="sig-name descname"><span class="pre">HISTOGRAM</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('beam:metrics:histogram_int64:v1',</span> <span class="pre">'',</span> <span class="pre">,</span> <span class="pre">)</span></em><a class="headerlink" href="#apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_urns.MonitoringInfoTypeUrns.Enum.HISTOGRAM" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_grpc.html" class="btn btn-neutral float-left" title="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.metrics_pb2_grpc module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <a href="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.schema_pb2_grpc.html" class="btn btn-neutral float-right" title="apache_beam.portability.api.org.apache.beam.model.pipeline.v1.schema_pb2_grpc module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |