blob: 5975818e3cee05cc648d7fd36e6521418d747718 [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" />
<link rel="next" title="airflow.contrib.hooks.gcp_translate_hook" href="../gcp_translate_hook/index.html" />
<link rel="prev" title="airflow.contrib.hooks.gcp_text_to_speech_hook" href="../gcp_text_to_speech_hook/index.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 class="current">
<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 current"><a class="reference internal" href="../../../../index.html">Python API Reference</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#operators">Operators</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#hooks-packages">Hooks packages</a><ul class="current">
<li class="toctree-l4"><a class="reference internal" href="../../../hooks/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.hooks</span></code></a></li>
<li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../../../index.html#core-and-community-package">Core and community package</a></li>
</ul>
</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">Python API Reference</a> &raquo;</li>
<li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks</span></code></a> &raquo;</li>
<li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.gcp_transfer_hook</span></code></li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../../_sources/_api/airflow/contrib/hooks/gcp_transfer_hook/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="module-airflow.contrib.hooks.gcp_transfer_hook">
<span id="airflow-contrib-hooks-gcp-transfer-hook"></span><h1><a class="reference internal" href="#module-airflow.contrib.hooks.gcp_transfer_hook" title="airflow.contrib.hooks.gcp_transfer_hook"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.hooks.gcp_transfer_hook</span></code></a><a class="headerlink" href="#module-airflow.contrib.hooks.gcp_transfer_hook" title="Permalink to this headline"></a></h1>
<div class="section" id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline"></a></h2>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.TIME_TO_SLEEP_IN_SECONDS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">TIME_TO_SLEEP_IN_SECONDS</code><em class="property"> = 10</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#TIME_TO_SLEEP_IN_SECONDS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.TIME_TO_SLEEP_IN_SECONDS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus">
<em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">GcpTransferJobsStatus</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferJobsStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.ENABLED">
<code class="sig-name descname">ENABLED</code><em class="property"> = ENABLED</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferJobsStatus.ENABLED"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.ENABLED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.DISABLED">
<code class="sig-name descname">DISABLED</code><em class="property"> = DISABLED</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferJobsStatus.DISABLED"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.DISABLED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.DELETED">
<code class="sig-name descname">DELETED</code><em class="property"> = DELETED</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferJobsStatus.DELETED"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferJobsStatus.DELETED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus">
<em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">GcpTransferOperationStatus</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferOperationStatus"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus" title="Permalink to this definition"></a></dt>
<dd><dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.IN_PROGRESS">
<code class="sig-name descname">IN_PROGRESS</code><em class="property"> = IN_PROGRESS</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferOperationStatus.IN_PROGRESS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.IN_PROGRESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.PAUSED">
<code class="sig-name descname">PAUSED</code><em class="property"> = PAUSED</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferOperationStatus.PAUSED"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.PAUSED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.SUCCESS">
<code class="sig-name descname">SUCCESS</code><em class="property"> = SUCCESS</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferOperationStatus.SUCCESS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.SUCCESS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.FAILED">
<code class="sig-name descname">FAILED</code><em class="property"> = FAILED</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferOperationStatus.FAILED"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.FAILED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.ABORTED">
<code class="sig-name descname">ABORTED</code><em class="property"> = ABORTED</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GcpTransferOperationStatus.ABORTED"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GcpTransferOperationStatus.ABORTED" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.ACCESS_KEY_ID">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">ACCESS_KEY_ID</code><em class="property"> = accessKeyId</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#ACCESS_KEY_ID"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.ACCESS_KEY_ID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.ALREADY_EXISTING_IN_SINK">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">ALREADY_EXISTING_IN_SINK</code><em class="property"> = overwriteObjectsAlreadyExistingInSink</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#ALREADY_EXISTING_IN_SINK"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.ALREADY_EXISTING_IN_SINK" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.AWS_ACCESS_KEY">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">AWS_ACCESS_KEY</code><em class="property"> = awsAccessKey</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#AWS_ACCESS_KEY"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.AWS_ACCESS_KEY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.AWS_S3_DATA_SOURCE">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">AWS_S3_DATA_SOURCE</code><em class="property"> = awsS3DataSource</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#AWS_S3_DATA_SOURCE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.AWS_S3_DATA_SOURCE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.BODY">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">BODY</code><em class="property"> = body</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#BODY"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.BODY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.BUCKET_NAME">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">BUCKET_NAME</code><em class="property"> = bucketName</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#BUCKET_NAME"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.BUCKET_NAME" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.DAY">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">DAY</code><em class="property"> = day</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#DAY"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.DAY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.DESCRIPTION">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">DESCRIPTION</code><em class="property"> = description</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#DESCRIPTION"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.DESCRIPTION" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.FILTER">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">FILTER</code><em class="property"> = filter</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#FILTER"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.FILTER" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.FILTER_JOB_NAMES">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">FILTER_JOB_NAMES</code><em class="property"> = job_names</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#FILTER_JOB_NAMES"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.FILTER_JOB_NAMES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.FILTER_PROJECT_ID">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">FILTER_PROJECT_ID</code><em class="property"> = project_id</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#FILTER_PROJECT_ID"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.FILTER_PROJECT_ID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCS_DATA_SINK">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">GCS_DATA_SINK</code><em class="property"> = gcsDataSink</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCS_DATA_SINK"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCS_DATA_SINK" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCS_DATA_SOURCE">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">GCS_DATA_SOURCE</code><em class="property"> = gcsDataSource</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCS_DATA_SOURCE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCS_DATA_SOURCE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.HOURS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">HOURS</code><em class="property"> = hours</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#HOURS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.HOURS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.HTTP_DATA_SOURCE">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">HTTP_DATA_SOURCE</code><em class="property"> = httpDataSource</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#HTTP_DATA_SOURCE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.HTTP_DATA_SOURCE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.LIST_URL">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">LIST_URL</code><em class="property"> = list_url</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#LIST_URL"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.LIST_URL" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.METADATA">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">METADATA</code><em class="property"> = metadata</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#METADATA"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.METADATA" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.MINUTES">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">MINUTES</code><em class="property"> = minutes</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#MINUTES"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.MINUTES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.MONTH">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">MONTH</code><em class="property"> = month</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#MONTH"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.MONTH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.NAME">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">NAME</code><em class="property"> = name</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#NAME"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.NAME" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.OBJECT_CONDITIONS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">OBJECT_CONDITIONS</code><em class="property"> = object_conditions</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#OBJECT_CONDITIONS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.OBJECT_CONDITIONS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.OPERATIONS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">OPERATIONS</code><em class="property"> = operations</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#OPERATIONS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.OPERATIONS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.PROJECT_ID">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">PROJECT_ID</code><em class="property"> = projectId</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#PROJECT_ID"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.PROJECT_ID" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">SCHEDULE</code><em class="property"> = schedule</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#SCHEDULE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE_END_DATE">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">SCHEDULE_END_DATE</code><em class="property"> = scheduleEndDate</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#SCHEDULE_END_DATE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE_END_DATE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE_START_DATE">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">SCHEDULE_START_DATE</code><em class="property"> = scheduleStartDate</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#SCHEDULE_START_DATE"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.SCHEDULE_START_DATE" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.SECONDS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">SECONDS</code><em class="property"> = seconds</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#SECONDS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.SECONDS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.SECRET_ACCESS_KEY">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">SECRET_ACCESS_KEY</code><em class="property"> = secretAccessKey</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#SECRET_ACCESS_KEY"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.SECRET_ACCESS_KEY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.START_TIME_OF_DAY">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">START_TIME_OF_DAY</code><em class="property"> = startTimeOfDay</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#START_TIME_OF_DAY"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.START_TIME_OF_DAY" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.STATUS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">STATUS</code><em class="property"> = status</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#STATUS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.STATUS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.STATUS1">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">STATUS1</code><em class="property"> = status</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#STATUS1"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.STATUS1" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOB">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">TRANSFER_JOB</code><em class="property"> = transfer_job</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#TRANSFER_JOB"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOB" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOB_FIELD_MASK">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">TRANSFER_JOB_FIELD_MASK</code><em class="property"> = update_transfer_job_field_mask</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#TRANSFER_JOB_FIELD_MASK"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOB_FIELD_MASK" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOBS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">TRANSFER_JOBS</code><em class="property"> = transferJobs</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#TRANSFER_JOBS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_JOBS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_OPERATIONS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">TRANSFER_OPERATIONS</code><em class="property"> = transferOperations</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#TRANSFER_OPERATIONS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_OPERATIONS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_OPTIONS">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">TRANSFER_OPTIONS</code><em class="property"> = transfer_options</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#TRANSFER_OPTIONS"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_OPTIONS" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_SPEC">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">TRANSFER_SPEC</code><em class="property"> = transferSpec</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#TRANSFER_SPEC"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.TRANSFER_SPEC" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.YEAR">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">YEAR</code><em class="property"> = year</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#YEAR"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.YEAR" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="data">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.NEGATIVE_STATUSES">
<code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">NEGATIVE_STATUSES</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#NEGATIVE_STATUSES"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.NEGATIVE_STATUSES" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook">
<em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.hooks.gcp_transfer_hook.</code><code class="sig-name descname">GCPTransferServiceHook</code><span class="sig-paren">(</span><em class="sig-param">api_version='v1'</em>, <em class="sig-param">gcp_conn_id='google_cloud_default'</em>, <em class="sig-param">delegate_to=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="../gcp_api_base_hook/index.html#airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook" title="airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.contrib.hooks.gcp_api_base_hook.GoogleCloudBaseHook</span></code></a></p>
<p>Hook for Google Storage Transfer Service.</p>
<dl class="attribute">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook._conn">
<code class="sig-name descname">_conn</code><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook._conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook._conn" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_conn">
<code class="sig-name descname">get_conn</code><span class="sig-paren">(</span><em class="sig-param">self</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.get_conn"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_conn" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves connection to Google Storage Transfer service.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>Google Storage Transfer service object</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.create_transfer_job">
<code class="sig-name descname">create_transfer_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">body</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.create_transfer_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.create_transfer_job" title="Permalink to this definition"></a></dt>
<dd><p>Creates a transfer job that runs periodically.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>body</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – (Required) A request body, as described in
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body</a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>transfer job.
See:
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TransferJob">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TransferJob</a></p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_transfer_job">
<code class="sig-name descname">get_transfer_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">job_name</em>, <em class="sig-param">project_id=None</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.get_transfer_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_transfer_job" title="Permalink to this definition"></a></dt>
<dd><p>Gets the latest state of a long-running operation in Google Storage
Transfer Service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>job_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Required) Name of the job to be fetched</p></li>
<li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) the ID of the project that owns the Transfer
Job. If set to None or missing, the default project_id from the GCP
connection is used.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Transfer Job</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.list_transfer_job">
<code class="sig-name descname">list_transfer_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">filter</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.list_transfer_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.list_transfer_job" title="Permalink to this definition"></a></dt>
<dd><p>Lists long-running operations in Google Storage Transfer
Service that match the specified filter.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – (Required) A request filter, as described in
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter</a></p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>List of Transfer Jobs</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.update_transfer_job">
<code class="sig-name descname">update_transfer_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">job_name</em>, <em class="sig-param">body</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.update_transfer_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.update_transfer_job" title="Permalink to this definition"></a></dt>
<dd><p>Updates a transfer job that runs periodically.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>job_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Required) Name of the job to be updated</p></li>
<li><p><strong>body</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – A request body, as described in
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body</a></p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>If successful, TransferJob.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.delete_transfer_job">
<code class="sig-name descname">delete_transfer_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">job_name</em>, <em class="sig-param">project_id</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.delete_transfer_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.delete_transfer_job" title="Permalink to this definition"></a></dt>
<dd><p>Deletes a transfer job. This is a soft delete. After a transfer job is
deleted, the job and all the transfer executions are subject to garbage
collection. Transfer jobs become eligible for garbage collection
30 days after soft delete.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>job_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Required) Name of the job to be deleted</p></li>
<li><p><strong>project_id</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Optional) the ID of the project that owns the Transfer
Job. If set to None or missing, the default project_id from the GCP
connection is used.</p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.cancel_transfer_operation">
<code class="sig-name descname">cancel_transfer_operation</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">operation_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.cancel_transfer_operation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.cancel_transfer_operation" title="Permalink to this definition"></a></dt>
<dd><p>Cancels an transfer operation in Google Storage Transfer Service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>operation_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – Name of the transfer operation.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_transfer_operation">
<code class="sig-name descname">get_transfer_operation</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">operation_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.get_transfer_operation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.get_transfer_operation" title="Permalink to this definition"></a></dt>
<dd><p>Gets an transfer operation in Google Storage Transfer Service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>operation_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Required) Name of the transfer operation.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>transfer operation
See:
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/Operation">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/Operation</a></p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.list_transfer_operations">
<code class="sig-name descname">list_transfer_operations</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">filter</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.list_transfer_operations"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.list_transfer_operations" title="Permalink to this definition"></a></dt>
<dd><p>Gets an transfer operation in Google Storage Transfer Service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>filter</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – <p>(Required) A request filter, as described in
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter</a>
With one additional improvement:</p>
<ul class="simple">
<li><p>project_id is optional if you have a project id defined
in the connection
See: <a class="reference internal" href="../../../../../howto/connection/gcp.html#howto-connection-gcp"><span class="std std-ref">Google Cloud Platform Connection</span></a></p></li>
</ul>
</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>transfer operation</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)">list</a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)">dict</a>]</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.pause_transfer_operation">
<code class="sig-name descname">pause_transfer_operation</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">operation_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.pause_transfer_operation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.pause_transfer_operation" title="Permalink to this definition"></a></dt>
<dd><p>Pauses an transfer operation in Google Storage Transfer Service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>operation_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Required) Name of the transfer operation.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.resume_transfer_operation">
<code class="sig-name descname">resume_transfer_operation</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">operation_name</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.resume_transfer_operation"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.resume_transfer_operation" title="Permalink to this definition"></a></dt>
<dd><p>Resumes an transfer operation in Google Storage Transfer Service.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>operation_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a>) – (Required) Name of the transfer operation.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.wait_for_transfer_job">
<code class="sig-name descname">wait_for_transfer_job</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">job</em>, <em class="sig-param">expected_statuses=(GcpTransferOperationStatus.SUCCESS</em>, <em class="sig-param">)</em>, <em class="sig-param">timeout=60</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.wait_for_transfer_job"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.wait_for_transfer_job" title="Permalink to this definition"></a></dt>
<dd><p>Waits until the job reaches the expected state.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>job</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a>) – Transfer job
See:
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TransferJob">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TransferJob</a></p></li>
<li><p><strong>expected_statuses</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.7)"><em>set</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em>) – State that is expected
See:
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status</a></p></li>
<li><p><strong>timeout</strong> (<em>time in which the operation must end in seconds</em>) – </p></li>
</ul>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.7)">None</a></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook._inject_project_id">
<code class="sig-name descname">_inject_project_id</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">body</em>, <em class="sig-param">param_name</em>, <em class="sig-param">target_key</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook._inject_project_id"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook._inject_project_id" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.operations_contain_expected_statuses">
<em class="property">static </em><code class="sig-name descname">operations_contain_expected_statuses</code><span class="sig-paren">(</span><em class="sig-param">operations</em>, <em class="sig-param">expected_statuses</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/hooks/gcp_transfer_hook.html#GCPTransferServiceHook.operations_contain_expected_statuses"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.hooks.gcp_transfer_hook.GCPTransferServiceHook.operations_contain_expected_statuses" title="Permalink to this definition"></a></dt>
<dd><p>Checks whether the operation list has an operation with the
expected status, then returns true
If it encounters operations in FAILED or ABORTED state
throw <code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.exceptions.AirflowException</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>operations</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.7)"><em>list</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.7)"><em>dict</em></a><em>]</em>) – (Required) List of transfer operations to check.</p></li>
<li><p><strong>expected_statuses</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#set" title="(in Python v3.7)"><em>set</em></a><em>[</em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.7)"><em>str</em></a><em>]</em>) – (Required) status that is expected
See:
<a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status">https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations#Status</a></p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>If there is an operation with the expected state
in the operation list, returns true,</p>
</dd>
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p>airflow.exceptions.AirflowException If it encounters operations
with a state in the list,</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.7)">bool</a></p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="../gcp_translate_hook/index.html" class="btn btn-neutral float-right" title="airflow.contrib.hooks.gcp_translate_hook" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../gcp_text_to_speech_hook/index.html" class="btn btn-neutral float-left" title="airflow.contrib.hooks.gcp_text_to_speech_hook" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<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>