blob: 64bd7c3320a6945623c4da37531bd56ed3fbaeeb [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.hooks.gcp_compute_hook &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="../hooks.html">airflow.contrib.hooks</a> &raquo;</li>
<li>airflow.contrib.hooks.gcp_compute_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_compute_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"># &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">time</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 &quot;retriable&quot;</span>
<div class="viewcode-block" id="NUM_RETRIES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_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_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_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>
<div class="viewcode-block" id="GceOperationStatus"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceOperationStatus">[docs]</a><span class="k">class</span> <span class="nc">GceOperationStatus</span><span class="p">:</span>
<div class="viewcode-block" id="GceOperationStatus.PENDING"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceOperationStatus.PENDING">[docs]</a> <span class="n">PENDING</span> <span class="o">=</span> <span class="s2">&quot;PENDING&quot;</span></div>
<div class="viewcode-block" id="GceOperationStatus.RUNNING"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceOperationStatus.RUNNING">[docs]</a> <span class="n">RUNNING</span> <span class="o">=</span> <span class="s2">&quot;RUNNING&quot;</span></div>
<div class="viewcode-block" id="GceOperationStatus.DONE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceOperationStatus.DONE">[docs]</a> <span class="n">DONE</span> <span class="o">=</span> <span class="s2">&quot;DONE&quot;</span></div></div>
<span class="c1"># noinspection PyAbstractClass</span>
<div class="viewcode-block" id="GceHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook">[docs]</a><span class="k">class</span> <span class="nc">GceHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Hook for Google Compute Engine 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"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="GceHook._conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook._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="o">=</span><span class="s1">&#39;v1&#39;</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">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">GceHook</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>
<div class="viewcode-block" id="GceHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.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">&quot;&quot;&quot;</span>
<span class="sd"> Retrieves connection to Google Compute Engine.</span>
<span class="sd"> :return: Google Compute Engine services object</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</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">&#39;compute&#39;</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>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="GceHook.start_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.start_instance">[docs]</a> <span class="k">def</span> <span class="nf">start_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</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">&quot;&quot;&quot;</span>
<span class="sd"> Starts an existing instance defined by project_id, zone and resource_id.</span>
<span class="sd"> Must be called with keyword arguments rather than positional.</span>
<span class="sd"> :param zone: Google Cloud Platform zone where the instance exists</span>
<span class="sd"> :type zone: str</span>
<span class="sd"> :param resource_id: Name of the Compute Engine instance resource</span>
<span class="sd"> :type resource_id: str</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span>
<span class="sd"> Compute Engine Instance exists. If set to None or missing,</span>
<span class="sd"> 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"> &quot;&quot;&quot;</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">instances</span><span class="p">()</span><span class="o">.</span><span class="n">start</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">,</span>
<span class="n">instance</span><span class="o">=</span><span class="n">resource_id</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">try</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">&quot;name&quot;</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Wrong response &#39;</span><span class="si">{}</span><span class="s2">&#39; returned - it should contain &quot;</span>
<span class="s2">&quot;&#39;name&#39; field&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">response</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">project_id</span><span class="o">=</span><span class="n">project_id</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>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</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="GceHook.stop_instance"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.stop_instance">[docs]</a> <span class="k">def</span> <span class="nf">stop_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</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">&quot;&quot;&quot;</span>
<span class="sd"> Stops an instance defined by project_id, zone and resource_id</span>
<span class="sd"> Must be called with keyword arguments rather than positional.</span>
<span class="sd"> :param zone: Google Cloud Platform zone where the instance exists</span>
<span class="sd"> :type zone: str</span>
<span class="sd"> :param resource_id: Name of the Compute Engine instance resource</span>
<span class="sd"> :type resource_id: str</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span>
<span class="sd"> Compute Engine Instance exists. If set to None or missing,</span>
<span class="sd"> 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"> &quot;&quot;&quot;</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">instances</span><span class="p">()</span><span class="o">.</span><span class="n">stop</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">,</span>
<span class="n">instance</span><span class="o">=</span><span class="n">resource_id</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">try</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">&quot;name&quot;</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Wrong response &#39;</span><span class="si">{}</span><span class="s2">&#39; returned - it should contain &quot;</span>
<span class="s2">&quot;&#39;name&#39; field&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">response</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">project_id</span><span class="o">=</span><span class="n">project_id</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>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</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="GceHook.set_machine_type"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.set_machine_type">[docs]</a> <span class="k">def</span> <span class="nf">set_machine_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</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">&quot;&quot;&quot;</span>
<span class="sd"> Sets machine type of an instance defined by project_id, zone and resource_id.</span>
<span class="sd"> Must be called with keyword arguments rather than positional.</span>
<span class="sd"> :param zone: Google Cloud Platform zone where the instance exists.</span>
<span class="sd"> :type zone: str</span>
<span class="sd"> :param resource_id: Name of the Compute Engine instance resource</span>
<span class="sd"> :type resource_id: str</span>
<span class="sd"> :param body: Body required by the Compute Engine setMachineType API,</span>
<span class="sd"> as described in</span>
<span class="sd"> https://cloud.google.com/compute/docs/reference/rest/v1/instances/setMachineType</span>
<span class="sd"> :type body: dict</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span>
<span class="sd"> Compute Engine Instance exists. If set to None or missing,</span>
<span class="sd"> 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"> &quot;&quot;&quot;</span>
<span class="n">response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_execute_set_machine_type</span><span class="p">(</span><span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="p">)</span>
<span class="k">try</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">&quot;name&quot;</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Wrong response &#39;</span><span class="si">{}</span><span class="s2">&#39; returned - it should contain &quot;</span>
<span class="s2">&quot;&#39;name&#39; field&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">response</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">project_id</span><span class="o">=</span><span class="n">project_id</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>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">)</span></div>
<div class="viewcode-block" id="GceHook._execute_set_machine_type"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook._execute_set_machine_type">[docs]</a> <span class="k">def</span> <span class="nf">_execute_set_machine_type</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">project_id</span><span class="p">):</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">instances</span><span class="p">()</span><span class="o">.</span><span class="n">setMachineType</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">,</span> <span class="n">instance</span><span class="o">=</span><span class="n">resource_id</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></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<div class="viewcode-block" id="GceHook.get_instance_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.get_instance_template">[docs]</a> <span class="k">def</span> <span class="nf">get_instance_template</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">resource_id</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">&quot;&quot;&quot;</span>
<span class="sd"> Retrieves instance template by project_id and resource_id.</span>
<span class="sd"> Must be called with keyword arguments rather than positional.</span>
<span class="sd"> :param resource_id: Name of the instance template</span>
<span class="sd"> :type resource_id: str</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span>
<span class="sd"> Compute Engine Instance exists. If set to None or missing,</span>
<span class="sd"> the default project_id from the GCP connection is used.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :return: Instance template representation as object according to</span>
<span class="sd"> https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</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">instanceTemplates</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
<span class="n">instanceTemplate</span><span class="o">=</span><span class="n">resource_id</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">return</span> <span class="n">response</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="GceHook.insert_instance_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.insert_instance_template">[docs]</a> <span class="k">def</span> <span class="nf">insert_instance_template</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">request_id</span><span class="o">=</span><span class="kc">None</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">&quot;&quot;&quot;</span>
<span class="sd"> Inserts instance template using body specified</span>
<span class="sd"> Must be called with keyword arguments rather than positional.</span>
<span class="sd"> :param body: Instance template representation as object according to</span>
<span class="sd"> https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates</span>
<span class="sd"> :type body: dict</span>
<span class="sd"> :param request_id: Optional, unique request_id that you might add to achieve</span>
<span class="sd"> full idempotence (for example when client call times out repeating the request</span>
<span class="sd"> with the same request id will not create a new instance template again)</span>
<span class="sd"> It should be in UUID format as defined in RFC 4122</span>
<span class="sd"> :type request_id: str</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span>
<span class="sd"> Compute Engine Instance exists. If set to None or missing,</span>
<span class="sd"> 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"> &quot;&quot;&quot;</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">instanceTemplates</span><span class="p">()</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
<span class="n">requestId</span><span class="o">=</span><span class="n">request_id</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">try</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">&quot;name&quot;</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Wrong response &#39;</span><span class="si">{}</span><span class="s2">&#39; returned - it should contain &quot;</span>
<span class="s2">&quot;&#39;name&#39; field&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">response</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">project_id</span><span class="o">=</span><span class="n">project_id</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="GceHook.get_instance_group_manager"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.get_instance_group_manager">[docs]</a> <span class="k">def</span> <span class="nf">get_instance_group_manager</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</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">&quot;&quot;&quot;</span>
<span class="sd"> Retrieves Instance Group Manager by project_id, zone and resource_id.</span>
<span class="sd"> Must be called with keyword arguments rather than positional.</span>
<span class="sd"> :param zone: Google Cloud Platform zone where the Instance Group Manager exists</span>
<span class="sd"> :type zone: str</span>
<span class="sd"> :param resource_id: Name of the Instance Group Manager</span>
<span class="sd"> :type resource_id: str</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span>
<span class="sd"> Compute Engine Instance exists. If set to None or missing,</span>
<span class="sd"> the default project_id from the GCP connection is used.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :return: Instance group manager representation as object according to</span>
<span class="sd"> https://cloud.google.com/compute/docs/reference/rest/beta/instanceGroupManagers</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</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">instanceGroupManagers</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">,</span>
<span class="n">instanceGroupManager</span><span class="o">=</span><span class="n">resource_id</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">return</span> <span class="n">response</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="GceHook.patch_instance_group_manager"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook.patch_instance_group_manager">[docs]</a> <span class="k">def</span> <span class="nf">patch_instance_group_manager</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</span><span class="p">,</span>
<span class="n">body</span><span class="p">,</span> <span class="n">request_id</span><span class="o">=</span><span class="kc">None</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">&quot;&quot;&quot;</span>
<span class="sd"> Patches Instance Group Manager with the specified body.</span>
<span class="sd"> Must be called with keyword arguments rather than positional.</span>
<span class="sd"> :param zone: Google Cloud Platform zone where the Instance Group Manager exists</span>
<span class="sd"> :type zone: str</span>
<span class="sd"> :param resource_id: Name of the Instance Group Manager</span>
<span class="sd"> :type resource_id: str</span>
<span class="sd"> :param body: Instance Group Manager representation as json-merge-patch object</span>
<span class="sd"> according to</span>
<span class="sd"> https://cloud.google.com/compute/docs/reference/rest/beta/instanceTemplates/patch</span>
<span class="sd"> :type body: dict</span>
<span class="sd"> :param request_id: Optional, unique request_id that you might add to achieve</span>
<span class="sd"> full idempotence (for example when client call times out repeating the request</span>
<span class="sd"> with the same request id will not create a new instance template again).</span>
<span class="sd"> It should be in UUID format as defined in RFC 4122</span>
<span class="sd"> :type request_id: str</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform project ID where the</span>
<span class="sd"> Compute Engine Instance exists. If set to None or missing,</span>
<span class="sd"> 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"> &quot;&quot;&quot;</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">instanceGroupManagers</span><span class="p">()</span><span class="o">.</span><span class="n">patch</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">,</span>
<span class="n">instanceGroupManager</span><span class="o">=</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span>
<span class="n">requestId</span><span class="o">=</span><span class="n">request_id</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">try</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">&quot;name&quot;</span><span class="p">]</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;Wrong response &#39;</span><span class="si">{}</span><span class="s2">&#39; returned - it should contain &quot;</span>
<span class="s2">&quot;&#39;name&#39; field&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">response</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">project_id</span><span class="o">=</span><span class="n">project_id</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>
<span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">)</span></div>
<div class="viewcode-block" id="GceHook._wait_for_operation_to_complete"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook._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">project_id</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">zone</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Waits for the named operation to complete - checks status of the async call.</span>
<span class="sd"> :param operation_name: name of the operation</span>
<span class="sd"> :type operation_name: str</span>
<span class="sd"> :param zone: optional region of the request (might be None for global operations)</span>
<span class="sd"> :type zone: str</span>
<span class="sd"> :return: None</span>
<span class="sd"> &quot;&quot;&quot;</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="k">if</span> <span class="n">zone</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># noinspection PyTypeChecker</span>
<span class="n">operation_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_global_operation_status</span><span class="p">(</span>
<span class="n">service</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">project_id</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># noinspection PyTypeChecker</span>
<span class="n">operation_response</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_zone_operation_status</span><span class="p">(</span>
<span class="n">service</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">zone</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">&quot;status&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="n">GceOperationStatus</span><span class="o">.</span><span class="n">DONE</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">&quot;error&quot;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">error</span><span class="p">:</span>
<span class="n">code</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">&quot;httpErrorStatusCode&quot;</span><span class="p">)</span>
<span class="n">msg</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">&quot;httpErrorMessage&quot;</span><span class="p">)</span>
<span class="c1"># Extracting the errors list as string and trimming square braces</span>
<span class="n">error_msg</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">error</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;errors&quot;</span><span class="p">))[</span><span class="mi">1</span><span class="p">:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">{}</span><span class="s2"> </span><span class="si">{}</span><span class="s2">: &quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">code</span><span class="p">,</span> <span class="n">msg</span><span class="p">)</span> <span class="o">+</span> <span class="n">error_msg</span><span class="p">)</span>
<span class="c1"># No meaningful info to return from the response in case of success</span>
<span class="k">return</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>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="GceHook._check_zone_operation_status"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook._check_zone_operation_status">[docs]</a> <span class="k">def</span> <span class="nf">_check_zone_operation_status</span><span class="p">(</span><span class="n">service</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">project_id</span><span class="p">,</span> <span class="n">zone</span><span class="p">):</span>
<span class="k">return</span> <span class="n">service</span><span class="o">.</span><span class="n">zoneOperations</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">zone</span><span class="o">=</span><span class="n">zone</span><span class="p">,</span> <span class="n">operation</span><span class="o">=</span><span class="n">operation_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">@staticmethod</span>
<div class="viewcode-block" id="GceHook._check_global_operation_status"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_compute_hook/index.html#airflow.contrib.hooks.gcp_compute_hook.GceHook._check_global_operation_status">[docs]</a> <span class="k">def</span> <span class="nf">_check_global_operation_status</span><span class="p">(</span><span class="n">service</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">project_id</span><span class="p">):</span>
<span class="k">return</span> <span class="n">service</span><span class="o">.</span><span class="n">globalOperations</span><span class="p">()</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="n">project</span><span class="o">=</span><span class="n">project_id</span><span class="p">,</span> <span class="n">operation</span><span class="o">=</span><span class="n">operation_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></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>