Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.3 / _modules / airflow / contrib / operators / gcp_function_operator.html
blob: 4d361840692d0462f1bcd2f576cfd950c056669e [file] [log] [blame]
<!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 &mdash; 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>
<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.3
</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</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling &amp; 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="../../../../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">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> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li><a href="../operators.html">airflow.contrib.operators</a> &raquo;</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"># &quot;License&quot;); 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"># &quot;AS IS&quot; 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>
<div class="viewcode-block" id="_validate_available_memory_in_mb"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator._validate_available_memory_in_mb">[docs]</a><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">&lt;=</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">&quot;The available memory has to be greater than 0&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="_validate_max_instances"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator._validate_max_instances">[docs]</a><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">&lt;=</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">&quot;The max instances parameter has to be greater than 0&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="CLOUD_FUNCTION_VALIDATION"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.CLOUD_FUNCTION_VALIDATION">[docs]</a><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">&quot;name&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="s2">&quot;^.+$&quot;</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">&quot;description&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="s2">&quot;^.+$&quot;</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">&quot;entryPoint&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;runtime&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;timeout&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;availableMemoryMb&quot;</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">&quot;labels&quot;</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">&quot;environmentVariables&quot;</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">&quot;network&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;maxInstances&quot;</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">&quot;source_code&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;union&quot;</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">&quot;sourceArchiveUrl&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;sourceRepositoryUrl&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">&#39;v1beta2&#39;</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">&quot;sourceRepository&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;dict&quot;</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">&quot;url&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;sourceUploadUrl&quot;</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">&quot;trigger&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;union&quot;</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">&quot;httpsTrigger&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;dict&quot;</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">&quot;eventTrigger&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;dict&quot;</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">&quot;eventType&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;resource&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;service&quot;</span><span class="p">,</span> <span class="n">regexp</span><span class="o">=</span><span class="sa">r</span><span class="s1">&#39;^.+$&#39;</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">&quot;failurePolicy&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;dict&quot;</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">&quot;retry&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;dict&quot;</span><span class="p">,</span> <span class="n">optional</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span></div>
<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="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.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">&quot;&quot;&quot;</span>
<span class="sd"> Creates a function in Google Cloud Functions.</span>
<span class="sd"> If a function with this name already exists, it will be updated.</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:GcfFunctionDeployOperator`</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 project_id: (Optional) Google Cloud Platform project ID where the function</span>
<span class="sd"> should be created.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :param gcp_conn_id: (Optional) The connection ID used to connect to Google Cloud</span>
<span class="sd"> Platform - default &#39;google_cloud_default&#39;.</span>
<span class="sd"> :type gcp_conn_id: str</span>
<span class="sd"> :param api_version: (Optional) API version used (for example v1 - default - or</span>
<span class="sd"> 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"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcf_function_deploy_template_fields]</span>
<div class="viewcode-block" id="GcfFunctionDeployOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;project_id&#39;</span><span class="p">,</span> <span class="s1">&#39;location&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">,</span> <span class="s1">&#39;api_version&#39;</span><span class="p">)</span></div>
<span class="c1"># [END gcf_function_deploy_template_fields]</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">location</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="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="n">api_version</span><span class="o">=</span><span class="s1">&#39;v1&#39;</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">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>
<div class="viewcode-block" id="GcfFunctionDeployOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator._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">location</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The required parameter &#39;location&#39; is missing&quot;</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">&quot;The required parameter &#39;body&#39; is missing&quot;</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></div>
<div class="viewcode-block" id="GcfFunctionDeployOperator._validate_all_body_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator._validate_all_body_fields">[docs]</a> <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></div>
<div class="viewcode-block" id="GcfFunctionDeployOperator._create_new_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator._create_new_function">[docs]</a> <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="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>
<span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">location</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></div>
<div class="viewcode-block" id="GcfFunctionDeployOperator._update_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator._update_function">[docs]</a> <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">&#39;name&#39;</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></div>
<div class="viewcode-block" id="GcfFunctionDeployOperator._check_if_function_exists"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator._check_if_function_exists">[docs]</a> <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">&#39;name&#39;</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">&quot;The &#39;name&#39; field should be present in &quot;</span>
<span class="s2">&quot;body: &#39;</span><span class="si">{}</span><span class="s2">&#39;.&quot;</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></div>
<div class="viewcode-block" id="GcfFunctionDeployOperator._upload_source_code"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator._upload_source_code">[docs]</a> <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">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>
<span class="n">location</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">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></div>
<div class="viewcode-block" id="GcfFunctionDeployOperator._set_airflow_version_label"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeployOperator._set_airflow_version_label">[docs]</a> <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">&#39;labels&#39;</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">&#39;labels&#39;</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">&#39;labels&#39;</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">&#39;airflow-version&#39;</span><span class="p">:</span> <span class="s1">&#39;v&#39;</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">&#39;.&#39;</span><span class="p">,</span> <span class="s1">&#39;-&#39;</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s1">&#39;+&#39;</span><span class="p">,</span> <span class="s1">&#39;-&#39;</span><span class="p">)})</span></div>
<div class="viewcode-block" id="GcfFunctionDeployOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.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">GCF_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>
<div class="viewcode-block" id="GCF_SOURCE_ARCHIVE_URL"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GCF_SOURCE_ARCHIVE_URL">[docs]</a><span class="n">GCF_SOURCE_ARCHIVE_URL</span> <span class="o">=</span> <span class="s1">&#39;sourceArchiveUrl&#39;</span></div>
<div class="viewcode-block" id="GCF_SOURCE_UPLOAD_URL"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GCF_SOURCE_UPLOAD_URL">[docs]</a><span class="n">GCF_SOURCE_UPLOAD_URL</span> <span class="o">=</span> <span class="s1">&#39;sourceUploadUrl&#39;</span></div>
<div class="viewcode-block" id="SOURCE_REPOSITORY"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.SOURCE_REPOSITORY">[docs]</a><span class="n">SOURCE_REPOSITORY</span> <span class="o">=</span> <span class="s1">&#39;sourceRepository&#39;</span></div>
<div class="viewcode-block" id="GCF_ZIP_PATH"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GCF_ZIP_PATH">[docs]</a><span class="n">GCF_ZIP_PATH</span> <span class="o">=</span> <span class="s1">&#39;zip_path&#39;</span></div>
<div class="viewcode-block" id="ZipPathPreprocessor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor">[docs]</a><span class="k">class</span> <span class="nc">ZipPathPreprocessor</span><span class="p">:</span>
<span class="sd">&quot;&quot;&quot;</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"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="ZipPathPreprocessor.upload_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor.upload_function">[docs]</a> <span class="n">upload_function</span> <span class="o">=</span> <span class="kc">None</span></div>
<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>
<div class="viewcode-block" id="ZipPathPreprocessor._is_present_and_empty"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor._is_present_and_empty">[docs]</a> <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></div>
<div class="viewcode-block" id="ZipPathPreprocessor._verify_upload_url_and_no_zip_path"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor._verify_upload_url_and_no_zip_path">[docs]</a> <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">GCF_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">&quot;Parameter &#39;</span><span class="si">{}</span><span class="s2">&#39; is empty in the body and argument &#39;</span><span class="si">{}</span><span class="s2">&#39; &quot;</span>
<span class="s2">&quot;is missing or empty. You need to have non empty &#39;</span><span class="si">{}</span><span class="s2">&#39; &quot;</span>
<span class="s2">&quot;when &#39;</span><span class="si">{}</span><span class="s2">&#39; is present and empty.&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="n">GCF_SOURCE_UPLOAD_URL</span><span class="p">,</span> <span class="n">GCF_ZIP_PATH</span><span class="p">,</span> <span class="n">GCF_ZIP_PATH</span><span class="p">,</span> <span class="n">GCF_SOURCE_UPLOAD_URL</span><span class="p">))</span></div>
<div class="viewcode-block" id="ZipPathPreprocessor._verify_upload_url_and_zip_path"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor._verify_upload_url_and_zip_path">[docs]</a> <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">GCF_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">GCF_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">&quot;Only one of &#39;</span><span class="si">{}</span><span class="s2">&#39; in body or &#39;</span><span class="si">{}</span><span class="s2">&#39; argument &quot;</span>
<span class="s2">&quot;allowed. Found both.&quot;</span>
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">GCF_SOURCE_UPLOAD_URL</span><span class="p">,</span> <span class="n">GCF_ZIP_PATH</span><span class="p">))</span></div>
<div class="viewcode-block" id="ZipPathPreprocessor._verify_archive_url_and_zip_path"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor._verify_archive_url_and_zip_path">[docs]</a> <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">GCF_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">&quot;Only one of &#39;</span><span class="si">{}</span><span class="s2">&#39; in body or &#39;</span><span class="si">{}</span><span class="s2">&#39; argument &quot;</span>
<span class="s2">&quot;allowed. Found both.&quot;</span>
<span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">GCF_SOURCE_ARCHIVE_URL</span><span class="p">,</span> <span class="n">GCF_ZIP_PATH</span><span class="p">))</span></div>
<div class="viewcode-block" id="ZipPathPreprocessor.should_upload_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor.should_upload_function">[docs]</a> <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">&#39;validate() method has to be invoked before &#39;</span>
<span class="s1">&#39;should_upload_function&#39;</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></div>
<div class="viewcode-block" id="ZipPathPreprocessor.preprocess_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.ZipPathPreprocessor.preprocess_body">[docs]</a> <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></div></div>
<div class="viewcode-block" id="FUNCTION_NAME_PATTERN"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.FUNCTION_NAME_PATTERN">[docs]</a><span class="n">FUNCTION_NAME_PATTERN</span> <span class="o">=</span> <span class="s1">&#39;^projects/[^/]+/locations/[^/]+/functions/[^/]+$&#39;</span></div>
<div class="viewcode-block" id="FUNCTION_NAME_COMPILED_PATTERN"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.FUNCTION_NAME_COMPILED_PATTERN">[docs]</a><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>
<div class="viewcode-block" id="GcfFunctionDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.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">&quot;&quot;&quot;</span>
<span class="sd"> Deletes the specified function from Google Cloud Functions.</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:GcfFunctionDeleteOperator`</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"> &quot;&quot;&quot;</span>
<span class="c1"># [START gcf_function_delete_template_fields]</span>
<div class="viewcode-block" id="GcfFunctionDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeleteOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;name&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp_conn_id&#39;</span><span class="p">,</span> <span class="s1">&#39;api_version&#39;</span><span class="p">)</span></div>
<span class="c1"># [END gcf_function_delete_template_fields]</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">&#39;google_cloud_default&#39;</span><span class="p">,</span>
<span class="n">api_version</span><span class="o">=</span><span class="s1">&#39;v1&#39;</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>
<div class="viewcode-block" id="GcfFunctionDeleteOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.html#airflow.contrib.operators.gcp_function_operator.GcfFunctionDeleteOperator._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">name</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">AttributeError</span><span class="p">(</span><span class="s1">&#39;Empty parameter: name&#39;</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">&#39;Parameter name must match pattern: </span><span class="si">{}</span><span class="s1">&#39;</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>
<div class="viewcode-block" id="GcfFunctionDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_function_operator/index.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">&#39;The function does not exist in this project&#39;</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">&#39;An error occurred. Exiting.&#39;</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">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>