pydoc/2.38.0/apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.html - beam-site - Git at Google



 <!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.dataproc_cluster_manager module &mdash; Apache Beam 2.38.0 documentation</title>


   <script type="text/javascript" src="_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
         <script type="text/javascript" src="_static/jquery.js"></script>
         <script type="text/javascript" src="_static/underscore.js"></script>
         <script type="text/javascript" src="_static/doctools.js"></script>
         <script type="text/javascript" src="_static/language_data.js"></script>
         <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>

     <script type="text/javascript" src="_static/js/theme.js"></script>


   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <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 package" href="apache_beam.runners.interactive.dataproc.html" />
 </head>

 <body class="wy-body-for-nav">


   <div class="wy-grid-for-nav">

     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >


             <a href="index.html" class="icon icon-home"> Apache Beam


           </a>


               <div class="version">
                 2.38.0
               </div>


 <div role="search">
   <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
     <input type="text" name="q" placeholder="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul 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.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.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>


         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">


       <nav class="wy-nav-top" aria-label="top navigation">

           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="index.html">Apache Beam</a>

       </nav>


       <div class="wy-nav-content">

         <div class="rst-content">


 <div role="navigation" aria-label="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="index.html">Docs</a> &raquo;</li>

           <li><a href="apache_beam.runners.html">apache_beam.runners package</a> &raquo;</li>

           <li><a href="apache_beam.runners.interactive.html">apache_beam.runners.interactive package</a> &raquo;</li>

           <li><a href="apache_beam.runners.interactive.dataproc.html">apache_beam.runners.interactive.dataproc package</a> &raquo;</li>

       <li>apache_beam.runners.interactive.dataproc.dataproc_cluster_manager module</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.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.dataproc_cluster_manager">
 <span id="apache-beam-runners-interactive-dataproc-dataproc-cluster-manager-module"></span><h1>apache_beam.runners.interactive.dataproc.dataproc_cluster_manager module<a class="headerlink" href="#module-apache_beam.runners.interactive.dataproc.dataproc_cluster_manager" title="Permalink to this headline">¶</a></h1>
 <dl class="class">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier">
 <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.</code><code class="descname">MasterURLIdentifier</code><span class="sig-paren">(</span><em>project_id: Union[str</em>, <em>NoneType] = None</em>, <em>region: Union[str</em>, <em>NoneType] = None</em>, <em>cluster_name: Union[str</em>, <em>NoneType] = None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#MasterURLIdentifier"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier" 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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier.project_id">
 <code class="descname">project_id</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier.project_id" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier.region">
 <code class="descname">region</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier.region" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="attribute">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier.cluster_name">
 <code class="descname">cluster_name</code><em class="property"> = None</em><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier.cluster_name" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager">
 <em class="property">class </em><code class="descclassname">apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.</code><code class="descname">DataprocClusterManager</code><span class="sig-paren">(</span><em>cluster_metadata: apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager" 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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>The DataprocClusterManager object simplifies the operations
 required for creating and deleting Dataproc clusters for use
 under Interactive Beam.</p>
 <p>Initializes the DataprocClusterManager with properties required
 to interface with the Dataproc ClusterControllerClient.</p>
 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.create_cluster">
 <code class="descname">create_cluster</code><span class="sig-paren">(</span><em>cluster: dict</em><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.create_cluster"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.create_cluster" title="Permalink to this definition">¶</a></dt>
 <dd><p>Attempts to create a cluster using attributes that were
 initialized with the DataprocClusterManager instance.</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"><strong>cluster</strong> – Dictionary representing Dataproc cluster. Read more about the
 schema for clusters here:
 <a class="reference external" href="https://cloud.google.com/python/docs/reference/dataproc/latest/google.cloud.dataproc_v1.types.Cluster">https://cloud.google.com/python/docs/reference/dataproc/latest/google.cloud.dataproc_v1.types.Cluster</a></td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.create_flink_cluster">
 <code class="descname">create_flink_cluster</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.create_flink_cluster"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.create_flink_cluster" title="Permalink to this definition">¶</a></dt>
 <dd><p>Calls _create_cluster with a configuration that enables FlinkRunner.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.cleanup">
 <code class="descname">cleanup</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.cleanup"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.cleanup" title="Permalink to this definition">¶</a></dt>
 <dd><p>Deletes the cluster that uses the attributes initialized
 with the DataprocClusterManager instance.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.describe">
 <code class="descname">describe</code><span class="sig-paren">(</span><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.describe"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.describe" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns a dictionary describing the cluster.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.get_cluster_details">
 <code class="descname">get_cluster_details</code><span class="sig-paren">(</span><em>cluster_metadata: apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier</em><span class="sig-paren">)</span> &#x2192; google.cloud.dataproc_v1.types.clusters.Cluster<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.get_cluster_details"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.get_cluster_details" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets the Dataproc_v1 Cluster object for the current cluster manager.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.wait_for_cluster_to_provision">
 <code class="descname">wait_for_cluster_to_provision</code><span class="sig-paren">(</span><em>cluster_metadata: apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier</em><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.wait_for_cluster_to_provision"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.wait_for_cluster_to_provision" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.get_staging_location">
 <code class="descname">get_staging_location</code><span class="sig-paren">(</span><em>cluster_metadata: apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier</em><span class="sig-paren">)</span> &#x2192; str<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.get_staging_location"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.get_staging_location" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets the staging bucket of an existing Dataproc cluster.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.parse_master_url_and_dashboard">
 <code class="descname">parse_master_url_and_dashboard</code><span class="sig-paren">(</span><em>cluster_metadata: apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier</em>, <em>line: str</em><span class="sig-paren">)</span> &#x2192; Tuple[str, str]<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.parse_master_url_and_dashboard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.parse_master_url_and_dashboard" title="Permalink to this definition">¶</a></dt>
 <dd><p>Parses the master_url and YARN application_id of the Flink process from
 an input line. The line containing both the master_url and application id
 is always formatted as such:
 {text} Found Web Interface {master_url} of application
 ‘{application_id}’.n</p>
 <p>Truncated example where ‘…’ represents additional text between segments:
 … google-dataproc-startup[000]: … activate-component-flink[0000]:
 …org.apache.flink.yarn.YarnClusterDescriptor… [] -
 Found Web Interface example-master-url:50000 of application
 ‘application_123456789000_0001’.</p>
 <p>Returns the flink_master_url and dashboard link as a tuple.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.get_master_url_and_dashboard">
 <code class="descname">get_master_url_and_dashboard</code><span class="sig-paren">(</span><em>cluster_metadata: apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.MasterURLIdentifier</em>, <em>staging_bucket</em><span class="sig-paren">)</span> &#x2192; Tuple[Optional[str], Optional[str]]<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.get_master_url_and_dashboard"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.get_master_url_and_dashboard" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the master_url of the current cluster.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.cleanup_staging_files">
 <code class="descname">cleanup_staging_files</code><span class="sig-paren">(</span><em>staging_directory: str</em><span class="sig-paren">)</span> &#x2192; None<a class="reference internal" href="_modules/apache_beam/runners/interactive/dataproc/dataproc_cluster_manager.html#DataprocClusterManager.cleanup_staging_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.runners.interactive.dataproc.dataproc_cluster_manager.DataprocClusterManager.cleanup_staging_files" 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.html" class="btn btn-neutral float-left" title="apache_beam.runners.interactive.dataproc package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

     </p>
   </div>
   Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>