pydoc/2.68.0/apache_beam.options.pipeline_options.html - beam-site - Git at Google



 <!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.options.pipeline_options module &mdash; Apache Beam 2.68.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=2388e03a"></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.options.pipeline_options_validator module" href="apache_beam.options.pipeline_options_validator.html" />
     <link rel="prev" title="apache_beam.options package" href="apache_beam.options.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 current"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.options.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.options.pipeline_options module</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions"><code class="docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.StandardOptions"><code class="docutils literal notranslate"><span class="pre">StandardOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.TypeOptions"><code class="docutils literal notranslate"><span class="pre">TypeOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.DirectOptions"><code class="docutils literal notranslate"><span class="pre">DirectOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.GoogleCloudOptions"><code class="docutils literal notranslate"><span class="pre">GoogleCloudOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.AzureOptions"><code class="docutils literal notranslate"><span class="pre">AzureOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.HadoopFileSystemOptions"><code class="docutils literal notranslate"><span class="pre">HadoopFileSystemOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.WorkerOptions"><code class="docutils literal notranslate"><span class="pre">WorkerOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.DebugOptions"><code class="docutils literal notranslate"><span class="pre">DebugOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.ProfilingOptions"><code class="docutils literal notranslate"><span class="pre">ProfilingOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.SetupOptions"><code class="docutils literal notranslate"><span class="pre">SetupOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.TestOptions"><code class="docutils literal notranslate"><span class="pre">TestOptions</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.options.pipeline_options.S3Options"><code class="docutils literal notranslate"><span class="pre">S3Options</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.options.pipeline_options_validator.html">apache_beam.options.pipeline_options_validator module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.options.value_provider.html">apache_beam.options.value_provider module</a></li>
 </ul>
 </li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>

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

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="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.options.html">apache_beam.options package</a></li>
       <li class="breadcrumb-item active">apache_beam.options.pipeline_options module</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/apache_beam.options.pipeline_options.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.options.pipeline_options">
 <span id="apache-beam-options-pipeline-options-module"></span><h1>apache_beam.options.pipeline_options module<a class="headerlink" href="#module-apache_beam.options.pipeline_options" title="Link to this heading"></a></h1>
 <p>Pipeline options obtained from command line parsing.</p>
 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.PipelineOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">PipelineOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#PipelineOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.PipelineOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.display.html#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a></p>
 <p>This class and subclasses are used as containers for command line options.</p>
 <p>These classes are wrappers over the standard argparse Python module
 (see <a class="reference external" href="https://docs.python.org/3/library/argparse.html">https://docs.python.org/3/library/argparse.html</a>).  To define one option
 or a group of options, create a subclass from PipelineOptions.</p>
 <p>Example Usage:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">class</span><span class="w"> </span><span class="nc">XyzOptions</span><span class="p">(</span><span class="n">PipelineOptions</span><span class="p">):</span>

   <span class="nd">@classmethod</span>
   <span class="k">def</span><span class="w"> </span><span class="nf">_add_argparse_args</span><span class="p">(</span><span class="bp">cls</span><span class="p">,</span> <span class="n">parser</span><span class="p">):</span>
     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--abc&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;start&#39;</span><span class="p">)</span>
     <span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">&#39;--xyz&#39;</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s1">&#39;end&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>The arguments for the add_argument() method are exactly the ones
 described in the argparse public documentation.</p>
 <p>Pipeline objects require an options object during initialization.
 This is obtained simply by initializing an options class as defined above.</p>
 <p>Example Usage:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">p</span> <span class="o">=</span> <span class="n">Pipeline</span><span class="p">(</span><span class="n">options</span><span class="o">=</span><span class="n">XyzOptions</span><span class="p">())</span>
 <span class="k">if</span> <span class="n">p</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">xyz</span> <span class="o">==</span> <span class="s1">&#39;end&#39;</span><span class="p">:</span>
   <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s1">&#39;Option xyz has an invalid value.&#39;</span><span class="p">)</span>
 </pre></div>
 </div>
 <p>Instances of PipelineOptions or any of its subclass have access to values
 defined by other PipelineOption subclasses (see get_all_options()), and
 can be converted to an instance of another PipelineOptions subclass
 (see view_as()). All views share the underlying data structure that stores
 option key-value pairs.</p>
 <p>By default the options classes will use command line arguments to initialize
 the options.</p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.PipelineOptions.from_dictionary">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dictionary</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#PipelineOptions.from_dictionary"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.PipelineOptions.from_dictionary" title="Link to this definition"></a></dt>
 <dd><p>Returns a PipelineOptions from a dictionary of arguments.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>options</strong> – Dictionary of argument value pairs.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>A PipelineOptions object representing the given arguments.</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.PipelineOptions.get_all_options">
 <span class="sig-name descname"><span class="pre">get_all_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">drop_default</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">add_extra_args_fn</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Callable" title="(in Python v3.13)"><span class="pre">Callable</span></a><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">_BeamArgumentParser</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retain_unknown_options</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> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Dict" title="(in Python v3.13)"><span class="pre">Dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.13)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#PipelineOptions.get_all_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.PipelineOptions.get_all_options" title="Link to this definition"></a></dt>
 <dd><p>Returns a dictionary of all defined arguments.</p>
 <p>Returns a dictionary of all defined arguments (arguments that are defined in
 any subclass of PipelineOptions) into a dictionary.</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>drop_default</strong> – If set to true, options that are equal to their default
 values, are not returned as part of the result dictionary.</p></li>
 <li><p><strong>add_extra_args_fn</strong> – Callback to populate additional arguments, can be used
 by runner to supply otherwise unknown args.</p></li>
 <li><p><strong>retain_unknown_options</strong> – If set to true, options not recognized by any
 known pipeline options class will still be included in the result. If
 set to false, they will be discarded.</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>Dictionary of all args and values.</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.PipelineOptions.to_runner_api">
 <span class="sig-name descname"><span class="pre">to_runner_api</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#PipelineOptions.to_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.PipelineOptions.to_runner_api" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.PipelineOptions.from_runner_api">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_runner_api</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">proto_options</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#PipelineOptions.from_runner_api"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.PipelineOptions.from_runner_api" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.PipelineOptions.display_data">
 <span class="sig-name descname"><span class="pre">display_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#PipelineOptions.display_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.PipelineOptions.display_data" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.PipelineOptions.view_as">
 <span class="sig-name descname"><span class="pre">view_as</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">cls</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Type" title="(in Python v3.13)"><span class="pre">Type</span></a><span class="p"><span class="pre">[</span></span><span class="pre">PipelineOptionsT</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">PipelineOptionsT</span></span></span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#PipelineOptions.view_as"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.PipelineOptions.view_as" title="Link to this definition"></a></dt>
 <dd><p>Returns a view of current object as provided PipelineOption subclass.</p>
 <p>Example Usage:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">options</span> <span class="o">=</span> <span class="n">PipelineOptions</span><span class="p">([</span><span class="s1">&#39;--runner&#39;</span><span class="p">,</span> <span class="s1">&#39;Direct&#39;</span><span class="p">,</span> <span class="s1">&#39;--streaming&#39;</span><span class="p">])</span>
 <span class="n">standard_options</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">view_as</span><span class="p">(</span><span class="n">StandardOptions</span><span class="p">)</span>
 <span class="k">if</span> <span class="n">standard_options</span><span class="o">.</span><span class="n">streaming</span><span class="p">:</span>
   <span class="c1"># ... start a streaming job ...</span>
 </pre></div>
 </div>
 <p>Note that options objects may have multiple views, and modifications
 of values in any view-object will apply to current object and other
 view-objects.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>cls</strong> – PipelineOptions class or any of its subclasses.</p>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>
 <dd class="field-even"><p>An instance of cls that is initialized using options contained in current
 object.</p>
 </dd>
 </dl>
 </dd></dl>

 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.StandardOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">StandardOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#StandardOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.StandardOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.StandardOptions.DEFAULT_RUNNER">
 <span class="sig-name descname"><span class="pre">DEFAULT_RUNNER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DirectRunner'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.StandardOptions.DEFAULT_RUNNER" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.StandardOptions.ALL_KNOWN_RUNNERS">
 <span class="sig-name descname"><span class="pre">ALL_KNOWN_RUNNERS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('apache_beam.runners.dataflow.dataflow_runner.DataflowRunner',</span> <span class="pre">'apache_beam.runners.direct.direct_runner.BundleBasedDirectRunner',</span> <span class="pre">'apache_beam.runners.direct.direct_runner.DirectRunner',</span> <span class="pre">'apache_beam.runners.direct.direct_runner.SwitchingDirectRunner',</span> <span class="pre">'apache_beam.runners.interactive.interactive_runner.InteractiveRunner',</span> <span class="pre">'apache_beam.runners.portability.flink_runner.FlinkRunner',</span> <span class="pre">'apache_beam.runners.portability.fn_api_runner.FnApiRunner',</span> <span class="pre">'apache_beam.runners.portability.portable_runner.PortableRunner',</span> <span class="pre">'apache_beam.runners.portability.prism_runner.PrismRunner',</span> <span class="pre">'apache_beam.runners.portability.spark_runner.SparkRunner',</span> <span class="pre">'apache_beam.runners.test.TestDirectRunner',</span> <span class="pre">'apache_beam.runners.test.TestDataflowRunner')</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.StandardOptions.ALL_KNOWN_RUNNERS" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.StandardOptions.LOCAL_RUNNERS">
 <span class="sig-name descname"><span class="pre">LOCAL_RUNNERS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">('BundleBasedDirectRunner',</span> <span class="pre">'DirectRunner',</span> <span class="pre">'SwitchingDirectRunner',</span> <span class="pre">'FnApiRunner',</span> <span class="pre">'PrismRunner',</span> <span class="pre">'TestDirectRunner')</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.StandardOptions.LOCAL_RUNNERS" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.StandardOptions.KNOWN_RUNNER_NAMES">
 <span class="sig-name descname"><span class="pre">KNOWN_RUNNER_NAMES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['DataflowRunner',</span> <span class="pre">'BundleBasedDirectRunner',</span> <span class="pre">'DirectRunner',</span> <span class="pre">'SwitchingDirectRunner',</span> <span class="pre">'InteractiveRunner',</span> <span class="pre">'FlinkRunner',</span> <span class="pre">'FnApiRunner',</span> <span class="pre">'PortableRunner',</span> <span class="pre">'PrismRunner',</span> <span class="pre">'SparkRunner',</span> <span class="pre">'TestDirectRunner',</span> <span class="pre">'TestDataflowRunner']</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.StandardOptions.KNOWN_RUNNER_NAMES" 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.options.pipeline_options.TypeOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">TypeOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#TypeOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.TypeOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.TypeOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">unused_validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#TypeOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.TypeOptions.validate" 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.options.pipeline_options.DirectOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">DirectOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#DirectOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.DirectOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>DirectRunner-specific execution options.</p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">GoogleCloudOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#GoogleCloudOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Google Cloud Dataflow service execution options.</p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions.BIGQUERY_API_SERVICE">
 <span class="sig-name descname"><span class="pre">BIGQUERY_API_SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bigquery.googleapis.com'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions.BIGQUERY_API_SERVICE" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions.COMPUTE_API_SERVICE">
 <span class="sig-name descname"><span class="pre">COMPUTE_API_SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'compute.googleapis.com'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions.COMPUTE_API_SERVICE" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions.STORAGE_API_SERVICE">
 <span class="sig-name descname"><span class="pre">STORAGE_API_SERVICE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'storage.googleapis.com'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions.STORAGE_API_SERVICE" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions.DATAFLOW_ENDPOINT">
 <span class="sig-name descname"><span class="pre">DATAFLOW_ENDPOINT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'https://dataflow.googleapis.com'</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions.DATAFLOW_ENDPOINT" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions.OAUTH_SCOPES">
 <span class="sig-name descname"><span class="pre">OAUTH_SCOPES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">['https://www.googleapis.com/auth/bigquery',</span> <span class="pre">'https://www.googleapis.com/auth/cloud-platform',</span> <span class="pre">'https://www.googleapis.com/auth/devstorage.full_control',</span> <span class="pre">'https://www.googleapis.com/auth/userinfo.email',</span> <span class="pre">'https://www.googleapis.com/auth/datastore',</span> <span class="pre">'https://www.googleapis.com/auth/spanner.admin',</span> <span class="pre">'https://www.googleapis.com/auth/spanner.data']</span></em><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions.OAUTH_SCOPES" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#GoogleCloudOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions.validate" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.GoogleCloudOptions.get_cloud_profiler_service_name">
 <span class="sig-name descname"><span class="pre">get_cloud_profiler_service_name</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#GoogleCloudOptions.get_cloud_profiler_service_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.GoogleCloudOptions.get_cloud_profiler_service_name" 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.options.pipeline_options.AzureOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">AzureOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#AzureOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.AzureOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Azure Blob Storage options.</p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.AzureOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#AzureOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.AzureOptions.validate" 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.options.pipeline_options.HadoopFileSystemOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">HadoopFileSystemOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#HadoopFileSystemOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.HadoopFileSystemOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p><code class="docutils literal notranslate"><span class="pre">HadoopFileSystem</span></code> connection options.</p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.HadoopFileSystemOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#HadoopFileSystemOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.HadoopFileSystemOptions.validate" 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.options.pipeline_options.WorkerOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">WorkerOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#WorkerOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.WorkerOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Worker pool configuration options.</p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.WorkerOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#WorkerOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.WorkerOptions.validate" 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.options.pipeline_options.DebugOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">DebugOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#DebugOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.DebugOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.DebugOptions.add_experiment">
 <span class="sig-name descname"><span class="pre">add_experiment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">experiment</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#DebugOptions.add_experiment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.DebugOptions.add_experiment" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.DebugOptions.lookup_experiment">
 <span class="sig-name descname"><span class="pre">lookup_experiment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</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/options/pipeline_options.html#DebugOptions.lookup_experiment"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.DebugOptions.lookup_experiment" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.DebugOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#DebugOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.DebugOptions.validate" 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.options.pipeline_options.ProfilingOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">ProfilingOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#ProfilingOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.ProfilingOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.SetupOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">SetupOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#SetupOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.SetupOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.SetupOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#SetupOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.SetupOptions.validate" 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.options.pipeline_options.TestOptions">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">TestOptions</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#TestOptions"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.TestOptions" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.options.pipeline_options.TestOptions.validate">
 <span class="sig-name descname"><span class="pre">validate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">validator</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options.html#TestOptions.validate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.TestOptions.validate" 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.options.pipeline_options.S3Options">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.options.pipeline_options.</span></span><span class="sig-name descname"><span class="pre">S3Options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">flags</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.13)"><span class="pre">Sequence</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </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/options/pipeline_options.html#S3Options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.options.pipeline_options.S3Options" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a></p>
 <p>Initialize an options class.</p>
 <p>The initializer will traverse all subclasses, add all their argparse
 arguments and then parse the command line specified by flags or by default
 the one obtained from sys.argv.</p>
 <p>The subclasses of PipelineOptions do not need to redefine __init__.</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>flags</strong> – An iterable of command line arguments to be used. If not specified
 then sys.argv will be used as input for parsing arguments.</p></li>
 <li><p><strong>**kwargs</strong> – Add overrides for arguments passed in flags. For overrides
 of arguments, please pass the <cite>option names</cite> instead of
 flag names.
 Option names: These are defined as dest in the
 parser.add_argument() for each flag. Passing flags
 like {no_use_public_ips: True}, for which the dest is
 defined to a different flag name in the parser,
 would be discarded. Instead, pass the dest of
 the flag (dest of no_use_public_ips is use_public_ips).</p></li>
 </ul>
 </dd>
 </dl>
 </dd></dl>

 </section>


            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="apache_beam.options.html" class="btn btn-neutral float-left" title="apache_beam.options package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="apache_beam.options.pipeline_options_validator.html" class="btn btn-neutral float-right" title="apache_beam.options.pipeline_options_validator module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>

   <hr/>

   <div role="contentinfo">
     <p>&#169; 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>