Google Git
Sign in
apache / airflow-site / f81e48aadee354653679693fa54b04ac42d24bfd / . / docs-archive / 1.10.4 / _modules / airflow / contrib / sensors / gcs_sensor.html
blob: 0b902c3a7c14c4154d58114d6444cdc767f79518 [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.sensors.gcs_sensor &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>airflow.contrib.sensors.gcs_sensor</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.sensors.gcs_sensor</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">os</span>
<span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">datetime</span>
<span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcs_hook</span> <span class="k">import</span> <span class="n">GoogleCloudStorageHook</span>
<span class="kn">from</span> <span class="nn">airflow.sensors.base_sensor_operator</span> <span class="k">import</span> <span class="n">BaseSensorOperator</span>
<span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span>
<div class="viewcode-block" id="GoogleCloudStorageObjectSensor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectSensor">[docs]</a><span class="k">class</span> <span class="nc">GoogleCloudStorageObjectSensor</span><span class="p">(</span><span class="n">BaseSensorOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks for the existence of a file in Google Cloud Storage.</span>
<span class="sd"> :param bucket: The Google cloud storage bucket where the object is.</span>
<span class="sd"> :type bucket: str</span>
<span class="sd"> :param object: The name of the object to check in the Google cloud</span>
<span class="sd"> storage bucket.</span>
<span class="sd"> :type object: str</span>
<span class="sd"> :param google_cloud_conn_id: The connection ID to use when</span>
<span class="sd"> connecting to Google cloud storage.</span>
<span class="sd"> :type google_cloud_conn_id: str</span>
<span class="sd"> :param delegate_to: The account to impersonate, if any.</span>
<span class="sd"> For this to work, the service account making the request must have</span>
<span class="sd"> domain-wide delegation enabled.</span>
<span class="sd"> :type delegate_to: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="GoogleCloudStorageObjectSensor.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectSensor.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;bucket&#39;</span><span class="p">,</span> <span class="s1">&#39;object&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="GoogleCloudStorageObjectSensor.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectSensor.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">&#39;#f0eee4&#39;</span></div>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">bucket</span><span class="p">,</span>
<span class="nb">object</span><span class="p">,</span> <span class="c1"># pylint:disable=redefined-builtin</span>
<span class="n">google_cloud_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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GoogleCloudStorageObjectSensor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
<span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="nb">object</span>
<span class="bp">self</span><span class="o">.</span><span class="n">google_cloud_conn_id</span> <span class="o">=</span> <span class="n">google_cloud_conn_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">delegate_to</span> <span class="o">=</span> <span class="n">delegate_to</span>
<div class="viewcode-block" id="GoogleCloudStorageObjectSensor.poke"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectSensor.poke">[docs]</a> <span class="k">def</span> <span class="nf">poke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Sensor checks existence of : </span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="p">)</span>
<span class="n">hook</span> <span class="o">=</span> <span class="n">GoogleCloudStorageHook</span><span class="p">(</span>
<span class="n">google_cloud_storage_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">google_cloud_conn_id</span><span class="p">,</span>
<span class="n">delegate_to</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">delegate_to</span><span class="p">)</span>
<span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="p">)</span></div></div>
<div class="viewcode-block" id="ts_function"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.ts_function">[docs]</a><span class="k">def</span> <span class="nf">ts_function</span><span class="p">(</span><span class="n">context</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Default callback for the GoogleCloudStorageObjectUpdatedSensor. The default</span>
<span class="sd"> behaviour is check for the object being updated after execution_date +</span>
<span class="sd"> schedule_interval.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">context</span><span class="p">[</span><span class="s1">&#39;execution_date&#39;</span><span class="p">]</span> <span class="o">+</span> <span class="n">context</span><span class="p">[</span><span class="s1">&#39;dag&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">schedule_interval</span></div>
<div class="viewcode-block" id="GoogleCloudStorageObjectUpdatedSensor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectUpdatedSensor">[docs]</a><span class="k">class</span> <span class="nc">GoogleCloudStorageObjectUpdatedSensor</span><span class="p">(</span><span class="n">BaseSensorOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks if an object is updated in Google Cloud Storage.</span>
<span class="sd"> :param bucket: The Google cloud storage bucket where the object is.</span>
<span class="sd"> :type bucket: str</span>
<span class="sd"> :param object: The name of the object to download in the Google cloud</span>
<span class="sd"> storage bucket.</span>
<span class="sd"> :type object: str</span>
<span class="sd"> :param ts_func: Callback for defining the update condition. The default callback</span>
<span class="sd"> returns execution_date + schedule_interval. The callback takes the context</span>
<span class="sd"> as parameter.</span>
<span class="sd"> :type ts_func: function</span>
<span class="sd"> :param google_cloud_conn_id: The connection ID to use when</span>
<span class="sd"> connecting to Google cloud storage.</span>
<span class="sd"> :type google_cloud_conn_id: str</span>
<span class="sd"> :param delegate_to: The account to impersonate, if any.</span>
<span class="sd"> For this to work, the service account making the request must have domain-wide</span>
<span class="sd"> delegation enabled.</span>
<span class="sd"> :type delegate_to: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="GoogleCloudStorageObjectUpdatedSensor.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectUpdatedSensor.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;bucket&#39;</span><span class="p">,</span> <span class="s1">&#39;object&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="GoogleCloudStorageObjectUpdatedSensor.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectUpdatedSensor.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">&#39;#f0eee4&#39;</span></div>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">bucket</span><span class="p">,</span>
<span class="nb">object</span><span class="p">,</span> <span class="c1"># pylint:disable=redefined-builtin</span>
<span class="n">ts_func</span><span class="o">=</span><span class="n">ts_function</span><span class="p">,</span>
<span class="n">google_cloud_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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GoogleCloudStorageObjectUpdatedSensor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
<span class="bp">self</span><span class="o">.</span><span class="n">object</span> <span class="o">=</span> <span class="nb">object</span>
<span class="bp">self</span><span class="o">.</span><span class="n">ts_func</span> <span class="o">=</span> <span class="n">ts_func</span>
<span class="bp">self</span><span class="o">.</span><span class="n">google_cloud_conn_id</span> <span class="o">=</span> <span class="n">google_cloud_conn_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">delegate_to</span> <span class="o">=</span> <span class="n">delegate_to</span>
<div class="viewcode-block" id="GoogleCloudStorageObjectUpdatedSensor.poke"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectUpdatedSensor.poke">[docs]</a> <span class="k">def</span> <span class="nf">poke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Sensor checks existence of : </span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="p">)</span>
<span class="n">hook</span> <span class="o">=</span> <span class="n">GoogleCloudStorageHook</span><span class="p">(</span>
<span class="n">google_cloud_storage_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">google_cloud_conn_id</span><span class="p">,</span>
<span class="n">delegate_to</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">delegate_to</span><span class="p">)</span>
<span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">is_updated_after</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">object</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ts_func</span><span class="p">(</span><span class="n">context</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="GoogleCloudStoragePrefixSensor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStoragePrefixSensor">[docs]</a><span class="k">class</span> <span class="nc">GoogleCloudStoragePrefixSensor</span><span class="p">(</span><span class="n">BaseSensorOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks for the existence of a objects at prefix in Google Cloud Storage bucket.</span>
<span class="sd"> :param bucket: The Google cloud storage bucket where the object is.</span>
<span class="sd"> :type bucket: str</span>
<span class="sd"> :param prefix: The name of the prefix to check in the Google cloud</span>
<span class="sd"> storage bucket.</span>
<span class="sd"> :type prefix: str</span>
<span class="sd"> :param google_cloud_conn_id: The connection ID to use when</span>
<span class="sd"> connecting to Google cloud storage.</span>
<span class="sd"> :type google_cloud_conn_id: str</span>
<span class="sd"> :param delegate_to: The account to impersonate, if any.</span>
<span class="sd"> For this to work, the service account making the request must have</span>
<span class="sd"> domain-wide delegation enabled.</span>
<span class="sd"> :type delegate_to: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="GoogleCloudStoragePrefixSensor.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStoragePrefixSensor.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;bucket&#39;</span><span class="p">,</span> <span class="s1">&#39;prefix&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="GoogleCloudStoragePrefixSensor.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStoragePrefixSensor.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">&#39;#f0eee4&#39;</span></div>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">bucket</span><span class="p">,</span>
<span class="n">prefix</span><span class="p">,</span>
<span class="n">google_cloud_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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GoogleCloudStoragePrefixSensor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span>
<span class="bp">self</span><span class="o">.</span><span class="n">google_cloud_conn_id</span> <span class="o">=</span> <span class="n">google_cloud_conn_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">delegate_to</span> <span class="o">=</span> <span class="n">delegate_to</span>
<div class="viewcode-block" id="GoogleCloudStoragePrefixSensor.poke"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStoragePrefixSensor.poke">[docs]</a> <span class="k">def</span> <span class="nf">poke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="s1">&#39;Sensor checks existence of objects: </span><span class="si">%s</span><span class="s1">, </span><span class="si">%s</span><span class="s1">&#39;</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">)</span>
<span class="n">hook</span> <span class="o">=</span> <span class="n">GoogleCloudStorageHook</span><span class="p">(</span>
<span class="n">google_cloud_storage_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">google_cloud_conn_id</span><span class="p">,</span>
<span class="n">delegate_to</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">delegate_to</span><span class="p">)</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">hook</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">))</span></div></div>
<div class="viewcode-block" id="get_time"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.get_time">[docs]</a><span class="k">def</span> <span class="nf">get_time</span><span class="p">():</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This is just a wrapper of datetime.datetime.now to simplify mocking in the</span>
<span class="sd"> unittests.</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span></div>
<div class="viewcode-block" id="GoogleCloudStorageUploadSessionCompleteSensor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageUploadSessionCompleteSensor">[docs]</a><span class="k">class</span> <span class="nc">GoogleCloudStorageUploadSessionCompleteSensor</span><span class="p">(</span><span class="n">BaseSensorOperator</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks for changes in the number of objects at prefix in Google Cloud Storage</span>
<span class="sd"> bucket and returns True if the inactivity period has passed with no</span>
<span class="sd"> increase in the number of objects. Note, it is recommended to use reschedule</span>
<span class="sd"> mode if you expect this sensor to run for hours.</span>
<span class="sd"> :param bucket: The Google cloud storage bucket where the objects are.</span>
<span class="sd"> expected.</span>
<span class="sd"> :type bucket: str</span>
<span class="sd"> :param prefix: The name of the prefix to check in the Google cloud</span>
<span class="sd"> storage bucket.</span>
<span class="sd"> :param inactivity_period: The total seconds of inactivity to designate</span>
<span class="sd"> an upload session is over. Note, this mechanism is not real time and</span>
<span class="sd"> this operator may not return until a poke_interval after this period</span>
<span class="sd"> has passed with no additional objects sensed.</span>
<span class="sd"> :type inactivity_period: int</span>
<span class="sd"> :param min_objects: The minimum number of objects needed for upload session</span>
<span class="sd"> to be considered valid.</span>
<span class="sd"> :type min_objects: int</span>
<span class="sd"> :param previous_num_objects: The number of objects found during the last poke.</span>
<span class="sd"> :type previous_num_objects: int</span>
<span class="sd"> :param inactivity_seconds: The current seconds of the inactivity period.</span>
<span class="sd"> :type inactivity_seconds: int</span>
<span class="sd"> :param allow_delete: Should this sensor consider objects being deleted</span>
<span class="sd"> between pokes valid behavior. If true a warning message will be logged</span>
<span class="sd"> when this happens. If false an error will be raised.</span>
<span class="sd"> :type allow_delete: bool</span>
<span class="sd"> :param google_cloud_conn_id: The connection ID to use when connecting</span>
<span class="sd"> to Google cloud storage.</span>
<span class="sd"> :type google_cloud_conn_id: str</span>
<span class="sd"> :param delegate_to: The account to impersonate, if any. For this to work,</span>
<span class="sd"> the service account making the request must have domain-wide</span>
<span class="sd"> delegation enabled.</span>
<span class="sd"> :type delegate_to: str</span>
<span class="sd"> &quot;&quot;&quot;</span>
<div class="viewcode-block" id="GoogleCloudStorageUploadSessionCompleteSensor.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageUploadSessionCompleteSensor.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;bucket&#39;</span><span class="p">,</span> <span class="s1">&#39;prefix&#39;</span><span class="p">)</span></div>
<div class="viewcode-block" id="GoogleCloudStorageUploadSessionCompleteSensor.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageUploadSessionCompleteSensor.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">&#39;#f0eee4&#39;</span></div>
<span class="nd">@apply_defaults</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
<span class="n">bucket</span><span class="p">,</span>
<span class="n">prefix</span><span class="p">,</span>
<span class="n">inactivity_period</span><span class="o">=</span><span class="mi">60</span> <span class="o">*</span> <span class="mi">60</span><span class="p">,</span>
<span class="n">min_objects</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
<span class="n">previous_num_objects</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
<span class="n">allow_delete</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">google_cloud_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="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GoogleCloudStorageUploadSessionCompleteSensor</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
<span class="bp">self</span><span class="o">.</span><span class="n">prefix</span> <span class="o">=</span> <span class="n">prefix</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inactivity_period</span> <span class="o">=</span> <span class="n">inactivity_period</span>
<span class="bp">self</span><span class="o">.</span><span class="n">min_objects</span> <span class="o">=</span> <span class="n">min_objects</span>
<span class="bp">self</span><span class="o">.</span><span class="n">previous_num_objects</span> <span class="o">=</span> <span class="n">previous_num_objects</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inactivity_seconds</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">allow_delete</span> <span class="o">=</span> <span class="n">allow_delete</span>
<span class="bp">self</span><span class="o">.</span><span class="n">google_cloud_conn_id</span> <span class="o">=</span> <span class="n">google_cloud_conn_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">delegate_to</span> <span class="o">=</span> <span class="n">delegate_to</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_activity_time</span> <span class="o">=</span> <span class="kc">None</span>
<div class="viewcode-block" id="GoogleCloudStorageUploadSessionCompleteSensor.is_bucket_updated"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageUploadSessionCompleteSensor.is_bucket_updated">[docs]</a> <span class="k">def</span> <span class="nf">is_bucket_updated</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_num_objects</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Checks whether new objects have been uploaded and the inactivity_period</span>
<span class="sd"> has passed and updates the state of the sensor accordingly.</span>
<span class="sd"> :param current_num_objects: number of objects in bucket during last poke.</span>
<span class="sd"> :type current_num_objects: int</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">if</span> <span class="n">current_num_objects</span> <span class="o">&gt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">previous_num_objects</span><span class="p">:</span>
<span class="c1"># When new objects arrived, reset the inactivity_seconds</span>
<span class="c1"># previous_num_objects for the next poke.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> New objects found at {} resetting last_activity_time.</span>
<span class="sd"> &#39;&#39;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">)))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_activity_time</span> <span class="o">=</span> <span class="n">get_time</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inactivity_seconds</span> <span class="o">=</span> <span class="mi">0</span>
<span class="bp">self</span><span class="o">.</span><span class="n">previous_num_objects</span> <span class="o">=</span> <span class="n">current_num_objects</span>
<span class="k">elif</span> <span class="n">current_num_objects</span> <span class="o">&lt;</span> <span class="bp">self</span><span class="o">.</span><span class="n">previous_num_objects</span><span class="p">:</span>
<span class="c1"># During the last poke interval objects were deleted.</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">allow_delete</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">previous_num_objects</span> <span class="o">=</span> <span class="n">current_num_objects</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_activity_time</span> <span class="o">=</span> <span class="n">get_time</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Objects were deleted during the last</span>
<span class="sd"> poke interval. Updating the file counter and</span>
<span class="sd"> resetting last_activity_time.</span>
<span class="sd"> &#39;&#39;&#39;</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> Illegal behavior: objects were deleted in {} between pokes.</span>
<span class="sd"> &#39;&#39;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">))</span>
<span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_activity_time</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inactivity_seconds</span> <span class="o">=</span> <span class="p">(</span>
<span class="n">get_time</span><span class="p">()</span> <span class="o">-</span> <span class="bp">self</span><span class="o">.</span><span class="n">last_activity_time</span><span class="p">)</span><span class="o">.</span><span class="n">total_seconds</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># Handles the first poke where last inactivity time is None.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">last_activity_time</span> <span class="o">=</span> <span class="n">get_time</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inactivity_seconds</span> <span class="o">=</span> <span class="mi">0</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">inactivity_seconds</span> <span class="o">&gt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">inactivity_period</span><span class="p">:</span>
<span class="k">if</span> <span class="n">current_num_objects</span> <span class="o">&gt;=</span> <span class="bp">self</span><span class="o">.</span><span class="n">min_objects</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">info</span><span class="p">(</span>
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> SUCCESS:</span>
<span class="sd"> Sensor found {} objects at {}.</span>
<span class="sd"> Waited at least {} seconds, with no new objects dropped.</span>
<span class="sd"> &#39;&#39;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">current_num_objects</span><span class="p">,</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">),</span>
<span class="bp">self</span><span class="o">.</span><span class="n">inactivity_period</span><span class="p">))</span>
<span class="k">return</span> <span class="kc">True</span>
<span class="n">warn_msg</span> <span class="o">=</span> \
<span class="sd">&#39;&#39;&#39;</span>
<span class="sd"> FAILURE:</span>
<span class="sd"> Inactivity Period passed,</span>
<span class="sd"> not enough objects found in {}</span>
<span class="sd"> &#39;&#39;&#39;</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">))</span>
<span class="bp">self</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">warn_msg</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">return</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="GoogleCloudStorageUploadSessionCompleteSensor.poke"><a class="viewcode-back" href="../../../../_api/airflow/contrib/sensors/gcs_sensor/index.html#airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageUploadSessionCompleteSensor.poke">[docs]</a> <span class="k">def</span> <span class="nf">poke</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span>
<span class="n">hook</span> <span class="o">=</span> <span class="n">GoogleCloudStorageHook</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_bucket_updated</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">hook</span><span class="o">.</span><span class="n">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">,</span> <span class="n">prefix</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">prefix</span><span class="p">)))</span></div></div>
</pre></div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>