| <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>runners | apache-beam</title><meta name="description" content="Documentation for apache-beam"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> |
| <div class="tsd-toolbar-contents container"> |
| <div class="table-cell" id="tsd-search" data-base=".."> |
| <div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> |
| <div class="field"> |
| <div id="tsd-toolbar-links"></div></div> |
| <ul class="results"> |
| <li class="state loading">Preparing search index...</li> |
| <li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">apache-beam</a></div> |
| <div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></svg></a></div></div></header> |
| <div class="container container-main"> |
| <div class="col-8 col-content"> |
| <div class="tsd-page-title"> |
| <ul class="tsd-breadcrumb"> |
| <li><a href="../modules.html">apache-beam</a></li> |
| <li><a href="runners.html">runners</a></li></ul> |
| <h1>Module runners</h1></div><aside class="tsd-sources"> |
| <ul> |
| <li>Defined in <a href="https://github.com/apache/beam/blob/4bca1d13/sdks/typescript/src/apache_beam/runners/index.ts#L19">src/apache_beam/runners/index.ts:19</a></li></ul></aside> |
| <section class="tsd-panel-group"> |
| <section class="tsd-panel tsd-typography"></section></section> |
| <section class="tsd-panel-group tsd-index-group"> |
| <section class="tsd-panel tsd-index-panel"> |
| <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"> |
| <h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><path d="M1.5 5.50969L8 11.6609L14.5 5.50969L12.5466 3.66086L8 7.96494L3.45341 3.66086L1.5 5.50969Z" fill="var(--color-text)"></path></svg> Index</h5></summary> |
| <div class="tsd-accordion-details"> |
| <section class="tsd-index-section"> |
| <h3 class="tsd-index-heading">References</h3> |
| <div class="tsd-index-list"><a href="runners.html#Runner" class="tsd-index-link tsd-kind-reference tsd-parent-kind-module"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF4D82" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-8388608-path"></rect><path d="M10.354 17V8.24H13.066C13.586 8.24 14.042 8.348 14.434 8.564C14.826 8.772 15.13 9.064 15.346 9.44C15.562 9.816 15.67 10.256 15.67 10.76C15.67 11.352 15.514 11.86 15.202 12.284C14.898 12.708 14.482 13 13.954 13.16L15.79 17H14.518L12.838 13.28H11.434V17H10.354ZM11.434 12.308H13.066C13.514 12.308 13.874 12.168 14.146 11.888C14.418 11.6 14.554 11.224 14.554 10.76C14.554 10.288 14.418 9.912 14.146 9.632C13.874 9.352 13.514 9.212 13.066 9.212H11.434V12.308Z" fill="var(--color-text)" id="icon-8388608-text"></path></svg><span>Runner</span></a> |
| <a href="runners.html#createRunner" class="tsd-index-link tsd-kind-reference tsd-parent-kind-module"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg><span>create<wbr/>Runner</span></a> |
| </div></section></div></details></section></section> |
| <section class="tsd-panel-group tsd-member-group"> |
| <h2>References</h2> |
| <section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="Runner" class="tsd-anchor"></a> |
| <h3 class="tsd-anchor-link"><span>Runner</span><a href="#Runner" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none" id="icon-anchor-a"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5" id="icon-anchor-b"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5" id="icon-anchor-c"></path></svg></a></h3>Re-exports <a href="../classes/runners_runner.Runner.html">Runner</a></section> |
| <section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"><a id="createRunner" class="tsd-anchor"></a> |
| <h3 class="tsd-anchor-link"><span>create<wbr/>Runner</span><a href="#createRunner" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>Re-exports <a href="../functions/runners_runner.createRunner.html">createRunner</a></section></section></div> |
| <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> |
| <div class="tsd-navigation settings"> |
| <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> |
| <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Settings</h3></summary> |
| <div class="tsd-accordion-details"> |
| <div class="tsd-filter-visibility"> |
| <h4 class="uppercase">Member Visibility</h4><form> |
| <ul id="tsd-filter-options"> |
| <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li> |
| <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li> |
| <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li> |
| <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div> |
| <div class="tsd-theme-toggle"> |
| <h4 class="uppercase">Theme</h4><select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div> |
| <nav class="tsd-navigation primary"> |
| <details class="tsd-index-accordion" open><summary class="tsd-accordion-summary"> |
| <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)"></path></svg> Modules</h3></summary> |
| <div class="tsd-accordion-details"> |
| <ul> |
| <li class="current"><a href="../modules.html">apache-<wbr/>beam</a> |
| <ul> |
| <li class="tsd-kind-module"><a href="coders_coders.html">coders/coders</a></li> |
| <li class="tsd-kind-module"><a href="coders_js_coders.html">coders/js_<wbr/>coders</a></li> |
| <li class="tsd-kind-module"><a href="coders_required_coders.html">coders/required_<wbr/>coders</a></li> |
| <li class="tsd-kind-module"><a href="coders_row_coder.html">coders/row_<wbr/>coder</a></li> |
| <li class="tsd-kind-module"><a href="coders_standard_coders.html">coders/standard_<wbr/>coders</a></li> |
| <li class="tsd-kind-module"><a href="index.html">index</a></li> |
| <li class="tsd-kind-module"><a href="io_avroio.html">io/avroio</a></li> |
| <li class="tsd-kind-module"><a href="io_avroio-1.html">io/avroio</a></li> |
| <li class="tsd-kind-module"><a href="io_bigqueryio.html">io/bigqueryio</a></li> |
| <li class="tsd-kind-module"><a href="io_bigqueryio-1.html">io/bigqueryio</a></li> |
| <li class="tsd-kind-module"><a href="io_kafka.html">io/kafka</a></li> |
| <li class="tsd-kind-module"><a href="io_kafka-1.html">io/kafka</a></li> |
| <li class="tsd-kind-module"><a href="io_parquetio.html">io/parquetio</a></li> |
| <li class="tsd-kind-module"><a href="io_parquetio-1.html">io/parquetio</a></li> |
| <li class="tsd-kind-module"><a href="io_pubsub.html">io/pubsub</a></li> |
| <li class="tsd-kind-module"><a href="io_pubsub-1.html">io/pubsub</a></li> |
| <li class="tsd-kind-module"><a href="io_pubsublite.html">io/pubsublite</a></li> |
| <li class="tsd-kind-module"><a href="io_pubsublite-1.html">io/pubsublite</a></li> |
| <li class="tsd-kind-module"><a href="io_schemaio.html">io/schemaio</a></li> |
| <li class="tsd-kind-module"><a href="io_schemaio-1.html">io/schemaio</a></li> |
| <li class="tsd-kind-module"><a href="io_textio.html">io/textio</a></li> |
| <li class="tsd-kind-module"><a href="io_textio-1.html">io/textio</a></li> |
| <li class="tsd-kind-module"><a href="options_pipeline_options.html">options/pipeline_<wbr/>options</a></li> |
| <li class="tsd-kind-module"><a href="pvalue.html">pvalue</a></li> |
| <li class="current selected tsd-kind-module"><a href="runners.html">runners</a></li> |
| <li class="selected tsd-kind-module"><a href="runners-1.html">runners</a></li> |
| <li class="tsd-kind-module"><a href="runners_dataflow.html">runners/dataflow</a></li> |
| <li class="tsd-kind-module"><a href="runners_dataflow-1.html">runners/dataflow</a></li> |
| <li class="tsd-kind-module"><a href="runners_direct_runner.html">runners/direct_<wbr/>runner</a></li> |
| <li class="tsd-kind-module"><a href="runners_direct_runner-1.html">runners/direct_<wbr/>runner</a></li> |
| <li class="tsd-kind-module"><a href="runners_flink.html">runners/flink</a></li> |
| <li class="tsd-kind-module"><a href="runners_flink-1.html">runners/flink</a></li> |
| <li class="tsd-kind-module"><a href="runners_portable_runner_runner.html">runners/portable_<wbr/>runner/runner</a></li> |
| <li class="tsd-kind-module"><a href="runners_portable_runner_runner-1.html">runners/portable_<wbr/>runner/runner</a></li> |
| <li class="tsd-kind-module"><a href="runners_runner.html">runners/runner</a></li> |
| <li class="tsd-kind-module"><a href="runners_runner-1.html">runners/runner</a></li> |
| <li class="tsd-kind-module"><a href="runners_universal.html">runners/universal</a></li> |
| <li class="tsd-kind-module"><a href="runners_universal-1.html">runners/universal</a></li> |
| <li class="tsd-kind-module"><a href="serialization.html">serialization</a></li> |
| <li class="tsd-kind-module"><a href="testing_assert.html">testing/assert</a></li> |
| <li class="tsd-kind-module"><a href="testing_assert-1.html">testing/assert</a></li> |
| <li class="tsd-kind-module"><a href="testing_multi_pipeline_runner.html">testing/multi_<wbr/>pipeline_<wbr/>runner</a></li> |
| <li class="tsd-kind-module"><a href="testing_multi_pipeline_runner-1.html">testing/multi_<wbr/>pipeline_<wbr/>runner</a></li> |
| <li class="tsd-kind-module"><a href="testing_proto_printing_runner.html">testing/proto_<wbr/>printing_<wbr/>runner</a></li> |
| <li class="tsd-kind-module"><a href="testing_proto_printing_runner-1.html">testing/proto_<wbr/>printing_<wbr/>runner</a></li> |
| <li class="tsd-kind-module"><a href="transforms.html">transforms</a></li> |
| <li class="tsd-kind-module"><a href="transforms-1.html">transforms</a></li> |
| <li class="tsd-kind-module"><a href="transforms_combiners.html">transforms/combiners</a></li> |
| <li class="tsd-kind-module"><a href="transforms_combiners-1.html">transforms/combiners</a></li> |
| <li class="tsd-kind-module"><a href="transforms_create.html">transforms/create</a></li> |
| <li class="tsd-kind-module"><a href="transforms_create-1.html">transforms/create</a></li> |
| <li class="tsd-kind-module"><a href="transforms_external.html">transforms/external</a></li> |
| <li class="tsd-kind-module"><a href="transforms_external-1.html">transforms/external</a></li> |
| <li class="tsd-kind-module"><a href="transforms_flatten.html">transforms/flatten</a> |
| <ul> |
| <li class="tsd-kind-namespace tsd-parent-kind-module"><a href="transforms_flatten.flatten.html">flatten</a></li></ul></li> |
| <li class="tsd-kind-module"><a href="transforms_flatten-1.html">transforms/flatten</a></li> |
| <li class="tsd-kind-module"><a href="transforms_group_and_combine.html">transforms/group_<wbr/>and_<wbr/>combine</a></li> |
| <li class="tsd-kind-module"><a href="transforms_group_and_combine-1.html">transforms/group_<wbr/>and_<wbr/>combine</a></li> |
| <li class="tsd-kind-module"><a href="transforms_internal.html">transforms/internal</a> |
| <ul> |
| <li class="tsd-kind-namespace tsd-parent-kind-module"><a href="transforms_internal.combinePerKey.html">combine<wbr/>Per<wbr/>Key</a></li> |
| <li class="tsd-kind-namespace tsd-parent-kind-module"><a href="transforms_internal.groupByKey.html">group<wbr/>By<wbr/>Key</a></li> |
| <li class="tsd-kind-namespace tsd-parent-kind-module"><a href="transforms_internal.impulse.html">impulse</a></li></ul></li> |
| <li class="tsd-kind-module"><a href="transforms_internal-1.html">transforms/internal</a></li> |
| <li class="tsd-kind-module"><a href="transforms_pardo.html">transforms/pardo</a> |
| <ul> |
| <li class="tsd-kind-namespace tsd-parent-kind-module"><a href="transforms_pardo.parDo.html">par<wbr/>Do</a></li></ul></li> |
| <li class="tsd-kind-module"><a href="transforms_pardo-1.html">transforms/pardo</a></li> |
| <li class="tsd-kind-module"><a href="transforms_python.html">transforms/python</a></li> |
| <li class="tsd-kind-module"><a href="transforms_python-1.html">transforms/python</a></li> |
| <li class="tsd-kind-module"><a href="transforms_sql.html">transforms/sql</a></li> |
| <li class="tsd-kind-module"><a href="transforms_sql-1.html">transforms/sql</a></li> |
| <li class="tsd-kind-module"><a href="transforms_transform.html">transforms/transform</a></li> |
| <li class="tsd-kind-module"><a href="transforms_transform-1.html">transforms/transform</a></li> |
| <li class="tsd-kind-module"><a href="transforms_utils.html">transforms/utils</a></li> |
| <li class="tsd-kind-module"><a href="transforms_utils-1.html">transforms/utils</a></li> |
| <li class="tsd-kind-module"><a href="transforms_window.html">transforms/window</a></li> |
| <li class="tsd-kind-module"><a href="transforms_window-1.html">transforms/window</a></li> |
| <li class="tsd-kind-module"><a href="transforms_windowings.html">transforms/windowings</a></li> |
| <li class="tsd-kind-module"><a href="transforms_windowings-1.html">transforms/windowings</a></li> |
| <li class="tsd-kind-module"><a href="utils_service.html">utils/service</a></li> |
| <li class="tsd-kind-module"><a href="values.html">values</a></li></ul></li></ul></div></details></nav> |
| <nav class="tsd-navigation secondary menu-sticky"> |
| <ul> |
| <li class="tsd-kind-reference tsd-parent-kind-module"><a href="runners.html#Runner" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>Runner</a></li> |
| <li class="tsd-kind-reference tsd-parent-kind-module"><a href="runners.html#createRunner" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-8388608-path"></use><use href="#icon-8388608-text"></use></svg>create<wbr/>Runner</a></li></ul></nav></div></div> |
| <div class="container tsd-generator"> |
| <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div> |
| <div class="overlay"></div><script src="../assets/main.js"></script></body></html> |
