| |
| |
| <!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.runners.dataflow.dataflow_runner module — Apache Beam documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.runners.dataflow.ptransform_overrides module" href="apache_beam.runners.dataflow.ptransform_overrides.html" /> |
| <link rel="prev" title="apache_beam.runners.dataflow.dataflow_metrics module" href="apache_beam.runners.dataflow.dataflow_metrics.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> Apache Beam |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.internal.html">apache_beam.internal 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 current"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.runners.html#subpackages">Subpackages</a><ul class="current"> |
| <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.dataflow.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.dataflow.html#submodules">Submodules</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.direct.html">apache_beam.runners.direct package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.internal.html">apache_beam.runners.internal package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.job.html">apache_beam.runners.job package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.runners.html#submodules">Submodules</a></li> |
| </ul> |
| </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.tools.html">apache_beam.tools 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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version 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> »</li> |
| |
| <li><a href="apache_beam.runners.html">apache_beam.runners package</a> »</li> |
| |
| <li><a href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a> »</li> |
| |
| <li>apache_beam.runners.dataflow.dataflow_runner module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.dataflow.dataflow_runner.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-apache_beam.runners.dataflow.dataflow_runner"> |
| <span id="apache-beam-runners-dataflow-dataflow-runner-module"></span><h1>apache_beam.runners.dataflow.dataflow_runner module<a class="headerlink" href="#module-apache_beam.runners.dataflow.dataflow_runner" title="Permalink to this headline">¶</a></h1> |
| <p>A runner implementation that submits a job for remote execution.</p> |
| <p>The runner will create a JSON description of the job graph and then submit it |
| to the Dataflow Service for remote execution by a worker.</p> |
| <dl class="class"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.dataflow.dataflow_runner.</code><code class="descname">DataflowRunner</code><span class="sig-paren">(</span><em>cache=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.runners.runner.html#apache_beam.runners.runner.PipelineRunner" title="apache_beam.runners.runner.PipelineRunner"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.runners.runner.PipelineRunner</span></code></a></p> |
| <p>A runner that creates job graphs and submits them for remote execution.</p> |
| <p>Every execution of the run() method will submit an independent job for |
| remote execution that consists of the nodes reachable from the passed in |
| node argument or entire graph if node is None. The run() method returns |
| after the service created the job and will not wait for the job to finish |
| if blocking is set to False.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.is_fnapi_compatible"> |
| <code class="descname">is_fnapi_compatible</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.is_fnapi_compatible"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.is_fnapi_compatible" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.apply"> |
| <code class="descname">apply</code><span class="sig-paren">(</span><em>transform</em>, <em>input</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.apply"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.apply" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.poll_for_job_completion"> |
| <em class="property">static </em><code class="descname">poll_for_job_completion</code><span class="sig-paren">(</span><em>runner</em>, <em>result</em>, <em>duration</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.poll_for_job_completion"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.poll_for_job_completion" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Polls for the specified job to finish running (successfully or not).</p> |
| <p>Updates the result with the new job information before returning.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple"> |
| <li><strong>runner</strong> – DataflowRunner instance to use for polling job state.</li> |
| <li><strong>result</strong> – DataflowPipelineResult instance used for job information.</li> |
| <li><strong>duration</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.8)"><em>int</em></a>) – The time to wait (in milliseconds) for job to finish. |
| If it is set to <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.8)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a>, it will wait indefinitely until the job |
| is finished.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.group_by_key_input_visitor"> |
| <em class="property">static </em><code class="descname">group_by_key_input_visitor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.group_by_key_input_visitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.group_by_key_input_visitor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.side_input_visitor"> |
| <em class="property">static </em><code class="descname">side_input_visitor</code><span class="sig-paren">(</span><em>use_unified_worker=False</em>, <em>use_fn_api=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.side_input_visitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.side_input_visitor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.flatten_input_visitor"> |
| <em class="property">static </em><code class="descname">flatten_input_visitor</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.flatten_input_visitor"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.flatten_input_visitor" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_pipeline"> |
| <code class="descname">run_pipeline</code><span class="sig-paren">(</span><em>pipeline</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_pipeline"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_pipeline" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Remotely executes entire pipeline or parts reachable from node.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_Impulse"> |
| <code class="descname">run_Impulse</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_Impulse"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_Impulse" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_Flatten"> |
| <code class="descname">run_Flatten</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_Flatten"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_Flatten" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.apply_GroupByKey"> |
| <code class="descname">apply_GroupByKey</code><span class="sig-paren">(</span><em>transform</em>, <em>pcoll</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.apply_GroupByKey"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.apply_GroupByKey" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_GroupByKey"> |
| <code class="descname">run_GroupByKey</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_GroupByKey"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_GroupByKey" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_RunnerAPIPTransformHolder"> |
| <code class="descname">run_RunnerAPIPTransformHolder</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_RunnerAPIPTransformHolder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_RunnerAPIPTransformHolder" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Adding Dataflow runner job description for transform holder objects.</p> |
| <p>These holder transform objects are generated for some of the transforms that |
| become available after a cross-language transform expansion, usually if the |
| corresponding transform object cannot be generated in Python SDK (for |
| example, a python <cite>ParDo</cite> transform cannot be generated without a serialized |
| Python <cite>DoFn</cite> object).</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_ParDo"> |
| <code class="descname">run_ParDo</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_ParDo"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_ParDo" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_CombineValuesReplacement"> |
| <code class="descname">run_CombineValuesReplacement</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_CombineValuesReplacement"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_CombineValuesReplacement" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_Read"> |
| <code class="descname">run_Read</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_Read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_Read" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run__NativeWrite"> |
| <code class="descname">run__NativeWrite</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run__NativeWrite"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run__NativeWrite" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_TestStream"> |
| <code class="descname">run_TestStream</code><span class="sig-paren">(</span><em>transform_node</em>, <em>options</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.run_TestStream"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.run_TestStream" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.serialize_windowing_strategy"> |
| <em class="property">classmethod </em><code class="descname">serialize_windowing_strategy</code><span class="sig-paren">(</span><em>windowing</em>, <em>default_environment</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.serialize_windowing_strategy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.serialize_windowing_strategy" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="classmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.deserialize_windowing_strategy"> |
| <em class="property">classmethod </em><code class="descname">deserialize_windowing_strategy</code><span class="sig-paren">(</span><em>serialized_data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.deserialize_windowing_strategy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.deserialize_windowing_strategy" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.byte_array_to_json_string"> |
| <em class="property">static </em><code class="descname">byte_array_to_json_string</code><span class="sig-paren">(</span><em>raw_bytes</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.byte_array_to_json_string"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.byte_array_to_json_string" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Implements org.apache.beam.sdk.util.StringUtils.byteArrayToJsonString.</p> |
| </dd></dl> |
| |
| <dl class="staticmethod"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.json_string_to_byte_array"> |
| <em class="property">static </em><code class="descname">json_string_to_byte_array</code><span class="sig-paren">(</span><em>encoded_string</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.json_string_to_byte_array"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.json_string_to_byte_array" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Implements org.apache.beam.sdk.util.StringUtils.jsonStringToByteArray.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.get_default_gcp_region"> |
| <code class="descname">get_default_gcp_region</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/dataflow/dataflow_runner.html#DataflowRunner.get_default_gcp_region"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.get_default_gcp_region" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Get a default value for Google Cloud region according to |
| <a class="reference external" href="https://cloud.google.com/compute/docs/gcloud-compute/#default-properties">https://cloud.google.com/compute/docs/gcloud-compute/#default-properties</a>. |
| If no default can be found, returns None.</p> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CombineValuesPTransformOverride"> |
| <em class="property">class </em><code class="descname">CombineValuesPTransformOverride</code><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CombineValuesPTransformOverride" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.pipeline.html#apache_beam.pipeline.PTransformOverride" title="apache_beam.pipeline.PTransformOverride"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.pipeline.PTransformOverride</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransformOverride</span></code> for <code class="docutils literal notranslate"><span class="pre">CombineValues</span></code>.</p> |
| <p>The DataflowRunner expects that the CombineValues PTransform acts as a |
| primitive. So this override replaces the CombineValues with a primitive.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CombineValuesPTransformOverride.get_replacement_transform"> |
| <code class="descname">get_replacement_transform</code><span class="sig-paren">(</span><em>ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CombineValuesPTransformOverride.get_replacement_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CombineValuesPTransformOverride.matches"> |
| <code class="descname">matches</code><span class="sig-paren">(</span><em>applied_ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CombineValuesPTransformOverride.matches" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CreatePTransformOverride"> |
| <em class="property">class </em><code class="descname">CreatePTransformOverride</code><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CreatePTransformOverride" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.pipeline.html#apache_beam.pipeline.PTransformOverride" title="apache_beam.pipeline.PTransformOverride"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.pipeline.PTransformOverride</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransformOverride</span></code> for <code class="docutils literal notranslate"><span class="pre">Create</span></code> in streaming mode.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CreatePTransformOverride.get_replacement_transform"> |
| <code class="descname">get_replacement_transform</code><span class="sig-paren">(</span><em>ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CreatePTransformOverride.get_replacement_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CreatePTransformOverride.matches"> |
| <code class="descname">matches</code><span class="sig-paren">(</span><em>applied_ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.CreatePTransformOverride.matches" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.JrhReadPTransformOverride"> |
| <em class="property">class </em><code class="descname">JrhReadPTransformOverride</code><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.JrhReadPTransformOverride" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.pipeline.html#apache_beam.pipeline.PTransformOverride" title="apache_beam.pipeline.PTransformOverride"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.pipeline.PTransformOverride</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransformOverride</span></code> for <code class="docutils literal notranslate"><span class="pre">Read(BoundedSource)</span></code></p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.JrhReadPTransformOverride.get_replacement_transform"> |
| <code class="descname">get_replacement_transform</code><span class="sig-paren">(</span><em>ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.JrhReadPTransformOverride.get_replacement_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.JrhReadPTransformOverride.matches"> |
| <code class="descname">matches</code><span class="sig-paren">(</span><em>applied_ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.JrhReadPTransformOverride.matches" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride"> |
| <em class="property">class </em><code class="descname">NativeReadPTransformOverride</code><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.pipeline.html#apache_beam.pipeline.PTransformOverride" title="apache_beam.pipeline.PTransformOverride"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.pipeline.PTransformOverride</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransformOverride</span></code> for <code class="docutils literal notranslate"><span class="pre">Read</span></code> using native sources.</p> |
| <p>The DataflowRunner expects that the Read PTransform using native sources act |
| as a primitive. So this override replaces the Read with a primitive.</p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.get_replacement_transform"> |
| <code class="descname">get_replacement_transform</code><span class="sig-paren">(</span><em>ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.get_replacement_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.matches"> |
| <code class="descname">matches</code><span class="sig-paren">(</span><em>applied_ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.NativeReadPTransformOverride.matches" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.ReadPTransformOverride"> |
| <em class="property">class </em><code class="descname">ReadPTransformOverride</code><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.ReadPTransformOverride" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.pipeline.html#apache_beam.pipeline.PTransformOverride" title="apache_beam.pipeline.PTransformOverride"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.pipeline.PTransformOverride</span></code></a></p> |
| <p>A <code class="docutils literal notranslate"><span class="pre">PTransformOverride</span></code> for <code class="docutils literal notranslate"><span class="pre">Read(BoundedSource)</span></code></p> |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.ReadPTransformOverride.get_replacement_transform"> |
| <code class="descname">get_replacement_transform</code><span class="sig-paren">(</span><em>ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.ReadPTransformOverride.get_replacement_transform" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.ReadPTransformOverride.matches"> |
| <code class="descname">matches</code><span class="sig-paren">(</span><em>applied_ptransform</em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.runners.dataflow.dataflow_runner.DataflowRunner.ReadPTransformOverride.matches" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.dataflow.ptransform_overrides.html" class="btn btn-neutral float-right" title="apache_beam.runners.dataflow.ptransform_overrides module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.dataflow.dataflow_metrics.html" class="btn btn-neutral float-left" title="apache_beam.runners.dataflow.dataflow_metrics module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © 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> |