| |
| |
| <!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.interactive.dataproc.types module — Apache Beam 2.47.0 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.runners.interactive.display package" href="apache_beam.runners.interactive.display.html" /> |
| <link rel="prev" title="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager module" href="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> Apache Beam |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 2.47.0 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul 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"><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"><a class="reference internal" href="apache_beam.runners.dask.html">apache_beam.runners.dask package</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.runners.dataflow.html">apache_beam.runners.dataflow package</a></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 current"><a class="reference internal" href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a><ul class="current"> |
| <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.runners.interactive.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="apache_beam.runners.interactive.html#submodules">Submodules</a></li> |
| </ul> |
| </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.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="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.interactive.html">apache_beam.runners.interactive package</a> »</li> |
| |
| <li><a href="apache_beam.runners.interactive.dataproc.html">apache_beam.runners.interactive.dataproc package</a> »</li> |
| |
| <li>apache_beam.runners.interactive.dataproc.types module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.runners.interactive.dataproc.types.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.interactive.dataproc.types"> |
| <span id="apache-beam-runners-interactive-dataproc-types-module"></span><h1>apache_beam.runners.interactive.dataproc.types module<a class="headerlink" href="#module-apache_beam.runners.interactive.dataproc.types" title="Permalink to this headline">¶</a></h1> |
| <dl class="class"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata"> |
| <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.dataproc.types.</code><code class="descname">ClusterMetadata</code><span class="sig-paren">(</span><em>project_id: Optional[str] = None</em>, <em>region: Optional[str] = 'us-central1'</em>, <em>cluster_name: Optional[str] = <factory></em>, <em>subnetwork: Optional[str] = None</em>, <em>num_workers: Optional[int] = None</em>, <em>machine_type: Optional[int] = None</em>, <em>master_url: Optional[str] = None</em>, <em>dashboard: Optional[str] = None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/types.html#ClusterMetadata"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Metadata of a provisioned worker cluster that executes Beam pipelines.</p> |
| <p>Apache Beam supports running Beam pipelines on different runners provisioned |
| in different setups based on the runner and pipeline options associated with |
| each pipeline. To provide similar portability features, Interactive Beam |
| automatically extracts such ClusterMetadata information from pipeline options |
| of a pipeline in the REPL context and provision suitable clusters to execute |
| the pipeline. The lifecyle of the clusters is managed by Interactive Beam |
| and the user doesn not need to interact with it.</p> |
| <p>It’s not recommended to build this ClusterMetadata from raw values nor use it |
| to interact with the cluster management logic directly.</p> |
| <p>Interactive Beam now supports:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">1.</span> <span class="n">Runner</span><span class="p">:</span> <span class="n">FlinkRunner</span><span class="p">;</span> <span class="n">Setup</span><span class="p">:</span> <span class="n">on</span> <span class="n">Google</span> <span class="n">Cloud</span> <span class="k">with</span> <span class="n">Flink</span> <span class="n">on</span> <span class="n">Dataproc</span><span class="o">.</span> |
| </pre></div> |
| </div> |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.project_id"> |
| <code class="descname">project_id</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.project_id" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.region"> |
| <code class="descname">region</code><em class="property"> = 'us-central1'</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.region" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.subnetwork"> |
| <code class="descname">subnetwork</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.subnetwork" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.num_workers"> |
| <code class="descname">num_workers</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.num_workers" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.machine_type"> |
| <code class="descname">machine_type</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.machine_type" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.master_url"> |
| <code class="descname">master_url</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.master_url" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.dashboard"> |
| <code class="descname">dashboard</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.dashboard" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.runners.interactive.dataproc.types.ClusterMetadata.reset_name"> |
| <code class="descname">reset_name</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/types.html#ClusterMetadata.reset_name"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.types.ClusterMetadata.reset_name" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.runners.interactive.display.html" class="btn btn-neutral float-right" title="apache_beam.runners.interactive.display package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager 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> |
