| |
| |
| |
| |
| |
| <!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>airflow.contrib.operators.gcp_cloud_build_operator — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../search.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '13']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo --> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </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"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.5 |
| </div> |
| |
| |
| |
| |
| <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> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & Triggers</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">Python API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</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">Airflow</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="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../operators.html">airflow.contrib.operators</a> »</li> |
| |
| <li>airflow.contrib.operators.gcp_cloud_build_operator</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.contrib.operators.gcp_cloud_build_operator</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); you may not use this file except in compliance</span> |
| <span class="c1"># with the License. You may obtain a copy of the License at</span> |
| <span class="c1">#</span> |
| <span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="c1">#</span> |
| <span class="c1"># Unless required by applicable law or agreed to in writing,</span> |
| <span class="c1"># software distributed under the License is distributed on an</span> |
| <span class="c1"># "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span> |
| <span class="c1"># KIND, either express or implied. See the License for the</span> |
| <span class="c1"># specific language governing permissions and limitations</span> |
| <span class="c1"># under the License.</span> |
| <span class="sd">"""Operators that integrat with Google Cloud Build service."""</span> |
| <span class="kn">from</span> <span class="nn">copy</span> <span class="k">import</span> <span class="n">deepcopy</span> |
| <span class="kn">import</span> <span class="nn">re</span> |
| <span class="kn">from</span> <span class="nn">urllib.parse</span> <span class="k">import</span> <span class="n">urlparse</span><span class="p">,</span> <span class="n">unquote</span> |
| |
| <span class="kn">import</span> <span class="nn">six</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_cloud_build_hook</span> <span class="k">import</span> <span class="n">CloudBuildHook</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> |
| |
| <div class="viewcode-block" id="REGEX_REPO_PATH"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.REGEX_REPO_PATH">[docs]</a><span class="n">REGEX_REPO_PATH</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s2">"^/p/(?P<project_id>[^/]+)/r/(?P<repo_name>[^/]+)"</span><span class="p">)</span></div> |
| |
| |
| <div class="viewcode-block" id="BuildProcessor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor">[docs]</a><span class="k">class</span> <span class="nc">BuildProcessor</span><span class="p">:</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Processes build configurations to add additional functionality to support the use of operators.</span> |
| |
| <span class="sd"> The following improvements are made:</span> |
| |
| <span class="sd"> * It is required to provide the source and only one type can be given,</span> |
| <span class="sd"> * It is possible to provide the source as the URL address instead dict.</span> |
| |
| <span class="sd"> :param body: The request body.</span> |
| <span class="sd"> See: https://cloud.google.com/cloud-build/docs/api/reference/rest/Shared.Types/Build</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> """</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">body</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="BuildProcessor._verify_source"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor._verify_source">[docs]</a> <span class="k">def</span> <span class="nf">_verify_source</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">is_storage</span> <span class="o">=</span> <span class="s2">"storageSource"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> |
| <span class="n">is_repo</span> <span class="o">=</span> <span class="s2">"repoSource"</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> |
| |
| <span class="n">sources_count</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">([</span><span class="n">is_storage</span><span class="p">,</span> <span class="n">is_repo</span><span class="p">])</span> |
| |
| <span class="k">if</span> <span class="n">sources_count</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"The source could not be determined. Please choose one data source from: "</span></div> |
| <span class="s2">"storageSource and repoSource."</span> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="BuildProcessor._reformat_source"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor._reformat_source">[docs]</a> <span class="k">def</span> <span class="nf">_reformat_source</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reformat_repo_source</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reformat_storage_source</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="BuildProcessor._reformat_repo_source"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor._reformat_repo_source">[docs]</a> <span class="k">def</span> <span class="nf">_reformat_repo_source</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="s2">"repoSource"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]:</span> |
| <span class="k">return</span> |
| |
| <span class="n">source</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">][</span><span class="s2">"repoSource"</span><span class="p">]</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span> |
| <span class="k">return</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">][</span><span class="s2">"repoSource"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_convert_repo_url_to_dict</span><span class="p">(</span><span class="n">source</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="BuildProcessor._reformat_storage_source"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor._reformat_storage_source">[docs]</a> <span class="k">def</span> <span class="nf">_reformat_storage_source</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="s2">"storageSource"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]:</span> |
| <span class="k">return</span> |
| |
| <span class="n">source</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">][</span><span class="s2">"storageSource"</span><span class="p">]</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">source</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">):</span> |
| <span class="k">return</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="s2">"source"</span><span class="p">][</span><span class="s2">"storageSource"</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_convert_storage_url_to_dict</span><span class="p">(</span><span class="n">source</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="BuildProcessor.process_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor.process_body">[docs]</a> <span class="k">def</span> <span class="nf">process_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Processes the body passed in the constructor</span> |
| |
| <span class="sd"> :return: the body.</span> |
| <span class="sd"> :type: dict</span> |
| <span class="sd"> """</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_verify_source</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reformat_source</span><span class="p">()</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="BuildProcessor._convert_repo_url_to_dict"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor._convert_repo_url_to_dict">[docs]</a> <span class="k">def</span> <span class="nf">_convert_repo_url_to_dict</span><span class="p">(</span><span class="n">source</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Convert url to repository in Google Cloud Source to a format supported by the API</span> |
| |
| <span class="sd"> Example valid input:</span> |
| |
| <span class="sd"> .. code-block:: none</span> |
| |
| <span class="sd"> https://source.developers.google.com/p/airflow-project/r/airflow-repo#branch-name</span> |
| |
| <span class="sd"> """</span> |
| <span class="n">url_parts</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">source</span><span class="p">)</span> |
| |
| <span class="n">match</span> <span class="o">=</span> <span class="n">REGEX_REPO_PATH</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">url_parts</span><span class="o">.</span><span class="n">path</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">scheme</span> <span class="o">!=</span> <span class="s2">"https"</span> <span class="ow">or</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">hostname</span> <span class="o">!=</span> <span class="s2">"source.developers.google.com"</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">match</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Invalid URL. You must pass the URL in the format: "</span> |
| <span class="s2">"https://source.developers.google.com/p/airflow-project/r/airflow-repo#branch-name"</span> |
| <span class="p">)</span> |
| |
| <span class="n">project_id</span> <span class="o">=</span> <span class="n">unquote</span><span class="p">(</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s2">"project_id"</span><span class="p">))</span> |
| <span class="n">repo_name</span> <span class="o">=</span> <span class="n">unquote</span><span class="p">(</span><span class="n">match</span><span class="o">.</span><span class="n">group</span><span class="p">(</span><span class="s2">"repo_name"</span><span class="p">))</span> |
| |
| <span class="n">source_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"projectId"</span><span class="p">:</span> <span class="n">project_id</span><span class="p">,</span> <span class="s2">"repoName"</span><span class="p">:</span> <span class="n">repo_name</span><span class="p">,</span> <span class="s2">"branchName"</span><span class="p">:</span> <span class="s2">"master"</span><span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">fragment</span><span class="p">:</span> |
| <span class="n">source_dict</span><span class="p">[</span><span class="s2">"branchName"</span><span class="p">]</span> <span class="o">=</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">fragment</span> |
| |
| <span class="k">return</span> <span class="n">source_dict</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="BuildProcessor._convert_storage_url_to_dict"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.BuildProcessor._convert_storage_url_to_dict">[docs]</a> <span class="k">def</span> <span class="nf">_convert_storage_url_to_dict</span><span class="p">(</span><span class="n">storage_url</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Convert url to object in Google Cloud Storage to a format supported by the API</span> |
| |
| <span class="sd"> Example valid input:</span> |
| |
| <span class="sd"> .. code-block:: none</span> |
| |
| <span class="sd"> gs://bucket-name/object-name.tar.gz</span> |
| |
| <span class="sd"> """</span> |
| <span class="n">url_parts</span> <span class="o">=</span> <span class="n">urlparse</span><span class="p">(</span><span class="n">storage_url</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">scheme</span> <span class="o">!=</span> <span class="s2">"gs"</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">hostname</span> <span class="ow">or</span> <span class="ow">not</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">path</span> <span class="ow">or</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">path</span> <span class="o">==</span> <span class="s2">"/"</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"Invalid URL. You must pass the URL in the format: "</span> |
| <span class="s2">"gs://bucket-name/object-name.tar.gz#24565443"</span> |
| <span class="p">)</span> |
| |
| <span class="n">source_dict</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"bucket"</span><span class="p">:</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">hostname</span><span class="p">,</span> <span class="s2">"object"</span><span class="p">:</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]}</span> |
| |
| <span class="k">if</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">fragment</span><span class="p">:</span> |
| <span class="n">source_dict</span><span class="p">[</span><span class="s2">"generation"</span><span class="p">]</span> <span class="o">=</span> <span class="n">url_parts</span><span class="o">.</span><span class="n">fragment</span> |
| |
| <span class="k">return</span> <span class="n">source_dict</span></div></div> |
| |
| |
| <div class="viewcode-block" id="CloudBuildCreateBuildOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.CloudBuildCreateBuildOperator">[docs]</a><span class="k">class</span> <span class="nc">CloudBuildCreateBuildOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Starts a build with the specified configuration.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:CloudBuildCreateBuildOperator`</span> |
| |
| <span class="sd"> :param body: The request body.</span> |
| <span class="sd"> See: https://cloud.google.com/cloud-build/docs/api/reference/rest/Shared.Types/Build</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: API version used (for example v1 or v1beta1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="CloudBuildCreateBuildOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.CloudBuildCreateBuildOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"body"</span><span class="p">,</span> <span class="s2">"gcp_conn_id"</span><span class="p">,</span> <span class="s2">"api_version"</span><span class="p">)</span></div> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s2">"google_cloud_default"</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s2">"v1"</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span> |
| <span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">CloudBuildCreateBuildOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="CloudBuildCreateBuildOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.CloudBuildCreateBuildOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'body' is missing"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="CloudBuildCreateBuildOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_cloud_build_operator/index.html#airflow.contrib.operators.gcp_cloud_build_operator.CloudBuildCreateBuildOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">CloudBuildHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">)</span> |
| <span class="n">body</span> <span class="o">=</span> <span class="n">BuildProcessor</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span><span class="o">.</span><span class="n">process_body</span><span class="p">()</span> |
| <span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">create_build</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </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> |