http://git-wip-us.apache.org/repos/asf/incubator-airflow-site/blob/1f06fa0e/_modules/airflow/contrib/operators/gcp_function_operator.html
----------------------------------------------------------------------
diff --git a/_modules/airflow/contrib/operators/gcp_function_operator.html
b/_modules/airflow/contrib/operators/gcp_function_operator.html
new file mode 100644
index 0000000..b84716a
--- /dev/null
+++ b/_modules/airflow/contrib/operators/gcp_function_operator.html
@@ -0,0 +1,522 @@
+
+
+<!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_function_operator — Airflow
Documentation</title>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <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 src="../../../../_static/js/modernizr.min.js"></script>
+
+</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 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</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">Experimental Rest API</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="../../../../lineage.html">Lineage</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="../../../../code.html">API Reference</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>airflow.contrib.operators.gcp_function_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_function_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="kn">import</span> <span class="nn">re</span>
+
+<span class="kn">from</span> <span class="nn">googleapiclient.errors</span>
<span class="k">import</span> <span class="n">HttpError</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.utils.gcp_field_validator</span> <span
class="k">import</span> <span class="n">GcpBodyFieldValidator</span><span
class="p">,</span> \
+ <span class="n">GcpFieldValidationException</span>
+<span class="kn">from</span> <span class="nn">airflow.version</span> <span
class="k">import</span> <span class="n">version</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.contrib.hooks.gcp_function_hook</span> <span
class="k">import</span> <span class="n">GcfHook</span>
+<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span>
<span class="k">import</span> <span class="n">apply_defaults</span>
+
+
+<span class="k">def</span> <span
class="nf">_validate_available_memory_in_mb</span><span class="p">(</span><span
class="n">value</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">int</span><span
class="p">(</span><span class="n">value</span><span class="p">)</span> <span
class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">GcpFieldValidationException</span><span class="p">(</span><span
class="s2">"The available memory has to be greater than
0"</span><span class="p">)</span>
+
+
+<span class="k">def</span> <span
class="nf">_validate_max_instances</span><span class="p">(</span><span
class="n">value</span><span class="p">):</span>
+ <span class="k">if</span> <span class="nb">int</span><span
class="p">(</span><span class="n">value</span><span class="p">)</span> <span
class="o"><=</span> <span class="mi">0</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">GcpFieldValidationException</span><span class="p">(</span>
+ <span class="s2">"The max instances parameter has to be
greater than 0"</span><span class="p">)</span>
+
+
+<span class="n">CLOUD_FUNCTION_VALIDATION</span> <span class="o">=</span>
<span class="p">[</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"name"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span
class="s2">"^.+$"</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"description"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span
class="s2">"^.+$"</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"entryPoint"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"runtime"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"timeout"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"availableMemoryMb"</span><span class="p">,</span> <span
class="n">custom_validation</span><span class="o">=</span><span
class="n">_validate_available_memory_in_mb</span><span class="p">,</span>
+ <span class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"labels"</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"environmentVariables"</span><span class="p">,</span>
<span class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"network"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"maxInstances"</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">,</span> <span
class="n">custom_validation</span><span class="o">=</span><span
class="n">_validate_max_instances</span><span class="p">),</span>
+
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"source_code"</span><span class="p">,</span> <span
class="nb">type</span><span class="o">=</span><span
class="s2">"union"</span><span class="p">,</span> <span
class="n">fields</span><span class="o">=</span><span class="p">[</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"sourceArchiveUrl"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"sourceRepositoryUrl"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">,</span> <span
class="n">api_version</span><span class="o">=</span><span
class="s1">'v1beta2'</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"sourceRepository"</span><span class="p">,</span> <span
class="nb">type</span><span class="o">=</span><span
class="s2">"dict"</span><span class="p">,</span> <span
class="n">fields</span><span class="o">=</span><span class="p">[</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"url"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">)</span>
+ <span class="p">]),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"sourceUploadUrl"</span><span class="p">)</span>
+ <span class="p">]),</span>
+
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"trigger"</span><span class="p">,</span> <span
class="nb">type</span><span class="o">=</span><span
class="s2">"union"</span><span class="p">,</span> <span
class="n">fields</span><span class="o">=</span><span class="p">[</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"httpsTrigger"</span><span class="p">,</span> <span
class="nb">type</span><span class="o">=</span><span
class="s2">"dict"</span><span class="p">,</span> <span
class="n">fields</span><span class="o">=</span><span class="p">[</span>
+ <span class="c1"># This dict should be empty at input (url is
added at output)</span>
+ <span class="p">]),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"eventTrigger"</span><span class="p">,</span> <span
class="nb">type</span><span class="o">=</span><span
class="s2">"dict"</span><span class="p">,</span> <span
class="n">fields</span><span class="o">=</span><span class="p">[</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"eventType"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"resource"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"service"</span><span class="p">,</span> <span
class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span
class="s1">'^.+$'</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">),</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"failurePolicy"</span><span class="p">,</span> <span
class="nb">type</span><span class="o">=</span><span
class="s2">"dict"</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">,</span> <span
class="n">fields</span><span class="o">=</span><span class="p">[</span>
+ <span class="nb">dict</span><span class="p">(</span><span
class="n">name</span><span class="o">=</span><span
class="s2">"retry"</span><span class="p">,</span> <span
class="nb">type</span><span class="o">=</span><span
class="s2">"dict"</span><span class="p">,</span> <span
class="n">optional</span><span class="o">=</span><span
class="kc">True</span><span class="p">)</span>
+ <span class="p">])</span>
+ <span class="p">])</span>
+ <span class="p">]),</span>
+<span class="p">]</span>
+
+
+<div class="viewcode-block" id="GcfFunctionDeployOperator"><a
class="viewcode-back"
href="../../../../integration.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator">[docs]</a><span
class="k">class</span> <span class="nc">GcfFunctionDeployOperator</span><span
class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Creates a function in Google Cloud Functions.</span>
+
+<span class="sd"> :param project_id: Google Cloud Platform Project ID where
the function should</span>
+<span class="sd"> be created.</span>
+<span class="sd"> :type project_id: str</span>
+<span class="sd"> :param location: Google Cloud Platform region where the
function should be created.</span>
+<span class="sd"> :type location: str</span>
+<span class="sd"> :param body: Body of the Cloud Functions definition. The
body must be a</span>
+<span class="sd"> Cloud Functions dictionary as described in:</span>
+<span class="sd">
https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions</span>
+<span class="sd"> . Different API versions require different variants
of the Cloud Functions</span>
+<span class="sd"> dictionary.</span>
+<span class="sd"> :type body: dict or
google.cloud.functions.v1.CloudFunction</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"> :param zip_path: Path to zip file containing source code
of the function. If the path</span>
+<span class="sd"> is set, the sourceUploadUrl should not be specified
in the body or it should</span>
+<span class="sd"> be empty. Then the zip file will be uploaded using
the upload URL generated</span>
+<span class="sd"> via generateUploadUrl from the Cloud Functions
API.</span>
+<span class="sd"> :type zip_path: str</span>
+<span class="sd"> :param validate_body: If set to False, body validation is
not performed.</span>
+<span class="sd"> :type validate_body: bool</span>
+<span class="sd"> """</span>
+
+ <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">project_id</span><span class="p">,</span>
+ <span class="n">location</span><span class="p">,</span>
+ <span class="n">body</span><span class="p">,</span>
+ <span class="n">gcp_conn_id</span><span
class="o">=</span><span class="s1">'google_cloud_default'</span><span
class="p">,</span>
+ <span class="n">api_version</span><span
class="o">=</span><span class="s1">'v1'</span><span class="p">,</span>
+ <span class="n">zip_path</span><span class="o">=</span><span
class="kc">None</span><span class="p">,</span>
+ <span class="n">validate_body</span><span
class="o">=</span><span class="kc">True</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">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">location</span> <span class="o">=</span> <span
class="n">location</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">full_location</span> <span class="o">=</span> <span
class="s1">'projects/</span><span class="si">{}</span><span
class="s1">/locations/</span><span class="si">{}</span><span
class="s1">'</span><span class="o">.</span><span
class="n">format</span><span class="p">(</span><span
class="bp">self</span><span class="o">.</span><span
class="n">project_id</span><span class="p">,</span>
+ <span
class="bp">self</span><span class="o">.</span><span
class="n">location</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">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">zip_path</span> <span class="o">=</span> <span
class="n">zip_path</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">zip_path_preprocessor</span> <span class="o">=</span> <span
class="n">ZipPathPreprocessor</span><span class="p">(</span><span
class="n">body</span><span class="p">,</span> <span
class="n">zip_path</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_field_validator</span> <span class="o">=</span> <span
class="kc">None</span>
+ <span class="k">if</span> <span class="n">validate_body</span><span
class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_field_validator</span> <span class="o">=</span> <span
class="n">GcpBodyFieldValidator</span><span class="p">(</span><span
class="n">CLOUD_FUNCTION_VALIDATION</span><span class="p">,</span>
+ <span
class="n">api_version</span><span class="o">=</span><span
class="n">api_version</span><span class="p">)</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_hook</span> <span class="o">=</span> <span
class="n">GcfHook</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="bp">self</span><span class="o">.</span><span
class="n">_validate_inputs</span><span class="p">()</span>
+ <span class="nb">super</span><span class="p">(</span><span
class="n">GcfFunctionDeployOperator</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="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">project_id</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 'project_id' is
missing"</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">location</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 'location' is
missing"</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>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">zip_path_preprocessor</span><span class="o">.</span><span
class="n">preprocess_body</span><span class="p">()</span>
+
+ <span class="k">def</span> <span
class="nf">_validate_all_body_fields</span><span class="p">(</span><span
class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span
class="o">.</span><span class="n">_field_validator</span><span
class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_field_validator</span><span class="o">.</span><span
class="n">validate</span><span class="p">(</span><span
class="bp">self</span><span class="o">.</span><span class="n">body</span><span
class="p">)</span>
+
+ <span class="k">def</span> <span
class="nf">_create_new_function</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">_hook</span><span class="o">.</span><span
class="n">create_new_function</span><span class="p">(</span><span
class="bp">self</span><span class="o">.</span><span
class="n">full_location</span><span class="p">,</span> <span
class="bp">self</span><span class="o">.</span><span class="n">body</span><span
class="p">)</span>
+
+ <span class="k">def</span> <span class="nf">_update_function</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">_hook</span><span class="o">.</span><span
class="n">update_function</span><span class="p">(</span><span
class="bp">self</span><span class="o">.</span><span class="n">body</span><span
class="p">[</span><span class="s1">'name'</span><span
class="p">],</span> <span class="bp">self</span><span class="o">.</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">keys</span><span class="p">())</span>
+
+ <span class="k">def</span> <span
class="nf">_check_if_function_exists</span><span class="p">(</span><span
class="bp">self</span><span class="p">):</span>
+ <span class="n">name</span> <span class="o">=</span> <span
class="bp">self</span><span class="o">.</span><span class="n">body</span><span
class="o">.</span><span class="n">get</span><span class="p">(</span><span
class="s1">'name'</span><span class="p">)</span>
+ <span class="k">if</span> <span class="ow">not</span> <span
class="n">name</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">GcpFieldValidationException</span><span class="p">(</span><span
class="s2">"The 'name' field should be present in "</span>
+ <span class="s2">"body:
'</span><span class="si">{}</span><span class="s2">'."</span><span
class="o">.</span><span class="n">format</span><span class="p">(</span><span
class="bp">self</span><span class="o">.</span><span class="n">body</span><span
class="p">))</span>
+ <span class="k">try</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_hook</span><span class="o">.</span><span
class="n">get_function</span><span class="p">(</span><span
class="n">name</span><span class="p">)</span>
+ <span class="k">except</span> <span class="n">HttpError</span> <span
class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">status</span> <span class="o">=</span> <span
class="n">e</span><span class="o">.</span><span class="n">resp</span><span
class="o">.</span><span class="n">status</span>
+ <span class="k">if</span> <span class="n">status</span> <span
class="o">==</span> <span class="mi">404</span><span class="p">:</span>
+ <span class="k">return</span> <span class="kc">False</span>
+ <span class="k">raise</span> <span class="n">e</span>
+ <span class="k">return</span> <span class="kc">True</span>
+
+ <span class="k">def</span> <span
class="nf">_upload_source_code</span><span class="p">(</span><span
class="bp">self</span><span class="p">):</span>
+ <span class="k">return</span> <span class="bp">self</span><span
class="o">.</span><span class="n">_hook</span><span class="o">.</span><span
class="n">upload_function_zip</span><span class="p">(</span><span
class="n">parent</span><span class="o">=</span><span
class="bp">self</span><span class="o">.</span><span
class="n">full_location</span><span class="p">,</span>
+ <span
class="n">zip_path</span><span class="o">=</span><span
class="bp">self</span><span class="o">.</span><span
class="n">zip_path</span><span class="p">)</span>
+
+ <span class="k">def</span> <span
class="nf">_set_airflow_version_label</span><span class="p">(</span><span
class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="s1">'labels'</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="o">.</span><span class="n">keys</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">body</span><span class="p">[</span><span
class="s1">'labels'</span><span class="p">]</span> <span
class="o">=</span> <span class="p">{}</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">body</span><span class="p">[</span><span
class="s1">'labels'</span><span class="p">]</span><span
class="o">.</span><span class="n">update</span><span class="p">(</span>
+ <span class="p">{</span><span
class="s1">'airflow-version'</span><span class="p">:</span> <span
class="s1">'v'</span> <span class="o">+</span> <span
class="n">version</span><span class="o">.</span><span
class="n">replace</span><span class="p">(</span><span
class="s1">'.'</span><span class="p">,</span> <span
class="s1">'-'</span><span class="p">)</span><span
class="o">.</span><span class="n">replace</span><span class="p">(</span><span
class="s1">'+'</span><span class="p">,</span> <span
class="s1">'-'</span><span class="p">)})</span>
+
+<div class="viewcode-block" id="GcfFunctionDeployOperator.execute"><a
class="viewcode-back"
href="../../../../integration.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator.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="k">if</span> <span class="bp">self</span><span
class="o">.</span><span class="n">zip_path_preprocessor</span><span
class="o">.</span><span class="n">should_upload_function</span><span
class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">body</span><span class="p">[</span><span
class="n">SOURCE_UPLOAD_URL</span><span class="p">]</span> <span
class="o">=</span> <span class="bp">self</span><span class="o">.</span><span
class="n">_upload_source_code</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_validate_all_body_fields</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_set_airflow_version_label</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">_check_if_function_exists</span><span class="p">():</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_create_new_function</span><span class="p">()</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_update_function</span><span class="p">()</span></div></div>
+
+
+<span class="n">SOURCE_ARCHIVE_URL</span> <span class="o">=</span> <span
class="s1">'sourceArchiveUrl'</span>
+<span class="n">SOURCE_UPLOAD_URL</span> <span class="o">=</span> <span
class="s1">'sourceUploadUrl'</span>
+<span class="n">SOURCE_REPOSITORY</span> <span class="o">=</span> <span
class="s1">'sourceRepository'</span>
+<span class="n">ZIP_PATH</span> <span class="o">=</span> <span
class="s1">'zip_path'</span>
+
+
+<span class="k">class</span> <span class="nc">ZipPathPreprocessor</span><span
class="p">:</span>
+ <span class="sd">"""</span>
+<span class="sd"> Pre-processes zip path parameter.</span>
+
+<span class="sd"> Responsible for checking if the zip path parameter is
correctly specified in</span>
+<span class="sd"> relation with source_code body fields. Non empty zip path
parameter is special because</span>
+<span class="sd"> it is mutually exclusive with sourceArchiveUrl and
sourceRepository body fields.</span>
+<span class="sd"> It is also mutually exclusive with non-empty
sourceUploadUrl.</span>
+<span class="sd"> The pre-process modifies sourceUploadUrl body field in
special way when zip_path</span>
+<span class="sd"> is not empty. An extra step is run when execute method is
called and sourceUploadUrl</span>
+<span class="sd"> field value is set in the body with the value returned by
generateUploadUrl Cloud</span>
+<span class="sd"> Function API method.</span>
+
+<span class="sd"> :param body: Body passed to the create/update method
calls.</span>
+<span class="sd"> :type body: dict</span>
+<span class="sd"> :param zip_path: path to the zip file containing source
code.</span>
+<span class="sd"> :type body: dict</span>
+
+<span class="sd"> """</span>
+ <span class="n">upload_function</span> <span class="o">=</span> <span
class="kc">None</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">zip_path</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">zip_path</span> <span class="o">=</span> <span
class="n">zip_path</span>
+
+ <span class="nd">@staticmethod</span>
+ <span class="k">def</span> <span
class="nf">_is_present_and_empty</span><span class="p">(</span><span
class="n">dictionary</span><span class="p">,</span> <span
class="n">field</span><span class="p">):</span>
+ <span class="k">return</span> <span class="n">field</span> <span
class="ow">in</span> <span class="n">dictionary</span> <span
class="ow">and</span> <span class="ow">not</span> <span
class="n">dictionary</span><span class="p">[</span><span
class="n">field</span><span class="p">]</span>
+
+ <span class="k">def</span> <span
class="nf">_verify_upload_url_and_no_zip_path</span><span
class="p">(</span><span class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span
class="o">.</span><span class="n">_is_present_and_empty</span><span
class="p">(</span><span class="bp">self</span><span class="o">.</span><span
class="n">body</span><span class="p">,</span> <span
class="n">SOURCE_UPLOAD_URL</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">zip_path</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">AirflowException</span><span class="p">(</span>
+ <span class="s2">"Parameter '</span><span
class="si">{}</span><span class="s2">' is empty in the body and argument
'</span><span class="si">{}</span><span class="s2">' "</span>
+ <span class="s2">"is missing or empty. You need to
have non empty '</span><span class="si">{}</span><span class="s2">'
"</span>
+ <span class="s2">"when '</span><span
class="si">{}</span><span class="s2">' is present and
empty."</span><span class="o">.</span>
+ <span class="nb">format</span><span
class="p">(</span><span class="n">SOURCE_UPLOAD_URL</span><span
class="p">,</span> <span class="n">ZIP_PATH</span><span class="p">,</span>
<span class="n">ZIP_PATH</span><span class="p">,</span> <span
class="n">SOURCE_UPLOAD_URL</span><span class="p">))</span>
+
+ <span class="k">def</span> <span
class="nf">_verify_upload_url_and_zip_path</span><span class="p">(</span><span
class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">SOURCE_UPLOAD_URL</span>
<span class="ow">in</span> <span class="bp">self</span><span
class="o">.</span><span class="n">body</span> <span class="ow">and</span> <span
class="bp">self</span><span class="o">.</span><span
class="n">zip_path</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="n">SOURCE_UPLOAD_URL</span><span
class="p">]:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">upload_function</span> <span class="o">=</span> <span
class="kc">True</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">AirflowException</span><span class="p">(</span><span
class="s2">"Only one of '</span><span class="si">{}</span><span
class="s2">' in body or '</span><span class="si">{}</span><span
class="s2">' argument "</span>
+ <span class="s2">"allowed. Found
both."</span>
+ <span class="o">.</span><span
class="n">format</span><span class="p">(</span><span
class="n">SOURCE_UPLOAD_URL</span><span class="p">,</span> <span
class="n">ZIP_PATH</span><span class="p">))</span>
+
+ <span class="k">def</span> <span
class="nf">_verify_archive_url_and_zip_path</span><span class="p">(</span><span
class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="n">SOURCE_ARCHIVE_URL</span>
<span class="ow">in</span> <span class="bp">self</span><span
class="o">.</span><span class="n">body</span> <span class="ow">and</span> <span
class="bp">self</span><span class="o">.</span><span
class="n">zip_path</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">AirflowException</span><span class="p">(</span><span
class="s2">"Only one of '</span><span class="si">{}</span><span
class="s2">' in body or '</span><span class="si">{}</span><span
class="s2">' argument "</span>
+ <span class="s2">"allowed. Found
both."</span>
+ <span class="o">.</span><span
class="n">format</span><span class="p">(</span><span
class="n">SOURCE_ARCHIVE_URL</span><span class="p">,</span> <span
class="n">ZIP_PATH</span><span class="p">))</span>
+
+ <span class="k">def</span> <span
class="nf">should_upload_function</span><span class="p">(</span><span
class="bp">self</span><span class="p">):</span>
+ <span class="k">if</span> <span class="bp">self</span><span
class="o">.</span><span class="n">upload_function</span> <span
class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="k">raise</span> <span
class="n">AirflowException</span><span class="p">(</span><span
class="s1">'validate() method has to be invoked before '</span>
+ <span
class="s1">'should_upload_function'</span><span class="p">)</span>
+ <span class="k">return</span> <span class="bp">self</span><span
class="o">.</span><span class="n">upload_function</span>
+
+ <span class="k">def</span> <span class="nf">preprocess_body</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">_verify_archive_url_and_zip_path</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_verify_upload_url_and_zip_path</span><span class="p">()</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">_verify_upload_url_and_no_zip_path</span><span class="p">()</span>
+ <span class="k">if</span> <span class="bp">self</span><span
class="o">.</span><span class="n">upload_function</span> <span
class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">upload_function</span> <span class="o">=</span> <span
class="kc">False</span>
+
+
+<span class="n">FUNCTION_NAME_PATTERN</span> <span class="o">=</span> <span
class="s1">'^projects/[^/]+/locations/[^/]+/functions/[^/]+$'</span>
+<span class="n">FUNCTION_NAME_COMPILED_PATTERN</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="n">FUNCTION_NAME_PATTERN</span><span class="p">)</span>
+
+
+<div class="viewcode-block" id="GcfFunctionDeleteOperator"><a
class="viewcode-back"
href="../../../../integration.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeleteOperator">[docs]</a><span
class="k">class</span> <span class="nc">GcfFunctionDeleteOperator</span><span
class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
+ <span class="sd">"""</span>
+<span class="sd"> Deletes the specified function from Google Cloud
Functions.</span>
+
+<span class="sd"> :param name: A fully-qualified function name,
matching</span>
+<span class="sd"> the pattern:
`^projects/[^/]+/locations/[^/]+/functions/[^/]+$`</span>
+<span class="sd"> :type name: str</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>
+
+ <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">name</span><span class="p">,</span>
+ <span class="n">gcp_conn_id</span><span
class="o">=</span><span class="s1">'google_cloud_default'</span><span
class="p">,</span>
+ <span class="n">api_version</span><span
class="o">=</span><span class="s1">'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="bp">self</span><span class="o">.</span><span
class="n">name</span> <span class="o">=</span> <span class="n">name</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>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">hook</span> <span class="o">=</span> <span
class="n">GcfHook</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="nb">super</span><span class="p">(</span><span
class="n">GcfFunctionDeleteOperator</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="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">name</span><span
class="p">:</span>
+ <span class="k">raise</span> <span
class="ne">AttributeError</span><span class="p">(</span><span
class="s1">'Empty parameter: name'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="n">pattern</span> <span class="o">=</span> <span
class="n">FUNCTION_NAME_COMPILED_PATTERN</span>
+ <span class="k">if</span> <span class="ow">not</span> <span
class="n">pattern</span><span class="o">.</span><span
class="n">match</span><span class="p">(</span><span class="bp">self</span><span
class="o">.</span><span class="n">name</span><span class="p">):</span>
+ <span class="k">raise</span> <span
class="ne">AttributeError</span><span class="p">(</span>
+ <span class="s1">'Parameter name must match pattern:
</span><span class="si">{}</span><span class="s1">'</span><span
class="o">.</span><span class="n">format</span><span class="p">(</span><span
class="n">FUNCTION_NAME_PATTERN</span><span class="p">))</span>
+
+<div class="viewcode-block" id="GcfFunctionDeleteOperator.execute"><a
class="viewcode-back"
href="../../../../integration.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeleteOperator.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="k">try</span><span class="p">:</span>
+ <span class="k">return</span> <span class="bp">self</span><span
class="o">.</span><span class="n">hook</span><span class="o">.</span><span
class="n">delete_function</span><span class="p">(</span><span
class="bp">self</span><span class="o">.</span><span class="n">name</span><span
class="p">)</span>
+ <span class="k">except</span> <span class="n">HttpError</span> <span
class="k">as</span> <span class="n">e</span><span class="p">:</span>
+ <span class="n">status</span> <span class="o">=</span> <span
class="n">e</span><span class="o">.</span><span class="n">resp</span><span
class="o">.</span><span class="n">status</span>
+ <span class="k">if</span> <span class="n">status</span> <span
class="o">==</span> <span class="mi">404</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">log</span><span class="o">.</span><span class="n">info</span><span
class="p">(</span><span class="s1">'The function does not exist in this
project'</span><span class="p">)</span>
+ <span class="k">else</span><span class="p">:</span>
+ <span class="bp">self</span><span class="o">.</span><span
class="n">log</span><span class="o">.</span><span class="n">error</span><span
class="p">(</span><span class="s1">'An error occurred.
Exiting.'</span><span class="p">)</span>
+ <span class="k">raise</span> <span
class="n">e</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" 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/js/theme.js"></script>
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.Navigation.enable(true);
+ });
+ </script>
+
+</body>
+</html>
\ No newline at end of file