Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.3 / _modules / airflow / contrib / operators / gcp_compute_operator.html
blob: 72e4f79e15562bd8a31afc15f2dd545fce1fdc2a [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_compute_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_compute_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_compute_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">from</span> <span class="nn">copy</span> <span class="k">import</span> <span class="n">deepcopy</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.hooks.gcp_compute_hook</span> <span class="k">import</span> <span class="n">GceHook</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.utils.gcp_field_sanitizer</span> <span class="k">import</span> <span class="n">GcpBodyFieldSanitizer</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="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span>
<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
<span class="kn">from</span> <span class="nn">json_merge_patch</span> <span class="k">import</span> <span class="n">merge</span>
<div class="viewcode-block" id="GceBaseOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceBaseOperator">[docs]</a><span class="k">class</span> <span class="nc">GceBaseOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Abstract base operator for Google Compute Engine operators to inherit from.</span>
<span class="sd"> &quot;&quot;&quot;</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">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="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">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">zone</span> <span class="o">=</span> <span class="n">zone</span>
<span class="bp">self</span><span class="o">.</span><span class="n">resource_id</span> <span class="o">=</span> <span class="n">resource_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_hook</span> <span class="o">=</span> <span class="n">GceHook</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">GceBaseOperator</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="GceBaseOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceBaseOperator._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="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">==</span> <span class="s1">&#39;&#39;</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;project_id&#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">zone</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;zone&#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">resource_id</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;resource_id&#39; is missing&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="GceBaseOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceBaseOperator.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">pass</span></div></div>
<div class="viewcode-block" id="GceInstanceStartOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceStartOperator">[docs]</a><span class="k">class</span> <span class="nc">GceInstanceStartOperator</span><span class="p">(</span><span class="n">GceBaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Starts an instance in Google Compute Engine.</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:GceInstanceStartOperator`</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 Compute</span>
<span class="sd"> Engine Instance exists. If set to None or missing, the default project_id from the GCP connection is</span>
<span class="sd"> used.</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. Defaults to &#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 - or beta). Defaults</span>
<span class="sd"> to v1.</span>
<span class="sd"> :type api_version: str</span>
<span class="sd"> :param validate_body: Optional, If set to False, body validation is not performed.</span>
<span class="sd"> Defaults to False.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gce_instance_start_template_fields]</span>
<div class="viewcode-block" id="GceInstanceStartOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceStartOperator.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;zone&#39;</span><span class="p">,</span> <span class="s1">&#39;resource_id&#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 gce_instance_start_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">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="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="nb">super</span><span class="p">(</span><span class="n">GceInstanceStartOperator</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">project_id</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">resource_id</span><span class="o">=</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">gcp_conn_id</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="n">api_version</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="GceInstanceStartOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceStartOperator.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">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">start_instance</span><span class="p">(</span><span class="n">zone</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span>
<span class="n">resource_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="GceInstanceStopOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceStopOperator">[docs]</a><span class="k">class</span> <span class="nc">GceInstanceStopOperator</span><span class="p">(</span><span class="n">GceBaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Stops an instance in Google Compute Engine.</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:GceInstanceStopOperator`</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 Compute</span>
<span class="sd"> Engine Instance exists. If set to None or missing, the default project_id from the GCP connection is</span>
<span class="sd"> used.</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. Defaults to &#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 - or beta). Defaults</span>
<span class="sd"> to v1.</span>
<span class="sd"> :type api_version: str</span>
<span class="sd"> :param validate_body: Optional, If set to False, body validation is not performed.</span>
<span class="sd"> Defaults to False.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gce_instance_stop_template_fields]</span>
<div class="viewcode-block" id="GceInstanceStopOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceStopOperator.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;zone&#39;</span><span class="p">,</span> <span class="s1">&#39;resource_id&#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 gce_instance_stop_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">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="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="nb">super</span><span class="p">(</span><span class="n">GceInstanceStopOperator</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">project_id</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">resource_id</span><span class="o">=</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">gcp_conn_id</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="n">api_version</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="GceInstanceStopOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceStopOperator.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="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">stop_instance</span><span class="p">(</span><span class="n">zone</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span>
<span class="n">resource_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="SET_MACHINE_TYPE_VALIDATION_SPECIFICATION"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.SET_MACHINE_TYPE_VALIDATION_SPECIFICATION">[docs]</a><span class="n">SET_MACHINE_TYPE_VALIDATION_SPECIFICATION</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;machineType&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></div>
<span class="p">]</span>
<div class="viewcode-block" id="GceSetMachineTypeOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceSetMachineTypeOperator">[docs]</a><span class="k">class</span> <span class="nc">GceSetMachineTypeOperator</span><span class="p">(</span><span class="n">GceBaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Changes the machine type for a stopped instance to the machine type specified in</span>
<span class="sd"> the request.</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:GceSetMachineTypeOperator`</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, as described in</span>
<span class="sd"> https://cloud.google.com/compute/docs/reference/rest/v1/instances/setMachineType#request-body</span>
<span class="sd"> :type body: dict</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform Project ID where the Compute</span>
<span class="sd"> Engine Instance exists. If set to None or missing, the default project_id from the GCP connection</span>
<span class="sd"> is used.</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. Defaults to &#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 - or beta). Defaults</span>
<span class="sd"> to v1.</span>
<span class="sd"> :type api_version: str</span>
<span class="sd"> :param validate_body: Optional, If set to False, body validation is not performed.</span>
<span class="sd"> Defaults to False.</span>
<span class="sd"> :type validate_body: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gce_instance_set_machine_type_template_fields]</span>
<div class="viewcode-block" id="GceSetMachineTypeOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceSetMachineTypeOperator.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;zone&#39;</span><span class="p">,</span> <span class="s1">&#39;resource_id&#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 gce_instance_set_machine_type_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">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="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">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">body</span> <span class="o">=</span> <span class="n">body</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">SET_MACHINE_TYPE_VALIDATION_SPECIFICATION</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="nb">super</span><span class="p">(</span><span class="n">GceSetMachineTypeOperator</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">project_id</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">resource_id</span><span class="o">=</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">gcp_conn_id</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="n">api_version</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="GceSetMachineTypeOperator._validate_all_body_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceSetMachineTypeOperator._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="GceSetMachineTypeOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceSetMachineTypeOperator.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="bp">self</span><span class="o">.</span><span class="n">_validate_all_body_fields</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">set_machine_type</span><span class="p">(</span><span class="n">zone</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span>
<span class="n">resource_id</span><span class="o">=</span><span class="bp">self</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="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="GCE_INSTANCE_TEMPLATE_VALIDATION_PATCH_SPECIFICATION"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GCE_INSTANCE_TEMPLATE_VALIDATION_PATCH_SPECIFICATION">[docs]</a><span class="n">GCE_INSTANCE_TEMPLATE_VALIDATION_PATCH_SPECIFICATION</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">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;properties&quot;</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="s1">&#39;dict&#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="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;description&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;tags&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;items&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="p">]),</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;machineType&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;canIpForward&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;networkInterfaces&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="c1"># not validating deeper</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;disks&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="c1"># not validating the array deeper</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;metadata&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;fingerprint&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;items&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;kind&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="p">]),</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;serviceAccounts&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="c1"># not validating deeper</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;scheduling&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;onHostMaintenance&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;automaticRestart&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;preemptible&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;nodeAffinitites&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="c1"># not validating deeper</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;guestAccelerators&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="c1"># not validating deeper</span>
<span class="nb">dict</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;minCpuPlatform&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>
<div class="viewcode-block" id="GCE_INSTANCE_TEMPLATE_FIELDS_TO_SANITIZE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GCE_INSTANCE_TEMPLATE_FIELDS_TO_SANITIZE">[docs]</a><span class="n">GCE_INSTANCE_TEMPLATE_FIELDS_TO_SANITIZE</span> <span class="o">=</span> <span class="p">[</span>
<span class="s2">&quot;kind&quot;</span><span class="p">,</span>
<span class="s2">&quot;id&quot;</span><span class="p">,</span>
<span class="s2">&quot;name&quot;</span><span class="p">,</span>
<span class="s2">&quot;creationTimestamp&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.disks.sha256&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.disks.kind&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.disks.sourceImageEncryptionKey.sha256&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.disks.index&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.disks.licenses&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.networkInterfaces.kind&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.networkInterfaces.accessConfigs.kind&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.networkInterfaces.name&quot;</span><span class="p">,</span>
<span class="s2">&quot;properties.metadata.kind&quot;</span><span class="p">,</span>
<span class="s2">&quot;selfLink&quot;</span></div>
<span class="p">]</span>
<div class="viewcode-block" id="GceInstanceTemplateCopyOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceTemplateCopyOperator">[docs]</a><span class="k">class</span> <span class="nc">GceInstanceTemplateCopyOperator</span><span class="p">(</span><span class="n">GceBaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Copies the instance template, applying specified changes.</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:GceInstanceTemplateCopyOperator`</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 body_patch: Patch to the body of instanceTemplates object following rfc7386</span>
<span class="sd"> PATCH semantics. The body_patch content follows</span>
<span class="sd"> https://cloud.google.com/compute/docs/reference/rest/v1/instanceTemplates</span>
<span class="sd"> Name field is required as we need to rename the template,</span>
<span class="sd"> all the other fields are optional. It is important to follow PATCH semantics</span>
<span class="sd"> - arrays are replaced fully, so if you need to update an array you should</span>
<span class="sd"> provide the whole target array as patch element.</span>
<span class="sd"> :type body_patch: dict</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform Project ID where the Compute</span>
<span class="sd"> Engine Instance exists. If set to None or missing, the default project_id from the GCP connection</span>
<span class="sd"> is used.</span>
<span class="sd"> :type project_id: str</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 gcp_conn_id: Optional, The connection ID used to connect to Google Cloud</span>
<span class="sd"> Platform. Defaults to &#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 - or beta). Defaults</span>
<span class="sd"> to v1.</span>
<span class="sd"> :type api_version: str</span>
<span class="sd"> :param validate_body: Optional, If set to False, body validation is not performed.</span>
<span class="sd"> Defaults to False.</span>
<span class="sd"> :type validate_body: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gce_instance_template_copy_operator_template_fields]</span>
<div class="viewcode-block" id="GceInstanceTemplateCopyOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceTemplateCopyOperator.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;resource_id&#39;</span><span class="p">,</span> <span class="s1">&#39;request_id&#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 gce_instance_template_copy_operator_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">resource_id</span><span class="p">,</span>
<span class="n">body_patch</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">request_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">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">body_patch</span> <span class="o">=</span> <span class="n">body_patch</span>
<span class="bp">self</span><span class="o">.</span><span class="n">request_id</span> <span class="o">=</span> <span class="n">request_id</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="s1">&#39;name&#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_patch</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;The body &#39;</span><span class="si">{}</span><span class="s2">&#39; should contain at least &quot;</span>
<span class="s2">&quot;name for the new operator in the &#39;name&#39; field&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="n">body_patch</span><span class="p">))</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">GCE_INSTANCE_TEMPLATE_VALIDATION_PATCH_SPECIFICATION</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">_field_sanitizer</span> <span class="o">=</span> <span class="n">GcpBodyFieldSanitizer</span><span class="p">(</span>
<span class="n">GCE_INSTANCE_TEMPLATE_FIELDS_TO_SANITIZE</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GceInstanceTemplateCopyOperator</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">project_id</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="s1">&#39;global&#39;</span><span class="p">,</span> <span class="n">resource_id</span><span class="o">=</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">gcp_conn_id</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="n">api_version</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="GceInstanceTemplateCopyOperator._validate_all_body_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceTemplateCopyOperator._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_patch</span><span class="p">)</span></div>
<div class="viewcode-block" id="GceInstanceTemplateCopyOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceTemplateCopyOperator.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="bp">self</span><span class="o">.</span><span class="n">_validate_all_body_fields</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># Idempotence check (sort of) - we want to check if the new template</span>
<span class="c1"># is already created and if is, then we assume it was created by previous run</span>
<span class="c1"># of CopyTemplate operator - we do not check if content of the template</span>
<span class="c1"># is as expected. Templates are immutable so we cannot update it anyway</span>
<span class="c1"># and deleting/recreating is not worth the hassle especially</span>
<span class="c1"># that we cannot delete template if it is already used in some Instance</span>
<span class="c1"># Group Manager. We assume success if the template is simply present</span>
<span class="n">existing_template</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_instance_template</span><span class="p">(</span>
<span class="n">resource_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body_patch</span><span class="p">[</span><span class="s1">&#39;name&#39;</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="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="s2">&quot;The </span><span class="si">%s</span><span class="s2"> template already existed. It was likely created by previous run of the operator. &quot;</span>
<span class="s2">&quot;Assuming success.&quot;</span><span class="p">,</span>
<span class="n">existing_template</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">existing_template</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="c1"># We actually expect to get 404 / Not Found here as the template should</span>
<span class="c1"># not yet exist</span>
<span class="k">if</span> <span class="ow">not</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="o">==</span> <span class="mi">404</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">e</span>
<span class="n">old_body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_instance_template</span><span class="p">(</span><span class="n">resource_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">resource_id</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">new_body</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">old_body</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_field_sanitizer</span><span class="o">.</span><span class="n">sanitize</span><span class="p">(</span><span class="n">new_body</span><span class="p">)</span>
<span class="n">new_body</span> <span class="o">=</span> <span class="n">merge</span><span class="p">(</span><span class="n">new_body</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">body_patch</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="s2">&quot;Calling insert instance template with updated body: </span><span class="si">%s</span><span class="s2">&quot;</span><span class="p">,</span> <span class="n">new_body</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">insert_instance_template</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="n">new_body</span><span class="p">,</span>
<span class="n">request_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">request_id</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="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_instance_template</span><span class="p">(</span><span class="n">resource_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body_patch</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">],</span>
<span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="GceInstanceGroupManagerUpdateTemplateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceGroupManagerUpdateTemplateOperator">[docs]</a><span class="k">class</span> <span class="nc">GceInstanceGroupManagerUpdateTemplateOperator</span><span class="p">(</span><span class="n">GceBaseOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Patches the Instance Group Manager, replacing source template URL with the</span>
<span class="sd"> destination one. API V1 does not have update/patch operations for Instance</span>
<span class="sd"> Group Manager, so you must use beta or newer API version. Beta is the default.</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:GceInstanceGroupManagerUpdateTemplateOperator`</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 zone: Google Cloud Platform zone where the Instance Group Manager exists.</span>
<span class="sd"> :type zone: str</span>
<span class="sd"> :param source_template: URL of the template to replace.</span>
<span class="sd"> :type source_template: str</span>
<span class="sd"> :param destination_template: URL of the target template.</span>
<span class="sd"> :type destination_template: str</span>
<span class="sd"> :param project_id: Optional, Google Cloud Platform Project ID where the Compute</span>
<span class="sd"> Engine Instance exists. If set to None or missing, the default project_id from the GCP connection is</span>
<span class="sd"> used.</span>
<span class="sd"> :type project_id: str</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 gcp_conn_id: Optional, The connection ID used to connect to Google Cloud</span>
<span class="sd"> Platform. Defaults to &#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 - or beta). Defaults</span>
<span class="sd"> to v1.</span>
<span class="sd"> :type api_version: str</span>
<span class="sd"> :param validate_body: Optional, If set to False, body validation is not performed.</span>
<span class="sd"> Defaults to False.</span>
<span class="sd"> :type validate_body: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="c1"># [START gce_igm_update_template_operator_template_fields]</span>
<div class="viewcode-block" id="GceInstanceGroupManagerUpdateTemplateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceGroupManagerUpdateTemplateOperator.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;resource_id&#39;</span><span class="p">,</span> <span class="s1">&#39;zone&#39;</span><span class="p">,</span> <span class="s1">&#39;request_id&#39;</span><span class="p">,</span>
<span class="s1">&#39;source_template&#39;</span><span class="p">,</span> <span class="s1">&#39;destination_template&#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 gce_igm_update_template_operator_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">resource_id</span><span class="p">,</span>
<span class="n">zone</span><span class="p">,</span>
<span class="n">source_template</span><span class="p">,</span>
<span class="n">destination_template</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">update_policy</span><span class="o">=</span><span class="kc">None</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">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;beta&#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">zone</span> <span class="o">=</span> <span class="n">zone</span>
<span class="bp">self</span><span class="o">.</span><span class="n">source_template</span> <span class="o">=</span> <span class="n">source_template</span>
<span class="bp">self</span><span class="o">.</span><span class="n">destination_template</span> <span class="o">=</span> <span class="n">destination_template</span>
<span class="bp">self</span><span class="o">.</span><span class="n">request_id</span> <span class="o">=</span> <span class="n">request_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">update_policy</span> <span class="o">=</span> <span class="n">update_policy</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_change_performed</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">if</span> <span class="n">api_version</span> <span class="o">==</span> <span class="s1">&#39;v1&#39;</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;Api version v1 does not have update/patch &quot;</span>
<span class="s2">&quot;operations for Instance Group Managers. Use beta&quot;</span>
<span class="s2">&quot; api version or above&quot;</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GceInstanceGroupManagerUpdateTemplateOperator</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">project_id</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="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</span><span class="o">=</span><span class="n">resource_id</span><span class="p">,</span>
<span class="n">gcp_conn_id</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="n">api_version</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="GceInstanceGroupManagerUpdateTemplateOperator._possibly_replace_template"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceGroupManagerUpdateTemplateOperator._possibly_replace_template">[docs]</a> <span class="k">def</span> <span class="nf">_possibly_replace_template</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">dictionary</span><span class="p">):</span>
<span class="c1"># type: (dict) -&gt; None</span>
<span class="k">if</span> <span class="n">dictionary</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;instanceTemplate&#39;</span><span class="p">)</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">source_template</span><span class="p">:</span>
<span class="n">dictionary</span><span class="p">[</span><span class="s1">&#39;instanceTemplate&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">destination_template</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_change_performed</span> <span class="o">=</span> <span class="kc">True</span></div>
<div class="viewcode-block" id="GceInstanceGroupManagerUpdateTemplateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_compute_operator/index.html#airflow.contrib.operators.gcp_compute_operator.GceInstanceGroupManagerUpdateTemplateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="n">old_instance_group_manager</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_hook</span><span class="o">.</span><span class="n">get_instance_group_manager</span><span class="p">(</span>
<span class="n">zone</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">resource_id</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">patch_body</span> <span class="o">=</span> <span class="p">{}</span>
<span class="k">if</span> <span class="s1">&#39;versions&#39;</span> <span class="ow">in</span> <span class="n">old_instance_group_manager</span><span class="p">:</span>
<span class="n">patch_body</span><span class="p">[</span><span class="s1">&#39;versions&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">old_instance_group_manager</span><span class="p">[</span><span class="s1">&#39;versions&#39;</span><span class="p">]</span>
<span class="k">if</span> <span class="s1">&#39;instanceTemplate&#39;</span> <span class="ow">in</span> <span class="n">old_instance_group_manager</span><span class="p">:</span>
<span class="n">patch_body</span><span class="p">[</span><span class="s1">&#39;instanceTemplate&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="n">old_instance_group_manager</span><span class="p">[</span><span class="s1">&#39;instanceTemplate&#39;</span><span class="p">]</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">update_policy</span><span class="p">:</span>
<span class="n">patch_body</span><span class="p">[</span><span class="s1">&#39;updatePolicy&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">update_policy</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_possibly_replace_template</span><span class="p">(</span><span class="n">patch_body</span><span class="p">)</span>
<span class="k">if</span> <span class="s1">&#39;versions&#39;</span> <span class="ow">in</span> <span class="n">patch_body</span><span class="p">:</span>
<span class="k">for</span> <span class="n">version</span> <span class="ow">in</span> <span class="n">patch_body</span><span class="p">[</span><span class="s1">&#39;versions&#39;</span><span class="p">]:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_possibly_replace_template</span><span class="p">(</span><span class="n">version</span><span class="p">)</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_change_performed</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">update_policy</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="s2">&quot;Calling patch instance template with updated body: </span><span class="si">{}</span><span class="s2">&quot;</span><span class="o">.</span>
<span class="nb">format</span><span class="p">(</span><span class="n">patch_body</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">patch_instance_group_manager</span><span class="p">(</span>
<span class="n">zone</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">zone</span><span class="p">,</span> <span class="n">resource_id</span><span class="o">=</span><span class="bp">self</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">patch_body</span><span class="p">,</span> <span class="n">request_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">request_id</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="k">else</span><span class="p">:</span>
<span class="c1"># Idempotence achieved</span>
<span class="k">return</span> <span class="kc">True</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>