Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.4 / _modules / airflow / contrib / hooks / gcp_transfer_hook.html
blob: 1555cd97219cd5b149f5e1f6be2c78a552039e86 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>airflow.contrib.hooks.gcp_transfer_hook &mdash; Airflow Documentation</title>
<script type="text/javascript" src="../../../../_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="../../../../" src="../../../../_static/documentation_options.js"></script>
<script type="text/javascript" src="../../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../../_static/language_data.js"></script>
<script type="text/javascript" src="../../../../_static/js/theme.js"></script>
<link rel="stylesheet" href="../../../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../search.html" />
<script>
document.addEventListener('DOMContentLoaded', function() {
var el = document.getElementById('changelog');
if (el !== null ) {
// [AIRFLOW-...]
el.innerHTML = el.innerHTML.replace(
/\[(AIRFLOW-[\d]+)\]/g,
`<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>`
);
// (#...)
el.innerHTML = el.innerHTML.replace(
/\(#([\d]+)\)/g,
`<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>`
);
};
})
</script>
<style>
.example-header {
position: relative;
background: #9AAA7A;
padding: 8px 16px;
margin-bottom: 0;
}
.example-header--with-button {
padding-right: 166px;
}
.example-header:after{
content: '';
display: table;
clear: both;
}
.example-title {
display:block;
padding: 4px;
margin-right: 16px;
color: white;
overflow-x: auto;
}
.example-header-button {
top: 8px;
right: 16px;
position: absolute;
}
.example-header + .highlight-python {
margin-top: 0 !important;
}
.viewcode-button {
display: inline-block;
padding: 8px 16px;
border: 0;
margin: 0;
outline: 0;
border-radius: 2px;
-webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3);
box-shadow: 0 3px 6px 0 rgba(0,0,0,.3);
color: #404040;
background-color: #e7e7e7;
cursor: pointer;
font-size: 16px;
font-weight: 500;
line-height: 1;
text-decoration: none;
text-overflow: ellipsis;
overflow: hidden;
text-transform: uppercase;
-webkit-transition: background-color .2s;
transition: background-color .2s;
vertical-align: middle;
white-space: nowrap;
}
.viewcode-button:visited {
color: #404040;
}
.viewcode-button:hover, .viewcode-button:focus {
color: #404040;
background-color: #d6d6d6;
}
</style>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="../../../../index.html" class="icon icon-home"> Airflow
</a>
<div class="version">
1.10.4
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling &amp; Triggers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../plugins.html">Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../security.html">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../timezone.html">Time zones</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../api.html">Experimental Rest API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../integration.html">Integration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../metrics.html">Metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../kubernetes.html">Kubernetes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../lineage.html">Lineage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../macros.html">Macros reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../_api/index.html">API Reference</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../index.html">Airflow</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../index.html">Docs</a> &raquo;</li>
<li><a href="../../../index.html">Module code</a> &raquo;</li>
<li><a href="../hooks.html">airflow.contrib.hooks</a> &raquo;</li>
<li>airflow.contrib.hooks.gcp_transfer_hook</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Source code for airflow.contrib.hooks.gcp_transfer_hook</h1><div class="highlight"><pre>
<span></span><span class="c1"># -*- coding: utf-8 -*-</span>
<span class="c1">#</span>
<span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span>
<span class="c1"># or more contributor license agreements. See the NOTICE file</span>
<span class="c1"># distributed with this work for additional information</span>
<span class="c1"># regarding copyright ownership. The ASF licenses this file</span>
<span class="c1"># to you under the Apache License, Version 2.0 (the</span>
<span class="c1"># &quot;License&quot;); you may not use this file except in compliance</span>
<span class="c1"># with the License. You may obtain a copy of the License at</span>
<span class="c1">#</span>
<span class="c1"># http://www.apache.org/licenses/LICENSE-2.0</span>
<span class="c1">#</span>
<span class="c1"># Unless required by applicable law or agreed to in writing,</span>
<span class="c1"># software distributed under the License is distributed on an</span>
<span class="c1"># &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span>
<span class="c1"># KIND, either express or implied. See the License for the</span>
<span class="c1"># specific language governing permissions and limitations</span>
<span class="c1"># under the License.</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">time</span>
<span class="kn">from</span> <span class="nn">copy</span> <span class="k">import</span> <span class="n">deepcopy</span>
<span class="kn">import</span> <span class="nn">six</span>
<span class="kn">from</span> <span class="nn">googleapiclient.discovery</span> <span class="k">import</span> <span class="n">build</span>
<span class="kn">from</span> <span class="nn">airflow.exceptions</span> <span class="k">import</span> <span class="n">AirflowException</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_api_base_hook</span> <span class="k">import</span> <span class="n">GoogleCloudBaseHook</span>
<span class="c1"># Time to sleep between active checks of the operation results</span>
<div class="viewcode-block" id="TIME_TO_SLEEP_IN_SECONDS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.TIME_TO_SLEEP_IN_SECONDS">[docs]</a><span class="n">TIME_TO_SLEEP_IN_SECONDS</span> <span class="o">=</span> <span class="mi">10</span></div>
<div class="viewcode-block" id="GcpTransferJobsStatus"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferJobsStatus</span><span class="p">:</span>
<div class="viewcode-block" id="GcpTransferJobsStatus.ENABLED"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.ENABLED">[docs]</a> <span class="n">ENABLED</span> <span class="o">=</span> <span class="s2">&quot;ENABLED&quot;</span></div>
<div class="viewcode-block" id="GcpTransferJobsStatus.DISABLED"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.DISABLED">[docs]</a> <span class="n">DISABLED</span> <span class="o">=</span> <span class="s2">&quot;DISABLED&quot;</span></div>
<div class="viewcode-block" id="GcpTransferJobsStatus.DELETED"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.DELETED">[docs]</a> <span class="n">DELETED</span> <span class="o">=</span> <span class="s2">&quot;DELETED&quot;</span></div></div>
<div class="viewcode-block" id="GcpTransferOperationStatus"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferOperationStatus</span><span class="p">:</span>
<div class="viewcode-block" id="GcpTransferOperationStatus.IN_PROGRESS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.IN_PROGRESS">[docs]</a> <span class="n">IN_PROGRESS</span> <span class="o">=</span> <span class="s2">&quot;IN_PROGRESS&quot;</span></div>
<div class="viewcode-block" id="GcpTransferOperationStatus.PAUSED"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.PAUSED">[docs]</a> <span class="n">PAUSED</span> <span class="o">=</span> <span class="s2">&quot;PAUSED&quot;</span></div>
<div class="viewcode-block" id="GcpTransferOperationStatus.SUCCESS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.SUCCESS">[docs]</a> <span class="n">SUCCESS</span> <span class="o">=</span> <span class="s2">&quot;SUCCESS&quot;</span></div>
<div class="viewcode-block" id="GcpTransferOperationStatus.FAILED"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.FAILED">[docs]</a> <span class="n">FAILED</span> <span class="o">=</span> <span class="s2">&quot;FAILED&quot;</span></div>
<div class="viewcode-block" id="GcpTransferOperationStatus.ABORTED"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.ABORTED">[docs]</a> <span class="n">ABORTED</span> <span class="o">=</span> <span class="s2">&quot;ABORTED&quot;</span></div></div>
<span class="c1"># A list of keywords used to build a request or response</span>
<div class="viewcode-block" id="ACCESS_KEY_ID"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.ACCESS_KEY_ID">[docs]</a><span class="n">ACCESS_KEY_ID</span> <span class="o">=</span> <span class="s2">&quot;accessKeyId&quot;</span></div>
<div class="viewcode-block" id="ALREADY_EXISTING_IN_SINK"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.ALREADY_EXISTING_IN_SINK">[docs]</a><span class="n">ALREADY_EXISTING_IN_SINK</span> <span class="o">=</span> <span class="s2">&quot;overwriteObjectsAlreadyExistingInSink&quot;</span></div>
<div class="viewcode-block" id="AWS_ACCESS_KEY"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.AWS_ACCESS_KEY">[docs]</a><span class="n">AWS_ACCESS_KEY</span> <span class="o">=</span> <span class="s2">&quot;awsAccessKey&quot;</span></div>
<div class="viewcode-block" id="AWS_S3_DATA_SOURCE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.AWS_S3_DATA_SOURCE">[docs]</a><span class="n">AWS_S3_DATA_SOURCE</span> <span class="o">=</span> <span class="s1">&#39;awsS3DataSource&#39;</span></div>
<div class="viewcode-block" id="BODY"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.BODY">[docs]</a><span class="n">BODY</span> <span class="o">=</span> <span class="s1">&#39;body&#39;</span></div>
<div class="viewcode-block" id="BUCKET_NAME"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.BUCKET_NAME">[docs]</a><span class="n">BUCKET_NAME</span> <span class="o">=</span> <span class="s1">&#39;bucketName&#39;</span></div>
<div class="viewcode-block" id="DAY"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.DAY">[docs]</a><span class="n">DAY</span> <span class="o">=</span> <span class="s1">&#39;day&#39;</span></div>
<div class="viewcode-block" id="DESCRIPTION"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.DESCRIPTION">[docs]</a><span class="n">DESCRIPTION</span> <span class="o">=</span> <span class="s2">&quot;description&quot;</span></div>
<div class="viewcode-block" id="FILTER"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.FILTER">[docs]</a><span class="n">FILTER</span> <span class="o">=</span> <span class="s1">&#39;filter&#39;</span></div>
<div class="viewcode-block" id="FILTER_JOB_NAMES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.FILTER_JOB_NAMES">[docs]</a><span class="n">FILTER_JOB_NAMES</span> <span class="o">=</span> <span class="s1">&#39;job_names&#39;</span></div>
<div class="viewcode-block" id="FILTER_PROJECT_ID"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.FILTER_PROJECT_ID">[docs]</a><span class="n">FILTER_PROJECT_ID</span> <span class="o">=</span> <span class="s1">&#39;project_id&#39;</span></div>
<div class="viewcode-block" id="GCS_DATA_SINK"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCS_DATA_SINK">[docs]</a><span class="n">GCS_DATA_SINK</span> <span class="o">=</span> <span class="s1">&#39;gcsDataSink&#39;</span></div>
<div class="viewcode-block" id="GCS_DATA_SOURCE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCS_DATA_SOURCE">[docs]</a><span class="n">GCS_DATA_SOURCE</span> <span class="o">=</span> <span class="s1">&#39;gcsDataSource&#39;</span></div>
<div class="viewcode-block" id="HOURS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.HOURS">[docs]</a><span class="n">HOURS</span> <span class="o">=</span> <span class="s2">&quot;hours&quot;</span></div>
<div class="viewcode-block" id="HTTP_DATA_SOURCE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.HTTP_DATA_SOURCE">[docs]</a><span class="n">HTTP_DATA_SOURCE</span> <span class="o">=</span> <span class="s1">&#39;httpDataSource&#39;</span></div>
<div class="viewcode-block" id="LIST_URL"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.LIST_URL">[docs]</a><span class="n">LIST_URL</span> <span class="o">=</span> <span class="s1">&#39;list_url&#39;</span></div>
<div class="viewcode-block" id="METADATA"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.METADATA">[docs]</a><span class="n">METADATA</span> <span class="o">=</span> <span class="s1">&#39;metadata&#39;</span></div>
<div class="viewcode-block" id="MINUTES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.MINUTES">[docs]</a><span class="n">MINUTES</span> <span class="o">=</span> <span class="s2">&quot;minutes&quot;</span></div>
<div class="viewcode-block" id="MONTH"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.MONTH">[docs]</a><span class="n">MONTH</span> <span class="o">=</span> <span class="s1">&#39;month&#39;</span></div>
<div class="viewcode-block" id="NAME"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.NAME">[docs]</a><span class="n">NAME</span> <span class="o">=</span> <span class="s1">&#39;name&#39;</span></div>
<div class="viewcode-block" id="OBJECT_CONDITIONS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.OBJECT_CONDITIONS">[docs]</a><span class="n">OBJECT_CONDITIONS</span> <span class="o">=</span> <span class="s1">&#39;object_conditions&#39;</span></div>
<div class="viewcode-block" id="OPERATIONS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.OPERATIONS">[docs]</a><span class="n">OPERATIONS</span> <span class="o">=</span> <span class="s1">&#39;operations&#39;</span></div>
<div class="viewcode-block" id="PROJECT_ID"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.PROJECT_ID">[docs]</a><span class="n">PROJECT_ID</span> <span class="o">=</span> <span class="s1">&#39;projectId&#39;</span></div>
<div class="viewcode-block" id="SCHEDULE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE">[docs]</a><span class="n">SCHEDULE</span> <span class="o">=</span> <span class="s1">&#39;schedule&#39;</span></div>
<div class="viewcode-block" id="SCHEDULE_END_DATE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE_END_DATE">[docs]</a><span class="n">SCHEDULE_END_DATE</span> <span class="o">=</span> <span class="s1">&#39;scheduleEndDate&#39;</span></div>
<div class="viewcode-block" id="SCHEDULE_START_DATE"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE_START_DATE">[docs]</a><span class="n">SCHEDULE_START_DATE</span> <span class="o">=</span> <span class="s1">&#39;scheduleStartDate&#39;</span></div>
<div class="viewcode-block" id="SECONDS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.SECONDS">[docs]</a><span class="n">SECONDS</span> <span class="o">=</span> <span class="s2">&quot;seconds&quot;</span></div>
<div class="viewcode-block" id="SECRET_ACCESS_KEY"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.SECRET_ACCESS_KEY">[docs]</a><span class="n">SECRET_ACCESS_KEY</span> <span class="o">=</span> <span class="s2">&quot;secretAccessKey&quot;</span></div>
<div class="viewcode-block" id="START_TIME_OF_DAY"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.START_TIME_OF_DAY">[docs]</a><span class="n">START_TIME_OF_DAY</span> <span class="o">=</span> <span class="s1">&#39;startTimeOfDay&#39;</span></div>
<div class="viewcode-block" id="STATUS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.STATUS">[docs]</a><span class="n">STATUS</span> <span class="o">=</span> <span class="s2">&quot;status&quot;</span></div>
<div class="viewcode-block" id="STATUS1"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.STATUS1">[docs]</a><span class="n">STATUS1</span> <span class="o">=</span> <span class="s1">&#39;status&#39;</span></div>
<div class="viewcode-block" id="TRANSFER_JOB"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOB">[docs]</a><span class="n">TRANSFER_JOB</span> <span class="o">=</span> <span class="s1">&#39;transfer_job&#39;</span></div>
<div class="viewcode-block" id="TRANSFER_JOB_FIELD_MASK"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOB_FIELD_MASK">[docs]</a><span class="n">TRANSFER_JOB_FIELD_MASK</span> <span class="o">=</span> <span class="s1">&#39;update_transfer_job_field_mask&#39;</span></div>
<div class="viewcode-block" id="TRANSFER_JOBS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOBS">[docs]</a><span class="n">TRANSFER_JOBS</span> <span class="o">=</span> <span class="s1">&#39;transferJobs&#39;</span></div>
<div class="viewcode-block" id="TRANSFER_OPERATIONS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_OPERATIONS">[docs]</a><span class="n">TRANSFER_OPERATIONS</span> <span class="o">=</span> <span class="s1">&#39;transferOperations&#39;</span></div>
<div class="viewcode-block" id="TRANSFER_OPTIONS"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_OPTIONS">[docs]</a><span class="n">TRANSFER_OPTIONS</span> <span class="o">=</span> <span class="s1">&#39;transfer_options&#39;</span></div>
<div class="viewcode-block" id="TRANSFER_SPEC"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_SPEC">[docs]</a><span class="n">TRANSFER_SPEC</span> <span class="o">=</span> <span class="s1">&#39;transferSpec&#39;</span></div>
<div class="viewcode-block" id="YEAR"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.YEAR">[docs]</a><span class="n">YEAR</span> <span class="o">=</span> <span class="s1">&#39;year&#39;</span></div>
<div class="viewcode-block" id="NEGATIVE_STATUSES"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.NEGATIVE_STATUSES">[docs]</a><span class="n">NEGATIVE_STATUSES</span> <span class="o">=</span> <span class="p">{</span><span class="n">GcpTransferOperationStatus</span><span class="o">.</span><span class="n">FAILED</span><span class="p">,</span> <span class="n">GcpTransferOperationStatus</span><span class="o">.</span><span class="n">ABORTED</span><span class="p">}</span></div>
<span class="c1"># noinspection PyAbstractClass</span>
<div class="viewcode-block" id="GCPTransferServiceHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook">[docs]</a><span class="k">class</span> <span class="nc">GCPTransferServiceHook</span><span class="p">(</span><span class="n">GoogleCloudBaseHook</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Hook for Google Storage Transfer Service.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="GCPTransferServiceHook._conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook._conn">[docs]</a> <span class="n">_conn</span> <span class="o">=</span> <span class="kc">None</span></div>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">&#39;v1&#39;</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">&#39;google_cloud_default&#39;</span><span class="p">,</span> <span class="n">delegate_to</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GCPTransferServiceHook</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">delegate_to</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span>
<span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_field</span><span class="p">(</span><span class="s1">&#39;num_retries&#39;</span><span class="p">,</span> <span class="mi">5</span><span class="p">)</span>
<div class="viewcode-block" id="GCPTransferServiceHook.get_conn"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_conn">[docs]</a> <span class="k">def</span> <span class="nf">get_conn</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Retrieves connection to Google Storage Transfer service.</span>
<span class="sd"> :return: Google Storage Transfer service object</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span><span class="p">:</span>
<span class="n">http_authorized</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_authorize</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_conn</span> <span class="o">=</span> <span class="n">build</span><span class="p">(</span>
<span class="s1">&#39;storagetransfer&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">http</span><span class="o">=</span><span class="n">http_authorized</span><span class="p">,</span> <span class="n">cache_discovery</span><span class="o">=</span><span class="kc">False</span>
<span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_conn</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.create_transfer_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.create_transfer_job">[docs]</a> <span class="k">def</span> <span class="nf">create_transfer_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Creates a transfer job that runs periodically.</span>
<span class="sd"> :param body: (Required) A request body, as described in</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body</span>
<span class="sd"> :type body: dict</span>
<span class="sd"> :return: transfer job.</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TransferJob</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inject_project_id</span><span class="p">(</span><span class="n">body</span><span class="p">,</span> <span class="n">BODY</span><span class="p">,</span> <span class="n">PROJECT_ID</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">transferJobs</span><span class="p">()</span><span class="o">.</span><span class="n">create</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.get_transfer_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_transfer_job">[docs]</a> <span class="k">def</span> <span class="nf">get_transfer_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_name</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets the latest state of a long-running operation in Google Storage</span>
<span class="sd"> Transfer Service.</span>
<span class="sd"> :param job_name: (Required) Name of the job to be fetched</span>
<span class="sd"> :type job_name: str</span>
<span class="sd"> :param project_id: (Optional) the ID of the project that owns the Transfer</span>
<span class="sd"> Job. If set to None or missing, the default project_id from the GCP</span>
<span class="sd"> connection is used.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :return: Transfer Job</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
<span class="o">.</span><span class="n">transferJobs</span><span class="p">()</span>
<span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">jobName</span><span class="o">=</span><span class="n">job_name</span><span class="p">,</span> <span class="n">projectId</span><span class="o">=</span><span class="n">project_id</span><span class="p">)</span>
<span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="p">)</span>
<div class="viewcode-block" id="GCPTransferServiceHook.list_transfer_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.list_transfer_job">[docs]</a> <span class="k">def</span> <span class="nf">list_transfer_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">filter</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Lists long-running operations in Google Storage Transfer</span>
<span class="sd"> Service that match the specified filter.</span>
<span class="sd"> :param filter: (Required) A request filter, as described in</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter</span>
<span class="sd"> :type filter: dict</span>
<span class="sd"> :return: List of Transfer Jobs</span>
<span class="sd"> :rtype: list[dict]</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
<span class="nb">filter</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inject_project_id</span><span class="p">(</span><span class="nb">filter</span><span class="p">,</span> <span class="n">FILTER</span><span class="p">,</span> <span class="n">FILTER_PROJECT_ID</span><span class="p">)</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">transferJobs</span><span class="p">()</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="nb">filter</span><span class="o">=</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="nb">filter</span><span class="p">))</span>
<span class="n">jobs</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">while</span> <span class="n">request</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span>
<span class="n">jobs</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">response</span><span class="p">[</span><span class="n">TRANSFER_JOBS</span><span class="p">])</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">transferJobs</span><span class="p">()</span><span class="o">.</span><span class="n">list_next</span><span class="p">(</span><span class="n">previous_request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">previous_response</span><span class="o">=</span><span class="n">response</span><span class="p">)</span>
<span class="k">return</span> <span class="n">jobs</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.update_transfer_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.update_transfer_job">[docs]</a> <span class="k">def</span> <span class="nf">update_transfer_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_name</span><span class="p">,</span> <span class="n">body</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Updates a transfer job that runs periodically.</span>
<span class="sd"> :param job_name: (Required) Name of the job to be updated</span>
<span class="sd"> :type job_name: str</span>
<span class="sd"> :param body: A request body, as described in</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body</span>
<span class="sd"> :type body: dict</span>
<span class="sd"> :return: If successful, TransferJob.</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inject_project_id</span><span class="p">(</span><span class="n">body</span><span class="p">,</span> <span class="n">BODY</span><span class="p">,</span> <span class="n">PROJECT_ID</span><span class="p">)</span>
<span class="k">return</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
<span class="o">.</span><span class="n">transferJobs</span><span class="p">()</span>
<span class="o">.</span><span class="n">patch</span><span class="p">(</span><span class="n">jobName</span><span class="o">=</span><span class="n">job_name</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span>
<span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="p">)</span>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">fallback_to_default_project_id</span>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.delete_transfer_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.delete_transfer_job">[docs]</a> <span class="k">def</span> <span class="nf">delete_transfer_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_name</span><span class="p">,</span> <span class="n">project_id</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Deletes a transfer job. This is a soft delete. After a transfer job is</span>
<span class="sd"> deleted, the job and all the transfer executions are subject to garbage</span>
<span class="sd"> collection. Transfer jobs become eligible for garbage collection</span>
<span class="sd"> 30 days after soft delete.</span>
<span class="sd"> :param job_name: (Required) Name of the job to be deleted</span>
<span class="sd"> :type job_name: str</span>
<span class="sd"> :param project_id: (Optional) the ID of the project that owns the Transfer</span>
<span class="sd"> Job. If set to None or missing, the default project_id from the GCP</span>
<span class="sd"> connection is used.</span>
<span class="sd"> :type project_id: str</span>
<span class="sd"> :rtype: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
<span class="o">.</span><span class="n">transferJobs</span><span class="p">()</span>
<span class="o">.</span><span class="n">patch</span><span class="p">(</span>
<span class="n">jobName</span><span class="o">=</span><span class="n">job_name</span><span class="p">,</span>
<span class="n">body</span><span class="o">=</span><span class="p">{</span>
<span class="n">PROJECT_ID</span><span class="p">:</span> <span class="n">project_id</span><span class="p">,</span>
<span class="n">TRANSFER_JOB</span><span class="p">:</span> <span class="p">{</span><span class="n">STATUS1</span><span class="p">:</span> <span class="n">GcpTransferJobsStatus</span><span class="o">.</span><span class="n">DELETED</span><span class="p">},</span>
<span class="n">TRANSFER_JOB_FIELD_MASK</span><span class="p">:</span> <span class="n">STATUS1</span><span class="p">,</span>
<span class="p">},</span>
<span class="p">)</span>
<span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="p">)</span>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.cancel_transfer_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.cancel_transfer_operation">[docs]</a> <span class="k">def</span> <span class="nf">cancel_transfer_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Cancels an transfer operation in Google Storage Transfer Service.</span>
<span class="sd"> :param operation_name: Name of the transfer operation.</span>
<span class="sd"> :type operation_name: str</span>
<span class="sd"> :rtype: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">transferOperations</span><span class="p">()</span><span class="o">.</span><span class="n">cancel</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.get_transfer_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_transfer_operation">[docs]</a> <span class="k">def</span> <span class="nf">get_transfer_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets an transfer operation in Google Storage Transfer Service.</span>
<span class="sd"> :param operation_name: (Required) Name of the transfer operation.</span>
<span class="sd"> :type operation_name: str</span>
<span class="sd"> :return: transfer operation</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/Operation</span>
<span class="sd"> :rtype: dict</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
<span class="o">.</span><span class="n">transferOperations</span><span class="p">()</span>
<span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span>
<span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="p">)</span>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.list_transfer_operations"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.list_transfer_operations">[docs]</a> <span class="k">def</span> <span class="nf">list_transfer_operations</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">filter</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Gets an transfer operation in Google Storage Transfer Service.</span>
<span class="sd"> :param filter: (Required) A request filter, as described in</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter</span>
<span class="sd"> With one additional improvement:</span>
<span class="sd"> * project_id is optional if you have a project id defined</span>
<span class="sd"> in the connection</span>
<span class="sd"> See: :ref:`howto/connection:gcp`</span>
<span class="sd"> :type filter: dict</span>
<span class="sd"> :return: transfer operation</span>
<span class="sd"> :rtype: list[dict]</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">conn</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span>
<span class="nb">filter</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_inject_project_id</span><span class="p">(</span><span class="nb">filter</span><span class="p">,</span> <span class="n">FILTER</span><span class="p">,</span> <span class="n">FILTER_PROJECT_ID</span><span class="p">)</span>
<span class="n">operations</span> <span class="o">=</span> <span class="p">[]</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">transferOperations</span><span class="p">()</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">TRANSFER_OPERATIONS</span><span class="p">,</span> <span class="nb">filter</span><span class="o">=</span><span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="nb">filter</span><span class="p">))</span>
<span class="k">while</span> <span class="n">request</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">response</span> <span class="o">=</span> <span class="n">request</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span>
<span class="k">if</span> <span class="n">OPERATIONS</span> <span class="ow">in</span> <span class="n">response</span><span class="p">:</span>
<span class="n">operations</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">response</span><span class="p">[</span><span class="n">OPERATIONS</span><span class="p">])</span>
<span class="n">request</span> <span class="o">=</span> <span class="n">conn</span><span class="o">.</span><span class="n">transferOperations</span><span class="p">()</span><span class="o">.</span><span class="n">list_next</span><span class="p">(</span>
<span class="n">previous_request</span><span class="o">=</span><span class="n">request</span><span class="p">,</span> <span class="n">previous_response</span><span class="o">=</span><span class="n">response</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">operations</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.pause_transfer_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.pause_transfer_operation">[docs]</a> <span class="k">def</span> <span class="nf">pause_transfer_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Pauses an transfer operation in Google Storage Transfer Service.</span>
<span class="sd"> :param operation_name: (Required) Name of the transfer operation.</span>
<span class="sd"> :type operation_name: str</span>
<span class="sd"> :rtype: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">transferOperations</span><span class="p">()</span><span class="o">.</span><span class="n">pause</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.resume_transfer_operation"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.resume_transfer_operation">[docs]</a> <span class="k">def</span> <span class="nf">resume_transfer_operation</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Resumes an transfer operation in Google Storage Transfer Service.</span>
<span class="sd"> :param operation_name: (Required) Name of the transfer operation.</span>
<span class="sd"> :type operation_name: str</span>
<span class="sd"> :rtype: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_conn</span><span class="p">()</span><span class="o">.</span><span class="n">transferOperations</span><span class="p">()</span><span class="o">.</span><span class="n">resume</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">operation_name</span><span class="p">)</span><span class="o">.</span><span class="n">execute</span><span class="p">(</span><span class="n">num_retries</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">num_retries</span><span class="p">)</span></div>
<span class="nd">@GoogleCloudBaseHook</span><span class="o">.</span><span class="n">catch_http_exception</span>
<div class="viewcode-block" id="GCPTransferServiceHook.wait_for_transfer_job"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.wait_for_transfer_job">[docs]</a> <span class="k">def</span> <span class="nf">wait_for_transfer_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job</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">timeout</span><span class="o">=</span><span class="mi">60</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Waits until the job reaches the expected state.</span>
<span class="sd"> :param job: Transfer job</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TransferJob</span>
<span class="sd"> :type job: dict</span>
<span class="sd"> :param expected_statuses: State that is expected</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status</span>
<span class="sd"> :type expected_statuses: set[str]</span>
<span class="sd"> :param timeout:</span>
<span class="sd"> :type timeout: time in which the operation must end in seconds</span>
<span class="sd"> :rtype: None</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">while</span> <span class="n">timeout</span> <span class="o">&gt;</span> <span class="mi">0</span><span class="p">:</span>
<span class="n">operations</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">list_transfer_operations</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">job</span><span class="p">[</span><span class="n">PROJECT_ID</span><span class="p">],</span> <span class="n">FILTER_JOB_NAMES</span><span class="p">:</span> <span class="p">[</span><span class="n">job</span><span class="p">[</span><span class="n">NAME</span><span class="p">]]}</span>
<span class="p">)</span>
<span class="k">if</span> <span class="n">GCPTransferServiceHook</span><span class="o">.</span><span class="n">operations_contain_expected_statuses</span><span class="p">(</span><span class="n">operations</span><span class="p">,</span> <span class="n">expected_statuses</span><span class="p">):</span>
<span class="k">return</span>
<span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">TIME_TO_SLEEP_IN_SECONDS</span><span class="p">)</span>
<span class="n">timeout</span> <span class="o">-=</span> <span class="n">TIME_TO_SLEEP_IN_SECONDS</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">&quot;Timeout. The operation could not be completed within the allotted time.&quot;</span><span class="p">)</span></div>
<div class="viewcode-block" id="GCPTransferServiceHook._inject_project_id"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook._inject_project_id">[docs]</a> <span class="k">def</span> <span class="nf">_inject_project_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">body</span><span class="p">,</span> <span class="n">param_name</span><span class="p">,</span> <span class="n">target_key</span><span class="p">):</span>
<span class="n">body</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">body</span><span class="p">)</span>
<span class="n">body</span><span class="p">[</span><span class="n">target_key</span><span class="p">]</span> <span class="o">=</span> <span class="n">body</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">target_key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">body</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">target_key</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s2">&quot;The project id must be passed either as `</span><span class="si">{}</span><span class="s2">` key in `</span><span class="si">{}</span><span class="s2">` parameter or as project_id &quot;</span>
<span class="s2">&quot;extra in GCP connection definition. Both are not set!&quot;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">target_key</span><span class="p">,</span> <span class="n">param_name</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="n">body</span></div>
<span class="nd">@staticmethod</span>
<div class="viewcode-block" id="GCPTransferServiceHook.operations_contain_expected_statuses"><a class="viewcode-back" href="../../../../_api/airflow/contrib/hooks/gcp_transfer_hook/index.html#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.operations_contain_expected_statuses">[docs]</a> <span class="k">def</span> <span class="nf">operations_contain_expected_statuses</span><span class="p">(</span><span class="n">operations</span><span class="p">,</span> <span class="n">expected_statuses</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks whether the operation list has an operation with the</span>
<span class="sd"> expected status, then returns true</span>
<span class="sd"> If it encounters operations in FAILED or ABORTED state</span>
<span class="sd"> throw :class:`airflow.exceptions.AirflowException`.</span>
<span class="sd"> :param operations: (Required) List of transfer operations to check.</span>
<span class="sd"> :type operations: list[dict]</span>
<span class="sd"> :param expected_statuses: (Required) status that is expected</span>
<span class="sd"> See:</span>
<span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status</span>
<span class="sd"> :type expected_statuses: set[str]</span>
<span class="sd"> :return: If there is an operation with the expected state</span>
<span class="sd"> in the operation list, returns true,</span>
<span class="sd"> :raises: airflow.exceptions.AirflowException If it encounters operations</span>
<span class="sd"> with a state in the list,</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">expected_statuses</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">{</span><span class="n">expected_statuses</span><span class="p">}</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">expected_statuses</span><span class="p">,</span> <span class="n">six</span><span class="o">.</span><span class="n">string_types</span><span class="p">)</span> <span class="k">else</span> <span class="nb">set</span><span class="p">(</span><span class="n">expected_statuses</span><span class="p">)</span>
<span class="p">)</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">operations</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="n">current_statuses</span> <span class="o">=</span> <span class="p">{</span><span class="n">operation</span><span class="p">[</span><span class="n">METADATA</span><span class="p">][</span><span class="n">STATUS</span><span class="p">]</span> <span class="k">for</span> <span class="n">operation</span> <span class="ow">in</span> <span class="n">operations</span><span class="p">}</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">current_statuses</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="n">expected_statuses</span><span class="p">))</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">current_statuses</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">NEGATIVE_STATUSES</span> <span class="o">-</span> <span class="n">current_statuses</span><span class="p">)</span> <span class="o">!=</span> <span class="nb">len</span><span class="p">(</span><span class="n">NEGATIVE_STATUSES</span><span class="p">):</span>
<span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span>
<span class="s1">&#39;An unexpected operation status was encountered. Expected: </span><span class="si">{}</span><span class="s1">&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="s2">&quot;, &quot;</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">expected_statuses</span><span class="p">)</span>
<span class="p">)</span>
<span class="p">)</span>
<span class="k">return</span> <span class="kc">False</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>