| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>apache_beam.options.pipeline_options_validator module — Apache Beam documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| <script type="text/javascript" src="_static/language_data.js"></script> |
| <script async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></script> |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="genindex.html" /> |
| <link rel="search" title="Search" href="search.html" /> |
| <link rel="next" title="apache_beam.options.value_provider module" href="apache_beam.options.value_provider.html" /> |
| <link rel="prev" title="apache_beam.options.pipeline_options module" href="apache_beam.options.pipeline_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" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="toctree-l1 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"><a class="reference internal" href="apache_beam.options.pipeline_options.html">apache_beam.options.pipeline_options module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">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.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">Apache Beam</a> |
| |
| </nav> |
| |
| |
| <div class="wy-nav-content"> |
| |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li><a href="apache_beam.options.html">apache_beam.options package</a> »</li> |
| |
| <li>apache_beam.options.pipeline_options_validator module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.options.pipeline_options_validator.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-apache_beam.options.pipeline_options_validator"> |
| <span id="apache-beam-options-pipeline-options-validator-module"></span><h1>apache_beam.options.pipeline_options_validator module<a class="headerlink" href="#module-apache_beam.options.pipeline_options_validator" title="Permalink to this headline">¶</a></h1> |
| <p>Pipeline options validator.</p> |
| <p>For internal use only; no backwards-compatibility guarantees.</p> |
| <dl class="class"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator"> |
| <em class="property">class </em><code class="descclassname">apache_beam.options.pipeline_options_validator.</code><code class="descname">PipelineOptionsValidator</code><span class="sig-paren">(</span><em>options</em>, <em>runner</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p> |
| <p>Validates PipelineOptions.</p> |
| <p>Goes through a list of known PipelineOption subclassess and calls:</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">validate</span><span class="p">(</span><span class="n">validator</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>if one is implemented. Aggregates a list of validation errors from all and |
| returns an aggregated list.</p> |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.OPTIONS"> |
| <code class="descname">OPTIONS</code><em class="property"> = [<class 'apache_beam.options.pipeline_options.DebugOptions'>, <class 'apache_beam.options.pipeline_options.GoogleCloudOptions'>, <class 'apache_beam.options.pipeline_options.PortableOptions'>, <class 'apache_beam.options.pipeline_options.SetupOptions'>, <class 'apache_beam.options.pipeline_options.StandardOptions'>, <class 'apache_beam.options.pipeline_options.TestOptions'>, <class 'apache_beam.options.pipeline_options.TypeOptions'>, <class 'apache_beam.options.pipeline_options.WorkerOptions'>]</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.OPTIONS" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.REQUIRED_ENVIRONMENT_OPTIONS"> |
| <code class="descname">REQUIRED_ENVIRONMENT_OPTIONS</code><em class="property"> = {'DOCKER': [], 'EXTERNAL': ['external_service_address'], 'LOOPBACK': [], 'PROCESS': ['process_command']}</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.REQUIRED_ENVIRONMENT_OPTIONS" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.OPTIONAL_ENVIRONMENT_OPTIONS"> |
| <code class="descname">OPTIONAL_ENVIRONMENT_OPTIONS</code><em class="property"> = {'DOCKER': ['docker_container_image'], 'EXTERNAL': [], 'LOOPBACK': [], 'PROCESS': ['process_variables']}</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.OPTIONAL_ENVIRONMENT_OPTIONS" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_OPTION"> |
| <code class="descname">ERR_MISSING_OPTION</code><em class="property"> = 'Missing required option: %s.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_OPTION" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_GCS_PATH"> |
| <code class="descname">ERR_MISSING_GCS_PATH</code><em class="property"> = 'Missing GCS path option: %s.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_GCS_PATH" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_PATH"> |
| <code class="descname">ERR_INVALID_GCS_PATH</code><em class="property"> = 'Invalid GCS path (%s), given for the option: %s.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_PATH" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_BUCKET"> |
| <code class="descname">ERR_INVALID_GCS_BUCKET</code><em class="property"> = 'Invalid GCS bucket (%s), given for the option: %s. See https://developers.google.com/storage/docs/bucketnaming for more details.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_BUCKET" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_OBJECT"> |
| <code class="descname">ERR_INVALID_GCS_OBJECT</code><em class="property"> = 'Invalid GCS object (%s), given for the option: %s.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_GCS_OBJECT" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_JOB_NAME"> |
| <code class="descname">ERR_INVALID_JOB_NAME</code><em class="property"> = 'Invalid job_name (%s); the name must consist of only the characters [-a-z0-9], starting with a letter and ending with a letter or number'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_JOB_NAME" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_NUMBER"> |
| <code class="descname">ERR_INVALID_PROJECT_NUMBER</code><em class="property"> = 'Invalid Project ID (%s). Please make sure you specified the Project ID, not project number.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_NUMBER" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_ID"> |
| <code class="descname">ERR_INVALID_PROJECT_ID</code><em class="property"> = 'Invalid Project ID (%s). Please make sure you specified the Project ID, not project description.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_PROJECT_ID" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_NOT_POSITIVE"> |
| <code class="descname">ERR_INVALID_NOT_POSITIVE</code><em class="property"> = 'Invalid value (%s) for option: %s. Value needs to be positive.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_NOT_POSITIVE" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_TYPE"> |
| <code class="descname">ERR_INVALID_TEST_MATCHER_TYPE</code><em class="property"> = 'Invalid value (%s) for option: %s. Please extend your matcher object from hamcrest.core.base_matcher.BaseMatcher.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_TYPE" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_UNPICKLABLE"> |
| <code class="descname">ERR_INVALID_TEST_MATCHER_UNPICKLABLE</code><em class="property"> = 'Invalid value (%s) for option: %s. Please make sure the test matcher is unpicklable.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TEST_MATCHER_UNPICKLABLE" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TRANSFORM_NAME_MAPPING"> |
| <code class="descname">ERR_INVALID_TRANSFORM_NAME_MAPPING</code><em class="property"> = 'Invalid transform name mapping format. Please make sure the mapping is string key-value pairs. Invalid pair: (%s:%s)'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_TRANSFORM_NAME_MAPPING" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_ENVIRONMENT"> |
| <code class="descname">ERR_INVALID_ENVIRONMENT</code><em class="property"> = 'Option %s is not compatible with environment type %s.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_INVALID_ENVIRONMENT" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_ENVIRONMENT_CONFIG"> |
| <code class="descname">ERR_ENVIRONMENT_CONFIG</code><em class="property"> = 'Option environment_config is incompatible with option(s) %s.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_ENVIRONMENT_CONFIG" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION"> |
| <code class="descname">ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION</code><em class="property"> = 'Option %s is required for environment type %s.'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_MISSING_REQUIRED_ENVIRONMENT_OPTION" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_NUM_WORKERS_TOO_HIGH"> |
| <code class="descname">ERR_NUM_WORKERS_TOO_HIGH</code><em class="property"> = 'num_workers (%s) cannot exceed max_num_workers (%s)'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ERR_NUM_WORKERS_TOO_HIGH" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_URI"> |
| <code class="descname">GCS_URI</code><em class="property"> = '(?P<SCHEME>[^:]+)://(?P<BUCKET>[^/]+)(/(?P<OBJECT>.*))?'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_URI" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_BUCKET"> |
| <code class="descname">GCS_BUCKET</code><em class="property"> = '^[a-z0-9][-_a-z0-9.]+[a-z0-9]$'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_BUCKET" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_SCHEME"> |
| <code class="descname">GCS_SCHEME</code><em class="property"> = 'gs'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.GCS_SCHEME" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.JOB_PATTERN"> |
| <code class="descname">JOB_PATTERN</code><em class="property"> = '[a-z]([-a-z0-9]*[a-z0-9])?'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.JOB_PATTERN" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_ID_PATTERN"> |
| <code class="descname">PROJECT_ID_PATTERN</code><em class="property"> = '[a-z][-a-z0-9:.]+[a-z0-9]'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_ID_PATTERN" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_NUMBER_PATTERN"> |
| <code class="descname">PROJECT_NUMBER_PATTERN</code><em class="property"> = '[0-9]*'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.PROJECT_NUMBER_PATTERN" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ENDPOINT_PATTERN"> |
| <code class="descname">ENDPOINT_PATTERN</code><em class="property"> = 'https://[\\S]*googleapis\\.com[/]?'</em><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.ENDPOINT_PATTERN" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate"> |
| <code class="descname">validate</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Calls validate on subclassess and returns a list of errors.</p> |
| <p>validate will call validate method on subclasses, accumulate the returned |
| list of errors, and returns the aggregate list.</p> |
| <table class="docutils field-list" frame="void" rules="none"> |
| <col class="field-name" /> |
| <col class="field-body" /> |
| <tbody valign="top"> |
| <tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">Aggregate list of errors after all calling all possible validate methods.</td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_service_runner"> |
| <code class="descname">is_service_runner</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.is_service_runner"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_service_runner" title="Permalink to this definition">¶</a></dt> |
| <dd><p>True if pipeline will execute on the Google Cloud Dataflow service.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_full_string_match"> |
| <code class="descname">is_full_string_match</code><span class="sig-paren">(</span><em>pattern</em>, <em>string</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.is_full_string_match"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.is_full_string_match" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Returns True if the pattern matches the whole string.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_gcs_path"> |
| <code class="descname">validate_gcs_path</code><span class="sig-paren">(</span><em>view</em>, <em>arg_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_gcs_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_gcs_path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Validates a GCS path against gs://bucket/object URI format.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_cloud_options"> |
| <code class="descname">validate_cloud_options</code><span class="sig-paren">(</span><em>view</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_cloud_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_cloud_options" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Validates job_name and project arguments.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_sdk_container_image_options"> |
| <code class="descname">validate_sdk_container_image_options</code><span class="sig-paren">(</span><em>view</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_sdk_container_image_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_sdk_container_image_options" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_num_workers"> |
| <code class="descname">validate_num_workers</code><span class="sig-paren">(</span><em>view</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_num_workers"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_num_workers" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Validates that Dataflow worker number is valid.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_worker_region_zone"> |
| <code class="descname">validate_worker_region_zone</code><span class="sig-paren">(</span><em>view</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_worker_region_zone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_worker_region_zone" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Validates Dataflow worker region and zone arguments are consistent.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_optional_argument_positive"> |
| <code class="descname">validate_optional_argument_positive</code><span class="sig-paren">(</span><em>view</em>, <em>arg_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_optional_argument_positive"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_optional_argument_positive" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Validates that an optional argument (if set) has a positive value.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_test_matcher"> |
| <code class="descname">validate_test_matcher</code><span class="sig-paren">(</span><em>view</em>, <em>arg_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_test_matcher"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_test_matcher" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Validates that on_success_matcher argument if set.</p> |
| <p>Validates that on_success_matcher is unpicklable and is instance |
| of <cite>hamcrest.core.base_matcher.BaseMatcher</cite>.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_environment_options"> |
| <code class="descname">validate_environment_options</code><span class="sig-paren">(</span><em>view</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/options/pipeline_options_validator.html#PipelineOptionsValidator.validate_environment_options"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.options.pipeline_options_validator.PipelineOptionsValidator.validate_environment_options" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Validates portable environment options.</p> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.options.value_provider.html" class="btn btn-neutral float-right" title="apache_beam.options.value_provider module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.options.pipeline_options.html" class="btn btn-neutral float-left" title="apache_beam.options.pipeline_options module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |