| |
| |
| <!DOCTYPE html> |
| <html class="writer-html5" lang="en" data-content_root="./"> |
| <head> |
| <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>apache_beam.transforms.external module — Apache Beam 2.67.0 documentation</title> |
| <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" /> |
| <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" /> |
| |
| |
| <script src="_static/jquery.js?v=5d32c60e"></script> |
| <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script> |
| <script src="_static/documentation_options.js?v=959b4fbe"></script> |
| <script src="_static/doctools.js?v=9a2dae69"></script> |
| <script src="_static/sphinx_highlight.js?v=dc90522c"></script> |
| <script src="_static/js/theme.js"></script> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.transforms.external_java module" href="apache_beam.transforms.external_java.html" /> |
| <link rel="prev" title="apache_beam.transforms.error_handling module" href="apache_beam.transforms.error_handling.html" /> |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| <div class="wy-grid-for-nav"> |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> |
| Apache Beam |
| </a> |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li> |
| <li class="toctree-l1"><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 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="apache_beam.transforms.html#subpackages">Subpackages</a></li> |
| <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.async_dofn.html">apache_beam.transforms.async_dofn module</a></li> |
| <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.enrichment.html">apache_beam.transforms.enrichment 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"><a class="reference internal" href="apache_beam.transforms.error_handling.html">apache_beam.transforms.error_handling module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.external module</a><ul> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.convert_to_typing_type"><code class="docutils literal notranslate"><span class="pre">convert_to_typing_type()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.iter_urns"><code class="docutils literal notranslate"><span class="pre">iter_urns()</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.PayloadBuilder"><code class="docutils literal notranslate"><span class="pre">PayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">SchemaBasedPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.ImplicitSchemaPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">ImplicitSchemaPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.NamedTupleBasedPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">NamedTupleBasedPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.SchemaTransformPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">SchemaTransformPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.ExplicitSchemaTransformPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">ExplicitSchemaTransformPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.JavaClassLookupPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">JavaClassLookupPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.SchemaTransformsConfig"><code class="docutils literal notranslate"><span class="pre">SchemaTransformsConfig</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.ManagedReplacement"><code class="docutils literal notranslate"><span class="pre">ManagedReplacement</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.SchemaAwareExternalTransform"><code class="docutils literal notranslate"><span class="pre">SchemaAwareExternalTransform</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.JavaExternalTransform"><code class="docutils literal notranslate"><span class="pre">JavaExternalTransform</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.AnnotationBasedPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">AnnotationBasedPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.DataclassBasedPayloadBuilder"><code class="docutils literal notranslate"><span class="pre">DataclassBasedPayloadBuilder</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.ExternalTransform"><code class="docutils literal notranslate"><span class="pre">ExternalTransform</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub"><code class="docutils literal notranslate"><span class="pre">ExpansionAndArtifactRetrievalStub</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.JavaJarExpansionService"><code class="docutils literal notranslate"><span class="pre">JavaJarExpansionService</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.BeamJarExpansionService"><code class="docutils literal notranslate"><span class="pre">BeamJarExpansionService</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.external.memoize"><code class="docutils literal notranslate"><span class="pre">memoize()</span></code></a></li> |
| </ul> |
| </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_transform_provider.html">apache_beam.transforms.external_transform_provider module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.fully_qualified_named_transform.html">apache_beam.transforms.fully_qualified_named_transform module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.managed.html">apache_beam.transforms.managed 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.resources.html">apache_beam.transforms.resources 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.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> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Apache Beam</a> |
| </nav> |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| <div role="navigation" aria-label="Page navigation"> |
| <ul class="wy-breadcrumbs"> |
| <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> |
| <li class="breadcrumb-item"><a href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="breadcrumb-item active">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"> |
| |
| <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="Link to this heading"></a></h1> |
| <p>Defines Transform whose expansion is implemented elsewhere.</p> |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.convert_to_typing_type"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">convert_to_typing_type</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">type_</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#convert_to_typing_type"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.convert_to_typing_type" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.iter_urns"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">iter_urns</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">coder</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">context</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#iter_urns"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.iter_urns" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.PayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">PayloadBuilder</span></span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#PayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.PayloadBuilder" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Abstract base class for building payloads to pass to ExternalTransform.</p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.PayloadBuilder.build"> |
| <span class="sig-name descname"><span class="pre">build</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.PayloadBuilder.build" title="Link to this definition"></a></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>ExternalConfigurationPayload</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.PayloadBuilder.payload"> |
| <span class="sig-name descname"><span class="pre">payload</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.PayloadBuilder.payload" title="Link to this definition"></a></dt> |
| <dd><p>The serialized ExternalConfigurationPayload</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>bytes</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaBasedPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">SchemaBasedPayloadBuilder</span></span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaBasedPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder" title="Link 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">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="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaBasedPayloadBuilder.build"> |
| <span class="sig-name descname"><span class="pre">build</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaBasedPayloadBuilder.build" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ImplicitSchemaPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">ImplicitSchemaPayloadBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ImplicitSchemaPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ImplicitSchemaPayloadBuilder" title="Link 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">SchemaBasedPayloadBuilder</span></code></a></p> |
| <p>Build a payload that generates a schema from the provided values.</p> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.NamedTupleBasedPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">NamedTupleBasedPayloadBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">tuple_instance</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#NamedTupleBasedPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.NamedTupleBasedPayloadBuilder" title="Link 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">SchemaBasedPayloadBuilder</span></code></a></p> |
| <p>Build a payload based on a NamedTuple schema.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>tuple_instance</strong> – an instance of a typing.NamedTuple</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">SchemaTransformPayloadBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identifier</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaTransformPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformPayloadBuilder" title="Link 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">PayloadBuilder</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformPayloadBuilder.identifier"> |
| <span class="sig-name descname"><span class="pre">identifier</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaTransformPayloadBuilder.identifier"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformPayloadBuilder.identifier" title="Link to this definition"></a></dt> |
| <dd><p>The URN referencing this SchemaTransform</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>str</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformPayloadBuilder.build"> |
| <span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaTransformPayloadBuilder.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformPayloadBuilder.build" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExplicitSchemaTransformPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">ExplicitSchemaTransformPayloadBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identifier</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">schema_proto</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExplicitSchemaTransformPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExplicitSchemaTransformPayloadBuilder" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="#apache_beam.transforms.external.SchemaTransformPayloadBuilder" title="apache_beam.transforms.external.SchemaTransformPayloadBuilder"><code class="xref py py-class docutils literal notranslate"><span class="pre">SchemaTransformPayloadBuilder</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExplicitSchemaTransformPayloadBuilder.build"> |
| <span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExplicitSchemaTransformPayloadBuilder.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExplicitSchemaTransformPayloadBuilder.build" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaClassLookupPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">JavaClassLookupPayloadBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">class_name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaClassLookupPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaClassLookupPayloadBuilder" title="Link 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">PayloadBuilder</span></code></a></p> |
| <p>Builds a payload for directly instantiating a Java transform using a |
| constructor and builder methods.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>class_name</strong> – fully qualified name of the transform class.</p> |
| </dd> |
| </dl> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaClassLookupPayloadBuilder.IGNORED_ARG_FORMAT"> |
| <span class="sig-name descname"><span class="pre">IGNORED_ARG_FORMAT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'ignore%d'</span></em><a class="headerlink" href="#apache_beam.transforms.external.JavaClassLookupPayloadBuilder.IGNORED_ARG_FORMAT" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaClassLookupPayloadBuilder.build"> |
| <span class="sig-name descname"><span class="pre">build</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaClassLookupPayloadBuilder.build"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaClassLookupPayloadBuilder.build" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaClassLookupPayloadBuilder.with_constructor"> |
| <span class="sig-name descname"><span class="pre">with_constructor</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaClassLookupPayloadBuilder.with_constructor"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaClassLookupPayloadBuilder.with_constructor" title="Link to this definition"></a></dt> |
| <dd><p>Specifies the Java constructor to use. |
| Arguments provided using args and kwargs will be applied to the Java |
| transform constructor in the specified order.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>args</strong> – parameter values of the constructor.</p></li> |
| <li><p><strong>kwargs</strong> – parameter names and values of the constructor.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaClassLookupPayloadBuilder.with_constructor_method"> |
| <span class="sig-name descname"><span class="pre">with_constructor_method</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaClassLookupPayloadBuilder.with_constructor_method"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaClassLookupPayloadBuilder.with_constructor_method" title="Link to this definition"></a></dt> |
| <dd><p>Specifies the Java constructor method to use. |
| Arguments provided using args and kwargs will be applied to the Java |
| transform constructor method in the specified order.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>method_name</strong> – name of the constructor method.</p></li> |
| <li><p><strong>args</strong> – parameter values of the constructor method.</p></li> |
| <li><p><strong>kwargs</strong> – parameter names and values of the constructor method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaClassLookupPayloadBuilder.add_builder_method"> |
| <span class="sig-name descname"><span class="pre">add_builder_method</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">method_name</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaClassLookupPayloadBuilder.add_builder_method"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaClassLookupPayloadBuilder.add_builder_method" title="Link to this definition"></a></dt> |
| <dd><p>Specifies a Java builder method to be invoked after instantiating the Java |
| transform class. Specified builder method will be applied in order. |
| Arguments provided using args and kwargs will be applied to the Java |
| transform builder method in the specified order.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>method_name</strong> – name of the builder method.</p></li> |
| <li><p><strong>args</strong> – parameter values of the builder method.</p></li> |
| <li><p><strong>kwargs</strong> – parameter names and values of the builder method.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformsConfig"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">SchemaTransformsConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identifier</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">configuration_schema</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">inputs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">outputs</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformsConfig" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p> |
| <p>Create new instance of SchemaTransformsConfig(identifier, configuration_schema, inputs, outputs, description)</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformsConfig.configuration_schema"> |
| <span class="sig-name descname"><span class="pre">configuration_schema</span></span><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformsConfig.configuration_schema" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 1</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformsConfig.description"> |
| <span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformsConfig.description" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 4</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformsConfig.identifier"> |
| <span class="sig-name descname"><span class="pre">identifier</span></span><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformsConfig.identifier" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 0</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformsConfig.inputs"> |
| <span class="sig-name descname"><span class="pre">inputs</span></span><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformsConfig.inputs" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 2</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaTransformsConfig.outputs"> |
| <span class="sig-name descname"><span class="pre">outputs</span></span><a class="headerlink" href="#apache_beam.transforms.external.SchemaTransformsConfig.outputs" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 3</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ManagedReplacement"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">ManagedReplacement</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">underlying_transform_identifier</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_compatibility_version</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.transforms.external.ManagedReplacement" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p> |
| <p>Create new instance of ManagedReplacement(underlying_transform_identifier, update_compatibility_version)</p> |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ManagedReplacement.underlying_transform_identifier"> |
| <span class="sig-name descname"><span class="pre">underlying_transform_identifier</span></span><a class="headerlink" href="#apache_beam.transforms.external.ManagedReplacement.underlying_transform_identifier" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 0</p> |
| </dd></dl> |
| |
| <dl class="py attribute"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ManagedReplacement.update_compatibility_version"> |
| <span class="sig-name descname"><span class="pre">update_compatibility_version</span></span><a class="headerlink" href="#apache_beam.transforms.external.ManagedReplacement.update_compatibility_version" title="Link to this definition"></a></dt> |
| <dd><p>Alias for field number 1</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaAwareExternalTransform"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">SchemaAwareExternalTransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">identifier</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rearrange_based_on_discovery</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">managed_replacement</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaAwareExternalTransform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaAwareExternalTransform" title="Link 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">PTransform</span></code></a></p> |
| <p>A proxy transform for SchemaTransforms implemented in external SDKs.</p> |
| <p>This allows Python pipelines to directly use existing SchemaTransforms |
| available to the expansion service without adding additional code in external |
| SDKs.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>identifier</strong> – unique identifier of the SchemaTransform.</p></li> |
| <li><p><strong>expansion_service</strong> – an expansion service to use. This should already be |
| available and the Schema-aware transforms to be used must already be |
| deployed.</p></li> |
| <li><p><strong>rearrange_based_on_discovery</strong> – if this flag is set, the input kwargs |
| will be rearranged to match the order of fields in the external |
| SchemaTransform configuration. A discovery call will be made to fetch |
| the configuration.</p></li> |
| <li><p><strong>classpath</strong> – (Optional) A list paths to additional jars to place on the |
| expansion service classpath.</p></li> |
| <li><p><strong>managed_replacement</strong> – (Optional) a ‘ManagedReplacement’ namedtuple that |
| defines information needed to replace the transform with an equivalent |
| managed transform during the expansion. If an |
| ‘updateCompatibilityBeamVersion’ pipeline option is provided, we will |
| only replace if the managed transform is update compatible with the |
| provided version.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Kwargs<span class="colon">:</span></dt> |
| <dd class="field-even"><p>field name to value mapping for configuring the schema transform. |
| keys map to the field names of the schema of the SchemaTransform |
| (in-order).</p> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaAwareExternalTransform.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcolls</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaAwareExternalTransform.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaAwareExternalTransform.expand" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaAwareExternalTransform.discover"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">discover</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaAwareExternalTransform.discover"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaAwareExternalTransform.discover" title="Link to this definition"></a></dt> |
| <dd><p>Discover all SchemaTransforms available to the given expansion service.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>a list of SchemaTransformsConfigs that represent the discovered |
| SchemaTransforms.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaAwareExternalTransform.discover_iter"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">discover_iter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_errors</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaAwareExternalTransform.discover_iter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaAwareExternalTransform.discover_iter" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.SchemaAwareExternalTransform.discover_config"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">discover_config</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#SchemaAwareExternalTransform.discover_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.SchemaAwareExternalTransform.discover_config" title="Link to this definition"></a></dt> |
| <dd><p>Discover one SchemaTransform by name in the given expansion service.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>one SchemaTransformsConfig that represents the discovered |
| SchemaTransform</p> |
| </dd> |
| <dt class="field-even">Raises<span class="colon">:</span></dt> |
| <dd class="field-even"><p>ValueError: if more than one SchemaTransform is discovered, or if none |
| are discovered</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaExternalTransform"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">JavaExternalTransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">class_name</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaExternalTransform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaExternalTransform" title="Link 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">PTransform</span></code></a></p> |
| <p>A proxy for Java-implemented external transforms.</p> |
| <p>One builds these transforms just as one would in Java, e.g.:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">transform</span> <span class="o">=</span> <span class="n">JavaExternalTransform</span><span class="p">(</span><span class="s1">'fully.qualified.ClassName'</span> |
| <span class="p">)(</span><span class="n">contructorArg</span><span class="p">,</span> <span class="o">...</span> <span class="p">)</span><span class="o">.</span><span class="n">builderMethod</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>or:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">JavaExternalTransform</span><span class="p">(</span><span class="s1">'fully.qualified.ClassName'</span><span class="p">)</span><span class="o">.</span><span class="n">staticConstructor</span><span class="p">(</span> |
| <span class="o">...</span><span class="p">)</span><span class="o">.</span><span class="n">builderMethod1</span><span class="p">(</span><span class="o">...</span><span class="p">)</span><span class="o">.</span><span class="n">builderMethod2</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>class_name</strong> – fully qualified name of the java class</p></li> |
| <li><p><strong>expansion_service</strong> – (Optional) an expansion service to use. If none is |
| provided, a default expansion service will be started.</p></li> |
| <li><p><strong>classpath</strong> – (Optional) A list paths to additional jars to place on the |
| expansion service classpath.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaExternalTransform.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pcolls</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaExternalTransform.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaExternalTransform.expand" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.AnnotationBasedPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">AnnotationBasedPayloadBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transform</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#AnnotationBasedPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.AnnotationBasedPayloadBuilder" title="Link 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">SchemaBasedPayloadBuilder</span></code></a></p> |
| <p>Build a payload based on an external transform’s type annotations.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>transform</strong> – a PTransform instance or class. type annotations will |
| be gathered from its __init__ method</p></li> |
| <li><p><strong>values</strong> – values to encode</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.DataclassBasedPayloadBuilder"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">DataclassBasedPayloadBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transform</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#DataclassBasedPayloadBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.DataclassBasedPayloadBuilder" title="Link 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">SchemaBasedPayloadBuilder</span></code></a></p> |
| <p>Build a payload based on an external transform that uses dataclasses.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>transform</strong> – a dataclass-decorated PTransform instance from which to |
| gather type annotations and values</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">ExternalTransform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">urn</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">payload</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform" title="Link 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">PTransform</span></code></a></p> |
| <p>External provides a cross-language transform via expansion services in |
| foreign SDKs.</p> |
| <p>Wrapper for an external transform with the given urn and payload.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>urn</strong> – the unique beam identifier for this transform</p></li> |
| <li><p><strong>payload</strong> – the payload, either as a byte string or a PayloadBuilder</p></li> |
| <li><p><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.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.with_output_types"> |
| <span class="sig-name descname"><span class="pre">with_output_types</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.with_output_types"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.with_output_types" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.replace_named_inputs"> |
| <span class="sig-name descname"><span class="pre">replace_named_inputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">named_inputs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.replace_named_inputs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.replace_named_inputs" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.replace_named_outputs"> |
| <span class="sig-name descname"><span class="pre">replace_named_outputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">named_outputs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.replace_named_outputs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.replace_named_outputs" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.default_label"> |
| <span class="sig-name descname"><span class="pre">default_label</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.default_label" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.get_local_namespace"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_local_namespace</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.get_local_namespace" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.outer_namespace"> |
| <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">outer_namespace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.outer_namespace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.outer_namespace" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.expand"> |
| <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pvalueish</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="apache_beam.pvalue.html#apache_beam.pvalue.PCollection" title="apache_beam.pvalue.PCollection"><span class="pre">PCollection</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="apache_beam.pvalue.html#apache_beam.pvalue.PCollection" title="apache_beam.pvalue.PCollection"><span class="pre">PCollection</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.expand" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.service"> |
| <em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">service</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExternalTransform.service"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.service" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExternalTransform.to_runner_api_transform"> |
| <span class="sig-name descname"><span class="pre">to_runner_api_transform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">context</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">full_label</span></span></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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExternalTransform.to_runner_api_transform" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">ExpansionAndArtifactRetrievalStub</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExpansionAndArtifactRetrievalStub"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.portability.api.org.apache.beam.model.job_management.v1.beam_expansion_api_pb2_grpc.html#apache_beam.portability.api.org.apache.beam.model.job_management.v1.beam_expansion_api_pb2_grpc.ExpansionServiceStub" title="apache_beam.portability.api.org.apache.beam.model.job_management.v1.beam_expansion_api_pb2_grpc.ExpansionServiceStub"><code class="xref py py-class docutils literal notranslate"><span class="pre">ExpansionServiceStub</span></code></a></p> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub.artifact_service"> |
| <span class="sig-name descname"><span class="pre">artifact_service</span></span><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"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub.artifact_service" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub.ready"> |
| <span class="sig-name descname"><span class="pre">ready</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout_sec</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#ExpansionAndArtifactRetrievalStub.ready"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.ExpansionAndArtifactRetrievalStub.ready" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaJarExpansionService"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">JavaJarExpansionService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">path_to_jar</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">append_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaJarExpansionService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaJarExpansionService" title="Link to this definition"></a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <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> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>path_to_jar</strong> – the path to a locally available executable jar file to be used |
| to start up the expansion service.</p></li> |
| <li><p><strong>extra_args</strong> – arguments to be provided when starting up the |
| expansion service using the jar file. These arguments will replace the |
| default arguments.</p></li> |
| <li><p><strong>classpath</strong> – Additional dependencies to be added to the classpath.</p></li> |
| <li><p><strong>append_args</strong> – arguments to be provided when starting up the |
| expansion service using the jar file. These arguments will be appended to |
| the default arguments.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| <dl class="py method"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.JavaJarExpansionService.is_existing_service"> |
| <span class="sig-name descname"><span class="pre">is_existing_service</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#JavaJarExpansionService.is_existing_service"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.JavaJarExpansionService.is_existing_service" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="py class"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.BeamJarExpansionService"> |
| <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">BeamJarExpansionService</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">gradle_target</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">gradle_appendix</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">classpath</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">append_args</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#BeamJarExpansionService"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.BeamJarExpansionService" title="Link 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">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> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>gradle_target</strong> – Beam Gradle target for building an executable jar which will |
| be used to start the expansion service.</p></li> |
| <li><p><strong>extra_args</strong> – arguments to be provided when starting up the |
| expansion service using the jar file. These arguments will replace the |
| default arguments.</p></li> |
| <li><p><strong>gradle_appendix</strong> – Gradle appendix of the artifact.</p></li> |
| <li><p><strong>classpath</strong> – Additional dependencies to be added to the classpath.</p></li> |
| <li><p><strong>append_args</strong> – arguments to be provided when starting up the |
| expansion service using the jar file. These arguments will be appended to |
| the default arguments.</p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="py function"> |
| <dt class="sig sig-object py" id="apache_beam.transforms.external.memoize"> |
| <span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.external.</span></span><span class="sig-name descname"><span class="pre">memoize</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">func</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/external.html#memoize"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.external.memoize" title="Link to this definition"></a></dt> |
| <dd></dd></dl> |
| |
| </section> |
| |
| |
| </div> |
| </div> |
| <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> |
| <a href="apache_beam.transforms.error_handling.html" class="btn btn-neutral float-left" title="apache_beam.transforms.error_handling module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> |
| <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" aria-hidden="true"></span></a> |
| </div> |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p>© Copyright %Y, Apache Beam.</p> |
| </div> |
| |
| Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a |
| <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> |
| provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| |
| </footer> |
| </div> |
| </div> |
| </section> |
| </div> |
| <script> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |
