blob: 675bd78d50f440411d40f9b7a1edbae840182eeb [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.example_dags.example_gcp_transfer &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>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-140539454-1']);
_gaq.push(['_trackPageview']);
</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.5
</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 Reference</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">REST API Reference</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">Python API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../privacy_notice.html">Privacy Notice</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>airflow.contrib.example_dags.example_gcp_transfer</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.example_dags.example_gcp_transfer</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="sd">&quot;&quot;&quot;</span>
<span class="sd">Example Airflow DAG that demonstrates interactions with Google Cloud Transfer.</span>
<span class="sd">This DAG relies on the following OS environment variables</span>
<span class="sd">* GCP_PROJECT_ID - Google Cloud Project to use for the Google Cloud Transfer Service.</span>
<span class="sd">* GCP_DESCRIPTION - Description of transfer job</span>
<span class="sd">* GCP_TRANSFER_SOURCE_AWS_BUCKET - Amazon Web Services Storage bucket from which files are copied.</span>
<span class="sd"> .. warning::</span>
<span class="sd"> You need to provide a large enough set of data so that operations do not execute too quickly.</span>
<span class="sd"> Otherwise, DAG will fail.</span>
<span class="sd">* GCP_TRANSFER_FIRST_TARGET_BUCKET - Google Cloud Storage bucket to which files are copied from AWS.</span>
<span class="sd"> It is also a source bucket in next step</span>
<span class="sd">* GCP_TRANSFER_SECOND_TARGET_BUCKET - Google Cloud Storage bucket bucket to which files are copied</span>
<span class="sd">* WAIT_FOR_OPERATION_POKE_INTERVAL - interval of what to check the status of the operation</span>
<span class="sd"> A smaller value than the default value accelerates the system test and ensures its correct execution with</span>
<span class="sd"> smaller quantities of files in the source bucket</span>
<span class="sd"> Look at documentation of :class:`~airflow.operators.sensors.BaseSensorOperator` for more information</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span><span class="p">,</span> <span class="n">timedelta</span>
<span class="kn">from</span> <span class="nn">typing</span> <span class="k">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Dict</span>
<span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">models</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_transfer_hook</span> <span class="k">import</span> <span class="p">(</span>
<span class="n">GcpTransferOperationStatus</span><span class="p">,</span>
<span class="n">GcpTransferJobsStatus</span><span class="p">,</span>
<span class="n">TRANSFER_OPTIONS</span><span class="p">,</span>
<span class="n">PROJECT_ID</span><span class="p">,</span>
<span class="n">BUCKET_NAME</span><span class="p">,</span>
<span class="n">GCS_DATA_SINK</span><span class="p">,</span>
<span class="n">STATUS</span><span class="p">,</span>
<span class="n">DESCRIPTION</span><span class="p">,</span>
<span class="n">GCS_DATA_SOURCE</span><span class="p">,</span>
<span class="n">START_TIME_OF_DAY</span><span class="p">,</span>
<span class="n">SCHEDULE_END_DATE</span><span class="p">,</span>
<span class="n">SCHEDULE_START_DATE</span><span class="p">,</span>
<span class="n">SCHEDULE</span><span class="p">,</span>
<span class="n">AWS_S3_DATA_SOURCE</span><span class="p">,</span>
<span class="n">TRANSFER_SPEC</span><span class="p">,</span>
<span class="n">FILTER_PROJECT_ID</span><span class="p">,</span>
<span class="n">FILTER_JOB_NAMES</span><span class="p">,</span>
<span class="n">TRANSFER_JOB</span><span class="p">,</span>
<span class="n">TRANSFER_JOB_FIELD_MASK</span><span class="p">,</span>
<span class="n">ALREADY_EXISTING_IN_SINK</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.operators.gcp_transfer_operator</span> <span class="k">import</span> <span class="p">(</span>
<span class="n">GcpTransferServiceJobCreateOperator</span><span class="p">,</span>
<span class="n">GcpTransferServiceJobDeleteOperator</span><span class="p">,</span>
<span class="n">GcpTransferServiceJobUpdateOperator</span><span class="p">,</span>
<span class="n">GcpTransferServiceOperationsListOperator</span><span class="p">,</span>
<span class="n">GcpTransferServiceOperationGetOperator</span><span class="p">,</span>
<span class="n">GcpTransferServiceOperationPauseOperator</span><span class="p">,</span>
<span class="n">GcpTransferServiceOperationResumeOperator</span><span class="p">,</span>
<span class="n">GcpTransferServiceOperationCancelOperator</span><span class="p">,</span>
<span class="p">)</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.sensors.gcp_transfer_sensor</span> <span class="k">import</span> <span class="n">GCPTransferServiceWaitForJobStatusSensor</span>
<span class="kn">from</span> <span class="nn">airflow.utils.dates</span> <span class="k">import</span> <span class="n">days_ago</span>
<span class="c1"># [START howto_operator_gcp_transfer_common_variables]</span>
<span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_PROJECT_ID&#39;</span><span class="p">,</span> <span class="s1">&#39;example-project&#39;</span><span class="p">)</span>
<span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_DESCRIPTION&#39;</span><span class="p">,</span> <span class="s1">&#39;description&#39;</span><span class="p">)</span>
<span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_TRANSFER_TARGET_BUCKET&#39;</span><span class="p">)</span>
<span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;WAIT_FOR_OPERATION_POKE_INTERVAL&#39;</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span>
<span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;GCP_TRANSFER_SOURCE_AWS_BUCKET&#39;</span><span class="p">)</span>
<span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s1">&#39;GCP_TRANSFER_FIRST_TARGET_BUCKET&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp-transfer-first-target&#39;</span>
<span class="p">)</span>
<span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span>
<span class="s1">&#39;GCP_TRANSFER_SECOND_TARGET_BUCKET&#39;</span><span class="p">,</span> <span class="s1">&#39;gcp-transfer-second-target&#39;</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_common_variables]</span>
<span class="c1"># [START howto_operator_gcp_transfer_create_job_body_aws]</span>
<span class="n">aws_to_gcs_transfer_body</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">DESCRIPTION</span><span class="p">:</span> <span class="n">GCP_DESCRIPTION</span><span class="p">,</span>
<span class="n">STATUS</span><span class="p">:</span> <span class="n">GcpTransferJobsStatus</span><span class="o">.</span><span class="n">ENABLED</span><span class="p">,</span>
<span class="n">PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="n">SCHEDULE</span><span class="p">:</span> <span class="p">{</span>
<span class="n">SCHEDULE_START_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2015</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span>
<span class="n">SCHEDULE_END_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2030</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span>
<span class="n">START_TIME_OF_DAY</span><span class="p">:</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span>
<span class="p">},</span>
<span class="n">TRANSFER_SPEC</span><span class="p">:</span> <span class="p">{</span>
<span class="n">AWS_S3_DATA_SOURCE</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span><span class="p">},</span>
<span class="n">GCS_DATA_SINK</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span><span class="p">},</span>
<span class="n">TRANSFER_OPTIONS</span><span class="p">:</span> <span class="p">{</span><span class="n">ALREADY_EXISTING_IN_SINK</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span>
<span class="p">},</span>
<span class="p">}</span>
<span class="c1"># [END howto_operator_gcp_transfer_create_job_body_aws]</span>
<span class="c1"># [START howto_operator_gcp_transfer_create_job_body_gcp]</span>
<span class="n">gcs_to_gcs_transfer_body</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">DESCRIPTION</span><span class="p">:</span> <span class="n">GCP_DESCRIPTION</span><span class="p">,</span>
<span class="n">STATUS</span><span class="p">:</span> <span class="n">GcpTransferJobsStatus</span><span class="o">.</span><span class="n">ENABLED</span><span class="p">,</span>
<span class="n">PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="n">SCHEDULE</span><span class="p">:</span> <span class="p">{</span>
<span class="n">SCHEDULE_START_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2015</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span>
<span class="n">SCHEDULE_END_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2030</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span>
<span class="n">START_TIME_OF_DAY</span><span class="p">:</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span>
<span class="p">},</span>
<span class="n">TRANSFER_SPEC</span><span class="p">:</span> <span class="p">{</span>
<span class="n">GCS_DATA_SOURCE</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span><span class="p">},</span>
<span class="n">GCS_DATA_SINK</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span><span class="p">},</span>
<span class="n">TRANSFER_OPTIONS</span><span class="p">:</span> <span class="p">{</span><span class="n">ALREADY_EXISTING_IN_SINK</span><span class="p">:</span> <span class="kc">True</span><span class="p">},</span>
<span class="p">},</span>
<span class="p">}</span> <span class="c1"># type: Dict[str, Any]</span>
<span class="c1"># [END howto_operator_gcp_transfer_create_job_body_gcp]</span>
<span class="c1"># [START howto_operator_gcp_transfer_update_job_body]</span>
<span class="n">update_body</span> <span class="o">=</span> <span class="p">{</span>
<span class="n">PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="n">TRANSFER_JOB</span><span class="p">:</span> <span class="p">{</span><span class="n">DESCRIPTION</span><span class="p">:</span> <span class="s2">&quot;</span><span class="si">{}</span><span class="s2">_updated&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">GCP_DESCRIPTION</span><span class="p">)},</span>
<span class="n">TRANSFER_JOB_FIELD_MASK</span><span class="p">:</span> <span class="s2">&quot;description&quot;</span><span class="p">,</span>
<span class="p">}</span>
<span class="c1"># [END howto_operator_gcp_transfer_update_job_body]</span>
<span class="n">list_filter_dict</span> <span class="o">=</span> <span class="p">{</span><span class="n">FILTER_PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span> <span class="n">FILTER_JOB_NAMES</span><span class="p">:</span> <span class="p">[]}</span>
<span class="c1"># [START howto_operator_gcp_transfer_default_args]</span>
<span class="n">default_args</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;start_date&#39;</span><span class="p">:</span> <span class="n">days_ago</span><span class="p">(</span><span class="mi">1</span><span class="p">)}</span>
<span class="c1"># [END howto_operator_gcp_transfer_default_args]</span>
<span class="k">with</span> <span class="n">models</span><span class="o">.</span><span class="n">DAG</span><span class="p">(</span>
<span class="s1">&#39;example_gcp_transfer&#39;</span><span class="p">,</span> <span class="n">default_args</span><span class="o">=</span><span class="n">default_args</span><span class="p">,</span> <span class="n">schedule_interval</span><span class="o">=</span><span class="kc">None</span> <span class="c1"># Override to match your needs</span>
<span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span>
<span class="c1"># [START howto_operator_gcp_transfer_create_job]</span>
<span class="n">create_transfer_job_from_aws</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobCreateOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;create_transfer_job_from_aws&quot;</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">aws_to_gcs_transfer_body</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_create_job]</span>
<span class="n">wait_for_operation_to_start</span> <span class="o">=</span> <span class="n">GCPTransferServiceWaitForJobStatusSensor</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;wait_for_operation_to_start&quot;</span><span class="p">,</span>
<span class="n">job_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;create_transfer_job_from_aws&#39;)[&#39;name&#39;]}}&quot;</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="n">expected_statuses</span><span class="o">=</span><span class="p">{</span><span class="n">GcpTransferOperationStatus</span><span class="o">.</span><span class="n">IN_PROGRESS</span><span class="p">},</span>
<span class="n">poke_interval</span><span class="o">=</span><span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># [START howto_operator_gcp_transfer_pause_operation]</span>
<span class="n">pause_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationPauseOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;pause_operation&quot;</span><span class="p">,</span>
<span class="n">operation_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;wait_for_operation_to_start&#39;, &quot;</span>
<span class="s2">&quot;key=&#39;sensed_operations&#39;)[0][&#39;name&#39;]}}&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_pause_operation]</span>
<span class="c1"># [START howto_operator_gcp_transfer_update_job]</span>
<span class="n">update_job</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobUpdateOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;update_job&quot;</span><span class="p">,</span>
<span class="n">job_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;create_transfer_job_from_aws&#39;)[&#39;name&#39;]}}&quot;</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="n">update_body</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_update_job]</span>
<span class="c1"># [START howto_operator_gcp_transfer_list_operations]</span>
<span class="n">list_operations</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationsListOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;list_operations&quot;</span><span class="p">,</span>
<span class="nb">filter</span><span class="o">=</span><span class="p">{</span>
<span class="n">FILTER_PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="n">FILTER_JOB_NAMES</span><span class="p">:</span> <span class="p">[</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;create_transfer_job_from_aws&#39;)[&#39;name&#39;]}}&quot;</span><span class="p">],</span>
<span class="p">},</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_list_operations]</span>
<span class="c1"># [START howto_operator_gcp_transfer_get_operation]</span>
<span class="n">get_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationGetOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;get_operation&quot;</span><span class="p">,</span> <span class="n">operation_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;list_operations&#39;)[0][&#39;name&#39;]}}&quot;</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_get_operation]</span>
<span class="c1"># [START howto_operator_gcp_transfer_resume_operation]</span>
<span class="n">resume_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationResumeOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;resume_operation&quot;</span><span class="p">,</span> <span class="n">operation_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;get_operation&#39;)[&#39;name&#39;]}}&quot;</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_resume_operation]</span>
<span class="c1"># [START howto_operator_gcp_transfer_wait_operation]</span>
<span class="n">wait_for_operation_to_end</span> <span class="o">=</span> <span class="n">GCPTransferServiceWaitForJobStatusSensor</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;wait_for_operation_to_end&quot;</span><span class="p">,</span>
<span class="n">job_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;create_transfer_job_from_aws&#39;)[&#39;name&#39;]}}&quot;</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="n">expected_statuses</span><span class="o">=</span><span class="p">{</span><span class="n">GcpTransferOperationStatus</span><span class="o">.</span><span class="n">SUCCESS</span><span class="p">},</span>
<span class="n">poke_interval</span><span class="o">=</span><span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_wait_operation]</span>
<span class="n">job_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span>
<span class="n">gcs_to_gcs_transfer_body</span><span class="p">[</span><span class="s1">&#39;schedule&#39;</span><span class="p">][</span><span class="s1">&#39;startTimeOfDay&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">time</span><span class="p">()</span>
<span class="n">create_transfer_job_from_gcp</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobCreateOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;create_transfer_job_from_gcp&quot;</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">gcs_to_gcs_transfer_body</span>
<span class="p">)</span>
<span class="n">wait_for_second_operation_to_start</span> <span class="o">=</span> <span class="n">GCPTransferServiceWaitForJobStatusSensor</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;wait_for_second_operation_to_start&quot;</span><span class="p">,</span>
<span class="n">job_name</span><span class="o">=</span><span class="s2">&quot;{{ task_instance.xcom_pull(&#39;create_transfer_job_from_gcp&#39;)[&#39;name&#39;] }}&quot;</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="n">expected_statuses</span><span class="o">=</span><span class="p">{</span><span class="n">GcpTransferOperationStatus</span><span class="o">.</span><span class="n">IN_PROGRESS</span><span class="p">},</span>
<span class="n">poke_interval</span><span class="o">=</span><span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># [START howto_operator_gcp_transfer_cancel_operation]</span>
<span class="n">cancel_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationCancelOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;cancel_operation&quot;</span><span class="p">,</span>
<span class="n">operation_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&quot;</span>
<span class="s2">&quot;&#39;wait_for_second_operation_to_start&#39;, key=&#39;sensed_operations&#39;)[0][&#39;name&#39;]}}&quot;</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_cancel_operation]</span>
<span class="c1"># [START howto_operator_gcp_transfer_delete_job]</span>
<span class="n">delete_transfer_from_aws_job</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobDeleteOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;delete_transfer_from_aws_job&quot;</span><span class="p">,</span>
<span class="n">job_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;create_transfer_job_from_aws&#39;)[&#39;name&#39;]}}&quot;</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># [END howto_operator_gcp_transfer_delete_job]</span>
<span class="n">delete_transfer_from_gcp_job</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobDeleteOperator</span><span class="p">(</span>
<span class="n">task_id</span><span class="o">=</span><span class="s2">&quot;delete_transfer_from_gcp_job&quot;</span><span class="p">,</span>
<span class="n">job_name</span><span class="o">=</span><span class="s2">&quot;{{task_instance.xcom_pull(&#39;create_transfer_job_from_gcp&#39;)[&#39;name&#39;]}}&quot;</span><span class="p">,</span>
<span class="n">project_id</span><span class="o">=</span><span class="n">GCP_PROJECT_ID</span><span class="p">,</span>
<span class="p">)</span>
<span class="n">create_transfer_job_from_aws</span> <span class="o">&gt;&gt;</span> <span class="n">wait_for_operation_to_start</span> <span class="o">&gt;&gt;</span> <span class="n">pause_operation</span> <span class="o">&gt;&gt;</span> \
<span class="n">list_operations</span> <span class="o">&gt;&gt;</span> <span class="n">get_operation</span> <span class="o">&gt;&gt;</span> <span class="n">resume_operation</span> <span class="o">&gt;&gt;</span> <span class="n">wait_for_operation_to_end</span> <span class="o">&gt;&gt;</span> \
<span class="n">create_transfer_job_from_gcp</span> <span class="o">&gt;&gt;</span> <span class="n">wait_for_second_operation_to_start</span> <span class="o">&gt;&gt;</span> <span class="n">cancel_operation</span> <span class="o">&gt;&gt;</span> \
<span class="n">delete_transfer_from_aws_job</span> <span class="o">&gt;&gt;</span> <span class="n">delete_transfer_from_gcp_job</span>
</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>.
<div class="footer">This page uses <a href="https://analytics.google.com/">
Google Analytics</a> to collect statistics. You can disable it by blocking
the JavaScript coming from www.google-analytics.com. Check our
<a href="../../../../privacy_notice.html">Privacy Policy</a>
for more details.
<script type="text/javascript">
(function() {
var ga = document.createElement('script');
ga.src = ('https:' == document.location.protocol ?
'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
ga.setAttribute('async', 'true');
var nodes = document.documentElement.childNodes;
var i = -1;
var node;
do {
i++;
node = nodes[i]
} while(node.nodeType !== Node.ELEMENT_NODE);
node.appendChild(ga);
})();
</script>
</div>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>