pydoc/2.27.0/apache_beam.transforms.external.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.transforms.external module &mdash; 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.transforms.external_java module" href="apache_beam.transforms.external_java.html" />
     <link rel="prev" title="apache_beam.transforms.environments module" href="apache_beam.transforms.environments.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"><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.tools.html">apache_beam.tools package</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combinefn_lifecycle_pipeline.html">apache_beam.transforms.combinefn_lifecycle_pipeline module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combiners.html">apache_beam.transforms.combiners module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.core.html">apache_beam.transforms.core module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.create_source.html">apache_beam.transforms.create_source module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.deduplicate.html">apache_beam.transforms.deduplicate module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.display.html">apache_beam.transforms.display module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.environments.html">apache_beam.transforms.environments module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.external module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_java.html">apache_beam.transforms.external_java module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_test_py3.html">apache_beam.transforms.external_test_py3 module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_test_py37.html">apache_beam.transforms.external_test_py37 module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.periodicsequence.html">apache_beam.transforms.periodicsequence module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.ptransform.html">apache_beam.transforms.ptransform module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sideinputs.html">apache_beam.transforms.sideinputs module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sql.html">apache_beam.transforms.sql module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.stats.html">apache_beam.transforms.stats module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.timeutil.html">apache_beam.transforms.timeutil module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.transforms_keyword_only_args_test_py3.html">apache_beam.transforms.transforms_keyword_only_args_test_py3 module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.trigger.html">apache_beam.transforms.trigger module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.userstate.html">apache_beam.transforms.userstate module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.util.html">apache_beam.transforms.util module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.window.html">apache_beam.transforms.window module</a></li>
 </ul>
 </li>
 </ul>
 </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> &raquo;</li>

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

       <li>apache_beam.transforms.external module</li>


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


             <a href="_sources/apache_beam.transforms.external.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.transforms.external">
 <span id="apache-beam-transforms-external-module"></span><h1>apache_beam.transforms.external module<a class="headerlink" href="#module-apache_beam.transforms.external" title="Permalink to this headline">¶</a></h1>
 <p>Defines Transform whose expansion is implemented elsewhere.</p>
 <p>No backward compatibility guarantees. Everything in this module is experimental.</p>
 <dl class="function">
 <dt id="apache_beam.transforms.external.iter_urns">
 <code class="descclassname">apache_beam.transforms.external.</code><code class="descname">iter_urns</code><span class="sig-paren">(</span><em>coder</em>, <em>context=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#iter_urns"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.iter_urns" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.PayloadBuilder">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">PayloadBuilder</code><a class="reference internal" href="_modules/apache_beam/transforms/external.html#PayloadBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.PayloadBuilder" 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.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Abstract base class for building payloads to pass to ExternalTransform.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.external.PayloadBuilder.build">
 <code class="descname">build</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#PayloadBuilder.build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.PayloadBuilder.build" title="Permalink to this definition">¶</a></dt>
 <dd><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">Returns:</th><td class="field-body">ExternalConfigurationPayload</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.external.PayloadBuilder.payload">
 <code class="descname">payload</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#PayloadBuilder.payload"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.PayloadBuilder.payload" title="Permalink to this definition">¶</a></dt>
 <dd><p>The serialized ExternalConfigurationPayload</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">Returns:</th><td class="field-body">bytes</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.SchemaBasedPayloadBuilder">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">SchemaBasedPayloadBuilder</code><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaBasedPayloadBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.external.PayloadBuilder" title="apache_beam.transforms.external.PayloadBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.PayloadBuilder</span></code></a></p>
 <p>Base class for building payloads based on a schema that provides
 type information for each configuration value to encode.</p>
 <dl class="method">
 <dt id="apache_beam.transforms.external.SchemaBasedPayloadBuilder.build">
 <code class="descname">build</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaBasedPayloadBuilder.build"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder.build" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.ImplicitSchemaPayloadBuilder">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">ImplicitSchemaPayloadBuilder</code><span class="sig-paren">(</span><em>values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ImplicitSchemaPayloadBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ImplicitSchemaPayloadBuilder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder" title="apache_beam.transforms.external.SchemaBasedPayloadBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.SchemaBasedPayloadBuilder</span></code></a></p>
 <p>Build a payload that generates a schema from the provided values.</p>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.NamedTupleBasedPayloadBuilder">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">NamedTupleBasedPayloadBuilder</code><span class="sig-paren">(</span><em>tuple_instance</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#NamedTupleBasedPayloadBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.NamedTupleBasedPayloadBuilder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder" title="apache_beam.transforms.external.SchemaBasedPayloadBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.SchemaBasedPayloadBuilder</span></code></a></p>
 <p>Build a payload based on a NamedTuple schema.</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>tuple_instance</strong> – an instance of a typing.NamedTuple</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.AnnotationBasedPayloadBuilder">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">AnnotationBasedPayloadBuilder</code><span class="sig-paren">(</span><em>transform</em>, <em>**values</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#AnnotationBasedPayloadBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.AnnotationBasedPayloadBuilder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder" title="apache_beam.transforms.external.SchemaBasedPayloadBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.SchemaBasedPayloadBuilder</span></code></a></p>
 <p>Build a payload based on an external transform’s type annotations.</p>
 <p>Supported in python 3 only.</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>transform</strong> – a PTransform instance or class. type annotations will
 be gathered from its __init__ method</li>
 <li><strong>values</strong> – values to encode</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.DataclassBasedPayloadBuilder">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">DataclassBasedPayloadBuilder</code><span class="sig-paren">(</span><em>transform</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#DataclassBasedPayloadBuilder"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.DataclassBasedPayloadBuilder" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder" title="apache_beam.transforms.external.SchemaBasedPayloadBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.SchemaBasedPayloadBuilder</span></code></a></p>
 <p>Build a payload based on an external transform that uses dataclasses.</p>
 <p>Supported in python 3 only.</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>transform</strong> – a dataclass-decorated PTransform instance from which to
 gather type annotations and values</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.ExternalTransform">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">ExternalTransform</code><span class="sig-paren">(</span><em>urn</em>, <em>payload</em>, <em>expansion_service=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p>
 <p>External provides a cross-language transform via expansion services in
 foreign SDKs.</p>
 <p>Experimental; no backwards compatibility guarantees.</p>
 <p>Wrapper for an external transform with the given urn and payload.</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>urn</strong> – the unique beam identifier for this transform</li>
 <li><strong>payload</strong> – the payload, either as a byte string or a PayloadBuilder</li>
 <li><strong>expansion_service</strong> – an expansion service implementing the beam
 ExpansionService protocol, either as an object with an Expand method
 or an address (as a str) to a grpc server that provides this method.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.transforms.external.ExternalTransform.default_label">
 <code class="descname">default_label</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.default_label"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.default_label" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="classmethod">
 <dt id="apache_beam.transforms.external.ExternalTransform.get_local_namespace">
 <em class="property">classmethod </em><code class="descname">get_local_namespace</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.get_local_namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.get_local_namespace" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="classmethod">
 <dt id="apache_beam.transforms.external.ExternalTransform.outer_namespace">
 <em class="property">classmethod </em><code class="descname">outer_namespace</code><span class="sig-paren">(</span><em>namespace</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.outer_namespace"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.outer_namespace" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.external.ExternalTransform.expand">
 <code class="descname">expand</code><span class="sig-paren">(</span><em>pvalueish</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.expand" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.transforms.external.ExternalTransform.to_runner_api_transform">
 <code class="descname">to_runner_api_transform</code><span class="sig-paren">(</span><em>context</em>, <em>full_label</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.to_runner_api_transform"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.to_runner_api_transform" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">ExpansionAndArtifactRetrievalStub</code><span class="sig-paren">(</span><em>channel</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExpansionAndArtifactRetrievalStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.portability.api.beam_expansion_api_pb2_grpc.html#apache_beam.portability.api.beam_expansion_api_pb2_grpc.ExpansionServiceStub" title="apache_beam.portability.api.beam_expansion_api_pb2_grpc.ExpansionServiceStub"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.portability.api.beam_expansion_api_pb2_grpc.ExpansionServiceStub</span></code></a></p>
 <dl class="method">
 <dt id="apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub.artifact_service">
 <code class="descname">artifact_service</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExpansionAndArtifactRetrievalStub.artifact_service"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub.artifact_service" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.JavaJarExpansionService">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">JavaJarExpansionService</code><span class="sig-paren">(</span><em>path_to_jar</em>, <em>extra_args=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaJarExpansionService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaJarExpansionService" 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.9)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>An expansion service based on an Java Jar file.</p>
 <p>This can be passed into an ExternalTransform as the expansion_service
 argument which will spawn a subprocess using this jar to expand the
 transform.</p>
 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.transforms.external.BeamJarExpansionService">
 <em class="property">class </em><code class="descclassname">apache_beam.transforms.external.</code><code class="descname">BeamJarExpansionService</code><span class="sig-paren">(</span><em>gradle_target</em>, <em>extra_args=None</em>, <em>gradle_appendix=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#BeamJarExpansionService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.BeamJarExpansionService" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.external.JavaJarExpansionService" title="apache_beam.transforms.external.JavaJarExpansionService"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.external.JavaJarExpansionService</span></code></a></p>
 <p>An expansion service based on an Beam Java Jar file.</p>
 <p>Attempts to use a locally-built copy of the jar based on the gradle target,
 if it exists, otherwise attempts to download and cache the released artifact
 corresponding to this version of Beam from the apache maven repository.</p>
 </dd></dl>

 <dl class="function">
 <dt id="apache_beam.transforms.external.memoize">
 <code class="descclassname">apache_beam.transforms.external.</code><code class="descname">memoize</code><span class="sig-paren">(</span><em>func</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#memoize"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.transforms.external.memoize" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="apache_beam.transforms.external_java.html" class="btn btn-neutral float-right" title="apache_beam.transforms.external_java module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.transforms.environments.html" class="btn btn-neutral float-left" title="apache_beam.transforms.environments module" 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>