| |
| |
| |
| |
| <!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.hooks.gcp_function_hook — 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 & 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> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../hooks.html">airflow.contrib.hooks</a> »</li> |
| |
| <li>airflow.contrib.hooks.gcp_function_hook</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.hooks.gcp_function_hook</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">time</span> |
| <span class="kn">import</span> <span class="nn">requests</span> |
| <span class="kn">from</span> <span class="nn">googleapiclient.discovery</span> <span class="k">import</span> <span class="n">build</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span> |
| |
| <span class="c1"># Number of retries - used by googleapiclient method calls to perform retries</span> |
| <span class="c1"># For requests that are "retriable"</span> |
| <div class="viewcode-block" id="NUM_RETRIES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.NUM_RETRIES">[docs]</a><span class="n">NUM_RETRIES</span> <span class="o">=</span> <span class="mi">5</span></div> |
| |
| <span class="c1"># Time to sleep between active checks of the operation results</span> |
| <div class="viewcode-block" id="TIME_TO_SLEEP_IN_SECONDS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.TIME_TO_SLEEP_IN_SECONDS">[docs]</a><span class="n">TIME_TO_SLEEP_IN_SECONDS</span> <span class="o">=</span> <span class="mi">1</span></div> |
| |
| |
| <span class="c1"># noinspection PyAbstractClass</span> |
| <div class="viewcode-block" id="GcfHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook">[docs]</a><span class="k">class</span> <span class="nc">GcfHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Hook for the Google Cloud Functions APIs.</span> |
| |
| <span class="sd"> All the methods in the hook where project_id is used must be called with</span> |
| <span class="sd"> keyword arguments rather than positional.</span> |
| <span class="sd"> """</span> |
| <div class="viewcode-block" id="GcfHook._conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook._conn">[docs]</a> <span class="n">_conn</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">api_version</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">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">GcfHook</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="n">gcp_conn_id</span><span class="p">,</span> <span class="n">delegate_to</span><span class="p">)</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="nd">@staticmethod</span> |
| <div class="viewcode-block" id="GcfHook._full_location"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook._full_location">[docs]</a> <span class="k">def</span> <span class="nf">_full_location</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="sd">"""</span> |
| <span class="sd"> Retrieve full location of the function in the form of</span> |
| <span class="sd"> projects/<GCP_PROJECT_ID>/locations/<GCP_LOCATION></span> |
| |
| <span class="sd"> :param project_id: The Google Cloud Project project_id where the function belongs.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param location: The location where the function is created.</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :return:</span> |
| <span class="sd"> """</span> |
| <span class="k">return</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="n">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcfHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Retrieves the connection to Cloud Functions.</span> |
| |
| <span class="sd"> :return: Google Cloud Function services object.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="p">:</span> |
| <span class="n">http_authorized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_authorize</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="n">build</span><span class="p">(</span><span class="s1">'cloudfunctions'</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> |
| <span class="n">http</span><span class="o">=</span><span class="n">http_authorized</span><span class="p">,</span> <span class="n">cache_discovery</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span></div> |
| |
| <div class="viewcode-block" id="GcfHook.get_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook.get_function">[docs]</a> <span class="k">def</span> <span class="nf">get_function</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="sd">"""</span> |
| <span class="sd"> Returns the Cloud Function with the given name.</span> |
| |
| <span class="sd"> :param name: Name of the function.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :return: A Cloud Functions object representing the function.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">projects</span><span class="p">()</span><span class="o">.</span><span class="n">locations</span><span class="p">()</span><span class="o">.</span><span class="n">functions</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="n">NUM_RETRIES</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="GcfHook.create_new_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook.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="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="sd">"""</span> |
| <span class="sd"> Creates a new function in Cloud Function in the location specified in the body.</span> |
| |
| <span class="sd"> :param location: The location of the function.</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param body: The body required by the Cloud Functions insert API.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param project_id: Optional, Google Cloud Project project_id where the function belongs.</span> |
| <span class="sd"> If set to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">projects</span><span class="p">()</span><span class="o">.</span><span class="n">locations</span><span class="p">()</span><span class="o">.</span><span class="n">functions</span><span class="p">()</span><span class="o">.</span><span class="n">create</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">_full_location</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="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="n">NUM_RETRIES</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcfHook.update_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook.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="n">name</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">update_mask</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates Cloud Functions according to the specified update mask.</span> |
| |
| <span class="sd"> :param name: The name of the function.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :param body: The body required by the cloud function patch API.</span> |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param update_mask: The update mask - array of fields that should be patched.</span> |
| <span class="sd"> :type update_mask: [str]</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">projects</span><span class="p">()</span><span class="o">.</span><span class="n">locations</span><span class="p">()</span><span class="o">.</span><span class="n">functions</span><span class="p">()</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span> |
| <span class="n">updateMask</span><span class="o">=</span><span class="s2">","</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">update_mask</span><span class="p">),</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">body</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="n">NUM_RETRIES</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span> |
| <div class="viewcode-block" id="GcfHook.upload_function_zip"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook.upload_function_zip">[docs]</a> <span class="k">def</span> <span class="nf">upload_function_zip</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">zip_path</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="sd">"""</span> |
| <span class="sd"> Uploads zip file with sources.</span> |
| |
| <span class="sd"> :param location: The location where the function is created.</span> |
| <span class="sd"> :type location: str</span> |
| <span class="sd"> :param zip_path: The path of the valid .zip file to upload.</span> |
| <span class="sd"> :type zip_path: str</span> |
| <span class="sd"> :param project_id: Optional, Google Cloud Project project_id where the function belongs.</span> |
| <span class="sd"> If set to None or missing, the default project_id from the GCP connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :return: The upload URL that was returned by generateUploadUrl method.</span> |
| <span class="sd"> """</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">projects</span><span class="p">()</span><span class="o">.</span><span class="n">locations</span><span class="p">()</span><span class="o">.</span><span class="n">functions</span><span class="p">()</span><span class="o">.</span><span class="n">generateUploadUrl</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">project_id</span><span class="p">,</span> <span class="n">location</span><span class="p">)</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="n">NUM_RETRIES</span><span class="p">)</span> |
| <span class="n">upload_url</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'uploadUrl'</span><span class="p">)</span> |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">zip_path</span><span class="p">,</span> <span class="s1">'rb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span> |
| <span class="n">requests</span><span class="o">.</span><span class="n">put</span><span class="p">(</span> |
| <span class="n">url</span><span class="o">=</span><span class="n">upload_url</span><span class="p">,</span> |
| <span class="n">data</span><span class="o">=</span><span class="n">fp</span><span class="p">,</span> |
| <span class="c1"># Those two headers needs to be specified according to:</span> |
| <span class="c1"># https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions/generateUploadUrl</span> |
| <span class="c1"># nopep8</span> |
| <span class="n">headers</span><span class="o">=</span><span class="p">{</span> |
| <span class="s1">'Content-type'</span><span class="p">:</span> <span class="s1">'application/zip'</span><span class="p">,</span> |
| <span class="s1">'x-goog-content-length-range'</span><span class="p">:</span> <span class="s1">'0,104857600'</span><span class="p">,</span> |
| <span class="p">}</span> |
| <span class="p">)</span> |
| <span class="k">return</span> <span class="n">upload_url</span></div> |
| |
| <div class="viewcode-block" id="GcfHook.delete_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook.delete_function">[docs]</a> <span class="k">def</span> <span class="nf">delete_function</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="sd">"""</span> |
| <span class="sd"> Deletes the specified Cloud Function.</span> |
| |
| <span class="sd"> :param name: The name of the function.</span> |
| <span class="sd"> :type name: str</span> |
| <span class="sd"> :return: None</span> |
| <span class="sd"> """</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">projects</span><span class="p">()</span><span class="o">.</span><span class="n">locations</span><span class="p">()</span><span class="o">.</span><span class="n">functions</span><span class="p">()</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="n">NUM_RETRIES</span><span class="p">)</span> |
| <span class="n">operation_name</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s2">"name"</span><span class="p">]</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_wait_for_operation_to_complete</span><span class="p">(</span><span class="n">operation_name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcfHook._wait_for_operation_to_complete"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_function_hook/index.html#airflow.contrib.hooks.gcp_function_hook.GcfHook._wait_for_operation_to_complete">[docs]</a> <span class="k">def</span> <span class="nf">_wait_for_operation_to_complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Waits for the named operation to complete - checks status of the</span> |
| <span class="sd"> asynchronous call.</span> |
| |
| <span class="sd"> :param operation_name: The name of the operation.</span> |
| <span class="sd"> :type operation_name: str</span> |
| <span class="sd"> :return: The response returned by the operation.</span> |
| <span class="sd"> :rtype: dict</span> |
| <span class="sd"> :exception: AirflowException in case error is returned.</span> |
| <span class="sd"> """</span> |
| <span class="n">service</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span> |
| <span class="k">while</span> <span class="kc">True</span><span class="p">:</span> |
| <span class="n">operation_response</span> <span class="o">=</span> <span class="n">service</span><span class="o">.</span><span class="n">operations</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="n">name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">,</span> |
| <span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="n">NUM_RETRIES</span><span class="p">)</span> |
| <span class="k">if</span> <span class="n">operation_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"done"</span><span class="p">):</span> |
| <span class="n">response</span> <span class="o">=</span> <span class="n">operation_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"response"</span><span class="p">)</span> |
| <span class="n">error</span> <span class="o">=</span> <span class="n">operation_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"error"</span><span class="p">)</span> |
| <span class="c1"># Note, according to documentation always either response or error is</span> |
| <span class="c1"># set when "done" == True</span> |
| <span class="k">if</span> <span class="n">error</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="p">))</span> |
| <span class="k">return</span> <span class="n">response</span> |
| <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">TIME_TO_SLEEP_IN_SECONDS</span><span class="p">)</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |