| |
| |
| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>airflow.contrib.operators.gcp_transfer_operator — 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> |
| |
| <script type="application/javascript"> |
| window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; |
| ga("create", "UA-140539454-1", "auto"); |
| ga("send", "pageview"); |
| </script> |
| <script async src="https://www.google-analytics.com/analytics.js"></script> |
| </head> |
| |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.3 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../cli.html">Command Line Interface</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../scheduler.html">Scheduling & 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> »</li> |
| |
| <li><a href="../../../index.html">Module code</a> »</li> |
| |
| <li><a href="../operators.html">airflow.contrib.operators</a> »</li> |
| |
| <li>airflow.contrib.operators.gcp_transfer_operator</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <h1>Source code for airflow.contrib.operators.gcp_transfer_operator</h1><div class="highlight"><pre> |
| <span></span><span class="c1"># -*- coding: utf-8 -*-</span> |
| <span class="c1">#</span> |
| <span class="c1"># Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="c1"># or more contributor license agreements. See the NOTICE file</span> |
| <span class="c1"># distributed with this work for additional information</span> |
| <span class="c1"># regarding copyright ownership. The ASF licenses this file</span> |
| <span class="c1"># to you under the Apache License, Version 2.0 (the</span> |
| <span class="c1"># "License"); 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"># "AS IS" 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="c1">#</span> |
| <span class="kn">from</span> <span class="nn">copy</span> <span class="k">import</span> <span class="n">deepcopy</span> |
| <span class="kn">from</span> <span class="nn">datetime</span> <span class="k">import</span> <span class="n">date</span><span class="p">,</span> <span class="n">time</span> |
| |
| <span class="kn">from</span> <span class="nn">airflow</span> <span class="k">import</span> <span class="n">AirflowException</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_transfer_hook</span> <span class="k">import</span> <span class="p">(</span> |
| <span class="n">GCPTransferServiceHook</span><span class="p">,</span> |
| <span class="n">GcpTransferJobsStatus</span><span class="p">,</span> |
| <span class="n">TRANSFER_OPTIONS</span><span class="p">,</span> |
| <span class="n">OBJECT_CONDITIONS</span><span class="p">,</span> |
| <span class="n">PROJECT_ID</span><span class="p">,</span> |
| <span class="n">BUCKET_NAME</span><span class="p">,</span> |
| <span class="n">GCS_DATA_SINK</span><span class="p">,</span> |
| <span class="n">STATUS</span><span class="p">,</span> |
| <span class="n">DESCRIPTION</span><span class="p">,</span> |
| <span class="n">GCS_DATA_SOURCE</span><span class="p">,</span> |
| <span class="n">HTTP_DATA_SOURCE</span><span class="p">,</span> |
| <span class="n">SECONDS</span><span class="p">,</span> |
| <span class="n">MINUTES</span><span class="p">,</span> |
| <span class="n">HOURS</span><span class="p">,</span> |
| <span class="n">YEAR</span><span class="p">,</span> |
| <span class="n">MONTH</span><span class="p">,</span> |
| <span class="n">DAY</span><span class="p">,</span> |
| <span class="n">START_TIME_OF_DAY</span><span class="p">,</span> |
| <span class="n">SCHEDULE_END_DATE</span><span class="p">,</span> |
| <span class="n">SCHEDULE_START_DATE</span><span class="p">,</span> |
| <span class="n">SCHEDULE</span><span class="p">,</span> |
| <span class="n">SECRET_ACCESS_KEY</span><span class="p">,</span> |
| <span class="n">ACCESS_KEY_ID</span><span class="p">,</span> |
| <span class="n">AWS_ACCESS_KEY</span><span class="p">,</span> |
| <span class="n">AWS_S3_DATA_SOURCE</span><span class="p">,</span> |
| <span class="n">TRANSFER_SPEC</span><span class="p">,</span> |
| <span class="p">)</span> |
| <span class="kn">from</span> <span class="nn">airflow.models</span> <span class="k">import</span> <span class="n">BaseOperator</span> |
| <span class="kn">from</span> <span class="nn">airflow.utils.decorators</span> <span class="k">import</span> <span class="n">apply_defaults</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| <span class="kn">from</span> <span class="nn">airflow.contrib.hooks.aws_hook</span> <span class="k">import</span> <span class="n">AwsHook</span> |
| <span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span> <span class="c1"># pragma: no cover</span> |
| <div class="viewcode-block" id="AwsHook"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.AwsHook">[docs]</a> <span class="n">AwsHook</span> <span class="o">=</span> <span class="kc">None</span> <span class="c1"># type: ignore</span></div> |
| |
| |
| <div class="viewcode-block" id="TransferJobPreprocessor"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor">[docs]</a><span class="k">class</span> <span class="nc">TransferJobPreprocessor</span><span class="p">:</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">body</span><span class="p">,</span> <span class="n">aws_conn_id</span><span class="o">=</span><span class="s1">'aws_default'</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span> <span class="o">=</span> <span class="n">aws_conn_id</span> |
| |
| <div class="viewcode-block" id="TransferJobPreprocessor._inject_aws_credentials"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor._inject_aws_credentials">[docs]</a> <span class="k">def</span> <span class="nf">_inject_aws_credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">TRANSFER_SPEC</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="ow">or</span> <span class="n">AWS_S3_DATA_SOURCE</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">]:</span> |
| <span class="k">return</span> |
| |
| <span class="n">aws_hook</span> <span class="o">=</span> <span class="n">AwsHook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span> |
| <span class="n">aws_credentials</span> <span class="o">=</span> <span class="n">aws_hook</span><span class="o">.</span><span class="n">get_credentials</span><span class="p">()</span> |
| <span class="n">aws_access_key_id</span> <span class="o">=</span> <span class="n">aws_credentials</span><span class="o">.</span><span class="n">access_key</span> |
| <span class="n">aws_secret_access_key</span> <span class="o">=</span> <span class="n">aws_credentials</span><span class="o">.</span><span class="n">secret_key</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">][</span><span class="n">AWS_S3_DATA_SOURCE</span><span class="p">][</span><span class="n">AWS_ACCESS_KEY</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">ACCESS_KEY_ID</span><span class="p">:</span> <span class="n">aws_access_key_id</span><span class="p">,</span> |
| <span class="n">SECRET_ACCESS_KEY</span><span class="p">:</span> <span class="n">aws_secret_access_key</span><span class="p">,</span></div> |
| <span class="p">}</span> |
| |
| <div class="viewcode-block" id="TransferJobPreprocessor._reformat_date"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor._reformat_date">[docs]</a> <span class="k">def</span> <span class="nf">_reformat_date</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_key</span><span class="p">):</span> |
| <span class="n">schedule</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">SCHEDULE</span><span class="p">]</span> |
| <span class="k">if</span> <span class="n">field_key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">schedule</span><span class="p">:</span> |
| <span class="k">return</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">schedule</span><span class="p">[</span><span class="n">field_key</span><span class="p">],</span> <span class="n">date</span><span class="p">):</span> |
| <span class="n">schedule</span><span class="p">[</span><span class="n">field_key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_convert_date_to_dict</span><span class="p">(</span><span class="n">schedule</span><span class="p">[</span><span class="n">field_key</span><span class="p">])</span></div> |
| |
| <div class="viewcode-block" id="TransferJobPreprocessor._reformat_time"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor._reformat_time">[docs]</a> <span class="k">def</span> <span class="nf">_reformat_time</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field_key</span><span class="p">):</span> |
| <span class="n">schedule</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">SCHEDULE</span><span class="p">]</span> |
| <span class="k">if</span> <span class="n">field_key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">schedule</span><span class="p">:</span> |
| <span class="k">return</span> |
| <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">schedule</span><span class="p">[</span><span class="n">field_key</span><span class="p">],</span> <span class="n">time</span><span class="p">):</span> |
| <span class="n">schedule</span><span class="p">[</span><span class="n">field_key</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_convert_time_to_dict</span><span class="p">(</span><span class="n">schedule</span><span class="p">[</span><span class="n">field_key</span><span class="p">])</span></div> |
| |
| <div class="viewcode-block" id="TransferJobPreprocessor._reformat_schedule"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor._reformat_schedule">[docs]</a> <span class="k">def</span> <span class="nf">_reformat_schedule</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">SCHEDULE</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> |
| <span class="k">return</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reformat_date</span><span class="p">(</span><span class="n">SCHEDULE_START_DATE</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reformat_date</span><span class="p">(</span><span class="n">SCHEDULE_END_DATE</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reformat_time</span><span class="p">(</span><span class="n">START_TIME_OF_DAY</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="TransferJobPreprocessor.process_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor.process_body">[docs]</a> <span class="k">def</span> <span class="nf">process_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_inject_aws_credentials</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_reformat_schedule</span><span class="p">()</span> |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="TransferJobPreprocessor._convert_date_to_dict"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor._convert_date_to_dict">[docs]</a> <span class="k">def</span> <span class="nf">_convert_date_to_dict</span><span class="p">(</span><span class="n">field_date</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Convert native python ``datetime.date`` object to a format supported by the API</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="p">{</span><span class="n">DAY</span><span class="p">:</span> <span class="n">field_date</span><span class="o">.</span><span class="n">day</span><span class="p">,</span> <span class="n">MONTH</span><span class="p">:</span> <span class="n">field_date</span><span class="o">.</span><span class="n">month</span><span class="p">,</span> <span class="n">YEAR</span><span class="p">:</span> <span class="n">field_date</span><span class="o">.</span><span class="n">year</span><span class="p">}</span></div> |
| |
| <span class="nd">@staticmethod</span> |
| <div class="viewcode-block" id="TransferJobPreprocessor._convert_time_to_dict"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobPreprocessor._convert_time_to_dict">[docs]</a> <span class="k">def</span> <span class="nf">_convert_time_to_dict</span><span class="p">(</span><span class="n">time</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Convert native python ``datetime.time`` object to a format supported by the API</span> |
| <span class="sd"> """</span> |
| <span class="k">return</span> <span class="p">{</span><span class="n">HOURS</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">hour</span><span class="p">,</span> <span class="n">MINUTES</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">minute</span><span class="p">,</span> <span class="n">SECONDS</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">second</span><span class="p">}</span></div></div> |
| |
| |
| <div class="viewcode-block" id="TransferJobValidator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobValidator">[docs]</a><span class="k">class</span> <span class="nc">TransferJobValidator</span><span class="p">:</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">body</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> |
| |
| <div class="viewcode-block" id="TransferJobValidator._verify_data_source"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobValidator._verify_data_source">[docs]</a> <span class="k">def</span> <span class="nf">_verify_data_source</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">is_gcs</span> <span class="o">=</span> <span class="n">GCS_DATA_SOURCE</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">]</span> |
| <span class="n">is_aws_s3</span> <span class="o">=</span> <span class="n">AWS_S3_DATA_SOURCE</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">]</span> |
| <span class="n">is_http</span> <span class="o">=</span> <span class="n">HTTP_DATA_SOURCE</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">]</span> |
| |
| <span class="n">sources_count</span> <span class="o">=</span> <span class="nb">sum</span><span class="p">([</span><span class="n">is_gcs</span><span class="p">,</span> <span class="n">is_aws_s3</span><span class="p">,</span> <span class="n">is_http</span><span class="p">])</span> |
| <span class="k">if</span> <span class="n">sources_count</span> <span class="o">!=</span> <span class="mi">0</span> <span class="ow">and</span> <span class="n">sources_count</span> <span class="o">!=</span> <span class="mi">1</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"More than one data source detected. Please choose exactly one data source from: "</span></div> |
| <span class="s2">"gcsDataSource, awsS3DataSource and httpDataSource."</span> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="TransferJobValidator._restrict_aws_credentials"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobValidator._restrict_aws_credentials">[docs]</a> <span class="k">def</span> <span class="nf">_restrict_aws_credentials</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="n">AWS_S3_DATA_SOURCE</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">]:</span> |
| <span class="k">return</span> |
| |
| <span class="k">if</span> <span class="n">AWS_ACCESS_KEY</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">][</span><span class="n">AWS_S3_DATA_SOURCE</span><span class="p">]:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span> |
| <span class="s2">"AWS credentials detected inside the body parameter (awsAccessKey). This is not allowed, "</span></div> |
| <span class="s2">"please use Airflow connections to store credentials."</span> |
| <span class="p">)</span> |
| |
| <div class="viewcode-block" id="TransferJobValidator._restrict_empty_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobValidator._restrict_empty_body">[docs]</a> <span class="k">def</span> <span class="nf">_restrict_empty_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'body' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="TransferJobValidator.validate_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.TransferJobValidator.validate_body">[docs]</a> <span class="k">def</span> <span class="nf">validate_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_restrict_empty_body</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">TRANSFER_SPEC</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">:</span> |
| <span class="k">return</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_restrict_aws_credentials</span><span class="p">()</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_verify_data_source</span><span class="p">()</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobCreateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceJobCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Creates a transfer job that runs periodically.</span> |
| |
| <span class="sd"> .. warning::</span> |
| |
| <span class="sd"> This operator is NOT idempotent. If you run it many times, many transfer</span> |
| <span class="sd"> jobs will be created in the Google Cloud Platform.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceJobCreateOperator`</span> |
| |
| <span class="sd"> :param body: (Required) The request body, as described in</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/create#request-body</span> |
| <span class="sd"> With three additional improvements:</span> |
| |
| <span class="sd"> * dates can be given in the form :class:`datetime.date`</span> |
| <span class="sd"> * times can be given in the form :class:`datetime.time`</span> |
| <span class="sd"> * credentials to Amazon Web Service should be stored in the connection and indicated by the</span> |
| <span class="sd"> aws_conn_id parameter</span> |
| |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param aws_conn_id: The connection ID used to retrieve credentials to</span> |
| <span class="sd"> Amazon Web Service.</span> |
| <span class="sd"> :type aws_conn_id: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud</span> |
| <span class="sd"> Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_job_create_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceJobCreateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobCreateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'body'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'aws_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_job_create_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">body</span><span class="p">,</span> |
| <span class="n">aws_conn_id</span><span class="o">=</span><span class="s1">'aws_default'</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</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">GcpTransferServiceJobCreateOperator</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">body</span> <span class="o">=</span> <span class="n">deepcopy</span><span class="p">(</span><span class="n">body</span><span class="p">)</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span> <span class="o">=</span> <span class="n">aws_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobCreateOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobCreateOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">TransferJobValidator</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span><span class="o">.</span><span class="n">validate_body</span><span class="p">()</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobCreateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobCreateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">TransferJobPreprocessor</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">,</span> <span class="n">aws_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span><span class="o">.</span><span class="n">process_body</span><span class="p">()</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">create_transfer_job</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobUpdateOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobUpdateOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceJobUpdateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Updates a transfer job that runs periodically.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceJobUpdateOperator`</span> |
| |
| <span class="sd"> :param job_name: (Required) Name of the job to be updated</span> |
| <span class="sd"> :type job_name: str</span> |
| <span class="sd"> :param body: (Required) The request body, as described in</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch#request-body</span> |
| <span class="sd"> With three additional improvements:</span> |
| |
| <span class="sd"> * dates can be given in the form :class:`datetime.date`</span> |
| <span class="sd"> * times can be given in the form :class:`datetime.time`</span> |
| <span class="sd"> * credentials to Amazon Web Service should be stored in the connection and indicated by the</span> |
| <span class="sd"> aws_conn_id parameter</span> |
| |
| <span class="sd"> :type body: dict</span> |
| <span class="sd"> :param aws_conn_id: The connection ID used to retrieve credentials to</span> |
| <span class="sd"> Amazon Web Service.</span> |
| <span class="sd"> :type aws_conn_id: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud</span> |
| <span class="sd"> Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_job_update_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceJobUpdateOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobUpdateOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'job_name'</span><span class="p">,</span> <span class="s1">'body'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'aws_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_job_update_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">job_name</span><span class="p">,</span> |
| <span class="n">body</span><span class="p">,</span> |
| <span class="n">aws_conn_id</span><span class="o">=</span><span class="s1">'aws_default'</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> |
| <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</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">GcpTransferServiceJobUpdateOperator</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">job_name</span> <span class="o">=</span> <span class="n">job_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">body</span> <span class="o">=</span> <span class="n">body</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span> <span class="o">=</span> <span class="n">aws_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobUpdateOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobUpdateOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">TransferJobValidator</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span><span class="o">.</span><span class="n">validate_body</span><span class="p">()</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'job_name' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobUpdateOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobUpdateOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">TransferJobPreprocessor</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">,</span> <span class="n">aws_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span><span class="o">.</span><span class="n">process_body</span><span class="p">()</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">update_transfer_job</span><span class="p">(</span><span class="n">job_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">body</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobDeleteOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceJobDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Delete a transfer job. This is a soft delete. After a transfer job is</span> |
| <span class="sd"> deleted, the job and all the transfer executions are subject to garbage</span> |
| <span class="sd"> collection. Transfer jobs become eligible for garbage collection</span> |
| <span class="sd"> 30 days after soft delete.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceJobDeleteOperator`</span> |
| |
| <span class="sd"> :param job_name: (Required) Name of the TRANSFER operation</span> |
| <span class="sd"> :type job_name: str</span> |
| <span class="sd"> :param project_id: (Optional) the ID of the project that owns the Transfer</span> |
| <span class="sd"> Job. If set to None or missing, the default project_id from the GCP</span> |
| <span class="sd"> connection is used.</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud</span> |
| <span class="sd"> Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_job_delete_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceJobDeleteOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobDeleteOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'job_name'</span><span class="p">,</span> <span class="s1">'project_id'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_job_delete_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> <span class="n">job_name</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="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">GcpTransferServiceJobDeleteOperator</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">job_name</span> <span class="o">=</span> <span class="n">job_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobDeleteOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobDeleteOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'job_name' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceJobDeleteOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceJobDeleteOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="n">hook</span><span class="o">.</span><span class="n">delete_transfer_job</span><span class="p">(</span><span class="n">job_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">job_name</span><span class="p">,</span> <span class="n">project_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">project_id</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationGetOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationGetOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceOperationGetOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Gets the latest state of a long-running operation in Google Storage Transfer</span> |
| <span class="sd"> Service.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceOperationGetOperator`</span> |
| |
| <span class="sd"> :param operation_name: (Required) Name of the transfer operation.</span> |
| <span class="sd"> :type operation_name: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google</span> |
| <span class="sd"> Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_operation_get_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceOperationGetOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationGetOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'operation_name'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_operation_get_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</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">GcpTransferServiceOperationGetOperator</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">operation_name</span> <span class="o">=</span> <span class="n">operation_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationGetOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationGetOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'operation_name' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationGetOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationGetOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="n">operation</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">get_transfer_operation</span><span class="p">(</span><span class="n">operation_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">operation</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationsListOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationsListOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceOperationsListOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Lists long-running operations in Google Storage Transfer</span> |
| <span class="sd"> Service that match the specified filter.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceOperationsListOperator`</span> |
| |
| <span class="sd"> :param filter: (Required) A request filter, as described in</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/list#body.QUERY_PARAMETERS.filter</span> |
| <span class="sd"> :type filter: dict</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google</span> |
| <span class="sd"> Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_operations_list_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceOperationsListOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationsListOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'filter'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_operations_list_template_fields]</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="nb">filter</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</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">GcpTransferServiceOperationsListOperator</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">filter</span> <span class="o">=</span> <span class="nb">filter</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationsListOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationsListOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">filter</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'filter' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationsListOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationsListOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="n">operations_list</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">list_transfer_operations</span><span class="p">(</span><span class="nb">filter</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">filter</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="n">operations_list</span><span class="p">)</span> |
| <span class="k">return</span> <span class="n">operations_list</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationPauseOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationPauseOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceOperationPauseOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Pauses a transfer operation in Google Storage Transfer Service.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceOperationPauseOperator`</span> |
| |
| <span class="sd"> :param operation_name: (Required) Name of the transfer operation.</span> |
| <span class="sd"> :type operation_name: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_operation_pause_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceOperationPauseOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationPauseOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'operation_name'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_operation_pause_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</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">GcpTransferServiceOperationPauseOperator</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">operation_name</span> <span class="o">=</span> <span class="n">operation_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationPauseOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationPauseOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'operation_name' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationPauseOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationPauseOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="n">hook</span><span class="o">.</span><span class="n">pause_transfer_operation</span><span class="p">(</span><span class="n">operation_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationResumeOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationResumeOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceOperationResumeOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Resumes a transfer operation in Google Storage Transfer Service.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceOperationResumeOperator`</span> |
| |
| <span class="sd"> :param operation_name: (Required) Name of the transfer operation.</span> |
| <span class="sd"> :type operation_name: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google Cloud Platform.</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_operation_resume_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceOperationResumeOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationResumeOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'operation_name'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_operation_resume_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</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">operation_name</span> <span class="o">=</span> <span class="n">operation_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">GcpTransferServiceOperationResumeOperator</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationResumeOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationResumeOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'operation_name' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationResumeOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationResumeOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="n">hook</span><span class="o">.</span><span class="n">resume_transfer_operation</span><span class="p">(</span><span class="n">operation_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationCancelOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationCancelOperator">[docs]</a><span class="k">class</span> <span class="nc">GcpTransferServiceOperationCancelOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Cancels a transfer operation in Google Storage Transfer Service.</span> |
| |
| <span class="sd"> .. seealso::</span> |
| <span class="sd"> For more information on how to use this operator, take a look at the guide:</span> |
| <span class="sd"> :ref:`howto/operator:GcpTransferServiceOperationCancelOperator`</span> |
| |
| <span class="sd"> :param operation_name: (Required) Name of the transfer operation.</span> |
| <span class="sd"> :type operation_name: str</span> |
| <span class="sd"> :param api_version: API version used (e.g. v1).</span> |
| <span class="sd"> :type api_version: str</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID used to connect to Google</span> |
| <span class="sd"> Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: str</span> |
| <span class="sd"> """</span> |
| |
| <span class="c1"># [START gcp_transfer_operation_cancel_template_fields]</span> |
| <div class="viewcode-block" id="GcpTransferServiceOperationCancelOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationCancelOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'operation_name'</span><span class="p">,</span> <span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'api_version'</span><span class="p">)</span></div> |
| <span class="c1"># [END gcp_transfer_operation_cancel_template_fields]</span> |
| |
| <span class="nd">@apply_defaults</span> |
| <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">operation_name</span><span class="p">,</span> <span class="n">api_version</span><span class="o">=</span><span class="s1">'v1'</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</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">GcpTransferServiceOperationCancelOperator</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">operation_name</span> <span class="o">=</span> <span class="n">operation_name</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">api_version</span> <span class="o">=</span> <span class="n">api_version</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">_validate_inputs</span><span class="p">()</span> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationCancelOperator._validate_inputs"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationCancelOperator._validate_inputs">[docs]</a> <span class="k">def</span> <span class="nf">_validate_inputs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">:</span> |
| <span class="k">raise</span> <span class="n">AirflowException</span><span class="p">(</span><span class="s2">"The required parameter 'operation_name' is empty or None"</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GcpTransferServiceOperationCancelOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GcpTransferServiceOperationCancelOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">api_version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">api_version</span><span class="p">,</span> <span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">)</span> |
| <span class="n">hook</span><span class="o">.</span><span class="n">cancel_transfer_operation</span><span class="p">(</span><span class="n">operation_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">operation_name</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="S3ToGoogleCloudStorageTransferOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.S3ToGoogleCloudStorageTransferOperator">[docs]</a><span class="k">class</span> <span class="nc">S3ToGoogleCloudStorageTransferOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Synchronizes an S3 bucket with a Google Cloud Storage bucket using the</span> |
| <span class="sd"> GCP Storage Transfer Service.</span> |
| |
| <span class="sd"> .. warning::</span> |
| |
| <span class="sd"> This operator is NOT idempotent. If you run it many times, many transfer</span> |
| <span class="sd"> jobs will be created in the Google Cloud Platform.</span> |
| |
| <span class="sd"> **Example**:</span> |
| |
| <span class="sd"> .. code-block:: python</span> |
| |
| <span class="sd"> s3_to_gcs_transfer_op = S3ToGoogleCloudStorageTransferOperator(</span> |
| <span class="sd"> task_id='s3_to_gcs_transfer_example',</span> |
| <span class="sd"> s3_bucket='my-s3-bucket',</span> |
| <span class="sd"> project_id='my-gcp-project',</span> |
| <span class="sd"> gcs_bucket='my-gcs-bucket',</span> |
| <span class="sd"> dag=my_dag)</span> |
| |
| <span class="sd"> :param s3_bucket: The S3 bucket where to find the objects. (templated)</span> |
| <span class="sd"> :type s3_bucket: str</span> |
| <span class="sd"> :param gcs_bucket: The destination Google Cloud Storage bucket</span> |
| <span class="sd"> where you want to store the files. (templated)</span> |
| <span class="sd"> :type gcs_bucket: str</span> |
| <span class="sd"> :param project_id: Optional ID of the Google Cloud Platform Console project that</span> |
| <span class="sd"> owns the job</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param aws_conn_id: The source S3 connection</span> |
| <span class="sd"> :type aws_conn_id: str</span> |
| <span class="sd"> :param gcp_conn_id: The destination connection ID to use</span> |
| <span class="sd"> when connecting to Google Cloud Storage.</span> |
| <span class="sd"> :type gcp_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"> :param description: Optional transfer service job description</span> |
| <span class="sd"> :type description: str</span> |
| <span class="sd"> :param schedule: Optional transfer service schedule;</span> |
| <span class="sd"> If not set, run transfer job once as soon as the operator runs</span> |
| <span class="sd"> The format is described</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs.</span> |
| <span class="sd"> With two additional improvements:</span> |
| |
| <span class="sd"> * dates they can be passed as :class:`datetime.date`</span> |
| <span class="sd"> * times they can be passed as :class:`datetime.time`</span> |
| |
| <span class="sd"> :type schedule: dict</span> |
| <span class="sd"> :param object_conditions: Optional transfer service object conditions; see</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec</span> |
| <span class="sd"> :type object_conditions: dict</span> |
| <span class="sd"> :param transfer_options: Optional transfer service transfer options; see</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec</span> |
| <span class="sd"> :type transfer_options: dict</span> |
| <span class="sd"> :param wait: Wait for transfer to finish</span> |
| <span class="sd"> :type wait: bool</span> |
| <span class="sd"> :param timeout: Time to wait for the operation to end in seconds</span> |
| <span class="sd"> :type timeout: int</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="S3ToGoogleCloudStorageTransferOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.S3ToGoogleCloudStorageTransferOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'gcp_conn_id'</span><span class="p">,</span> <span class="s1">'s3_bucket'</span><span class="p">,</span> <span class="s1">'gcs_bucket'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">,</span> <span class="s1">'object_conditions'</span><span class="p">)</span></div> |
| <div class="viewcode-block" id="S3ToGoogleCloudStorageTransferOperator.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.S3ToGoogleCloudStorageTransferOperator.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#e09411'</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">s3_bucket</span><span class="p">,</span> |
| <span class="n">gcs_bucket</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">aws_conn_id</span><span class="o">=</span><span class="s1">'aws_default'</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</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="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">schedule</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">object_conditions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">transfer_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">wait</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">timeout</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">S3ToGoogleCloudStorageTransferOperator</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">s3_bucket</span> <span class="o">=</span> <span class="n">s3_bucket</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcs_bucket</span> <span class="o">=</span> <span class="n">gcs_bucket</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span> <span class="o">=</span> <span class="n">aws_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">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">description</span> <span class="o">=</span> <span class="n">description</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">schedule</span> <span class="o">=</span> <span class="n">schedule</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">object_conditions</span> <span class="o">=</span> <span class="n">object_conditions</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">transfer_options</span> <span class="o">=</span> <span class="n">transfer_options</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">wait</span> <span class="o">=</span> <span class="n">wait</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| |
| <div class="viewcode-block" id="S3ToGoogleCloudStorageTransferOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.S3ToGoogleCloudStorageTransferOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">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="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_body</span><span class="p">()</span> |
| |
| <span class="n">TransferJobPreprocessor</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">,</span> <span class="n">aws_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">aws_conn_id</span><span class="p">)</span><span class="o">.</span><span class="n">process_body</span><span class="p">()</span> |
| |
| <span class="n">job</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">create_transfer_job</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait</span><span class="p">:</span> |
| <span class="n">hook</span><span class="o">.</span><span class="n">wait_for_transfer_job</span><span class="p">(</span><span class="n">job</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="S3ToGoogleCloudStorageTransferOperator._create_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.S3ToGoogleCloudStorageTransferOperator._create_body">[docs]</a> <span class="k">def</span> <span class="nf">_create_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">body</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">DESCRIPTION</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="p">,</span> |
| <span class="n">STATUS</span><span class="p">:</span> <span class="n">GcpTransferJobsStatus</span><span class="o">.</span><span class="n">ENABLED</span><span class="p">,</span> |
| <span class="n">TRANSFER_SPEC</span><span class="p">:</span> <span class="p">{</span> |
| <span class="n">AWS_S3_DATA_SOURCE</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">s3_bucket</span><span class="p">},</span> |
| <span class="n">GCS_DATA_SINK</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">gcs_bucket</span><span class="p">},</span> |
| <span class="p">},</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">PROJECT_ID</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">schedule</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">SCHEDULE</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">schedule</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">object_conditions</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">][</span><span class="n">OBJECT_CONDITIONS</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">object_conditions</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">transfer_options</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">][</span><span class="n">TRANSFER_OPTIONS</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transfer_options</span> |
| |
| <span class="k">return</span> <span class="n">body</span></div></div> |
| |
| |
| <div class="viewcode-block" id="GoogleCloudStorageToGoogleCloudStorageTransferOperator"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GoogleCloudStorageToGoogleCloudStorageTransferOperator">[docs]</a><span class="k">class</span> <span class="nc">GoogleCloudStorageToGoogleCloudStorageTransferOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""</span> |
| <span class="sd"> Copies objects from a bucket to another using the GCP Storage Transfer</span> |
| <span class="sd"> Service.</span> |
| |
| <span class="sd"> .. warning::</span> |
| |
| <span class="sd"> This operator is NOT idempotent. If you run it many times, many transfer</span> |
| <span class="sd"> jobs will be created in the Google Cloud Platform.</span> |
| |
| <span class="sd"> **Example**:</span> |
| |
| <span class="sd"> .. code-block:: python</span> |
| |
| <span class="sd"> gcs_to_gcs_transfer_op = GoogleCloudStorageToGoogleCloudStorageTransferOperator(</span> |
| <span class="sd"> task_id='gcs_to_gcs_transfer_example',</span> |
| <span class="sd"> source_bucket='my-source-bucket',</span> |
| <span class="sd"> destination_bucket='my-destination-bucket',</span> |
| <span class="sd"> project_id='my-gcp-project',</span> |
| <span class="sd"> dag=my_dag)</span> |
| |
| <span class="sd"> :param source_bucket: The source Google cloud storage bucket where the</span> |
| <span class="sd"> object is. (templated)</span> |
| <span class="sd"> :type source_bucket: str</span> |
| <span class="sd"> :param destination_bucket: The destination Google cloud storage bucket</span> |
| <span class="sd"> where the object should be. (templated)</span> |
| <span class="sd"> :type destination_bucket: str</span> |
| <span class="sd"> :param project_id: The ID of the Google Cloud Platform Console project that</span> |
| <span class="sd"> owns the job</span> |
| <span class="sd"> :type project_id: str</span> |
| <span class="sd"> :param gcp_conn_id: Optional connection ID to use when connecting to Google Cloud</span> |
| <span class="sd"> Storage.</span> |
| <span class="sd"> :type gcp_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"> :param description: Optional transfer service job description</span> |
| <span class="sd"> :type description: str</span> |
| <span class="sd"> :param schedule: Optional transfer service schedule;</span> |
| <span class="sd"> If not set, run transfer job once as soon as the operator runs</span> |
| <span class="sd"> See:</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs.</span> |
| <span class="sd"> With two additional improvements:</span> |
| |
| <span class="sd"> * dates they can be passed as :class:`datetime.date`</span> |
| <span class="sd"> * times they can be passed as :class:`datetime.time`</span> |
| |
| <span class="sd"> :type schedule: dict</span> |
| <span class="sd"> :param object_conditions: Optional transfer service object conditions; see</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#ObjectConditions</span> |
| <span class="sd"> :type object_conditions: dict</span> |
| <span class="sd"> :param transfer_options: Optional transfer service transfer options; see</span> |
| <span class="sd"> https://cloud.google.com/storage-transfer/docs/reference/rest/v1/TransferSpec#TransferOptions</span> |
| <span class="sd"> :type transfer_options: dict</span> |
| <span class="sd"> :param wait: Wait for transfer to finish; defaults to `True`</span> |
| <span class="sd"> :type wait: bool</span> |
| <span class="sd"> :param timeout: Time to wait for the operation to end in seconds</span> |
| <span class="sd"> :type timeout: int</span> |
| <span class="sd"> """</span> |
| |
| <div class="viewcode-block" id="GoogleCloudStorageToGoogleCloudStorageTransferOperator.template_fields"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GoogleCloudStorageToGoogleCloudStorageTransferOperator.template_fields">[docs]</a> <span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span> |
| <span class="s1">'gcp_conn_id'</span><span class="p">,</span> |
| <span class="s1">'source_bucket'</span><span class="p">,</span> |
| <span class="s1">'destination_bucket'</span><span class="p">,</span> |
| <span class="s1">'description'</span><span class="p">,</span> |
| <span class="s1">'object_conditions'</span><span class="p">,</span></div> |
| <span class="p">)</span> |
| <div class="viewcode-block" id="GoogleCloudStorageToGoogleCloudStorageTransferOperator.ui_color"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GoogleCloudStorageToGoogleCloudStorageTransferOperator.ui_color">[docs]</a> <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#e09411'</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">source_bucket</span><span class="p">,</span> |
| <span class="n">destination_bucket</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">gcp_conn_id</span><span class="o">=</span><span class="s1">'google_cloud_default'</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="n">description</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">schedule</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">object_conditions</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">transfer_options</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">wait</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">timeout</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">GoogleCloudStorageToGoogleCloudStorageTransferOperator</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">source_bucket</span> <span class="o">=</span> <span class="n">source_bucket</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">destination_bucket</span> <span class="o">=</span> <span class="n">destination_bucket</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="o">=</span> <span class="n">project_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span> <span class="o">=</span> <span class="n">gcp_conn_id</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">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">description</span> <span class="o">=</span> <span class="n">description</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">schedule</span> <span class="o">=</span> <span class="n">schedule</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">object_conditions</span> <span class="o">=</span> <span class="n">object_conditions</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">transfer_options</span> <span class="o">=</span> <span class="n">transfer_options</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">wait</span> <span class="o">=</span> <span class="n">wait</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">timeout</span> <span class="o">=</span> <span class="n">timeout</span> |
| |
| <div class="viewcode-block" id="GoogleCloudStorageToGoogleCloudStorageTransferOperator.execute"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GoogleCloudStorageToGoogleCloudStorageTransferOperator.execute">[docs]</a> <span class="k">def</span> <span class="nf">execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">context</span><span class="p">):</span> |
| <span class="n">hook</span> <span class="o">=</span> <span class="n">GCPTransferServiceHook</span><span class="p">(</span><span class="n">gcp_conn_id</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">gcp_conn_id</span><span class="p">,</span> <span class="n">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="n">body</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_create_body</span><span class="p">()</span> |
| |
| <span class="n">TransferJobPreprocessor</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span><span class="o">.</span><span class="n">process_body</span><span class="p">()</span> |
| |
| <span class="n">job</span> <span class="o">=</span> <span class="n">hook</span><span class="o">.</span><span class="n">create_transfer_job</span><span class="p">(</span><span class="n">body</span><span class="o">=</span><span class="n">body</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait</span><span class="p">:</span> |
| <span class="n">hook</span><span class="o">.</span><span class="n">wait_for_transfer_job</span><span class="p">(</span><span class="n">job</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">timeout</span><span class="p">)</span></div> |
| |
| <div class="viewcode-block" id="GoogleCloudStorageToGoogleCloudStorageTransferOperator._create_body"><a class="viewcode-back" href="../../../../_api/airflow/contrib/operators/gcp_transfer_operator/index.html#airflow.contrib.operators.gcp_transfer_operator.GoogleCloudStorageToGoogleCloudStorageTransferOperator._create_body">[docs]</a> <span class="k">def</span> <span class="nf">_create_body</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span> |
| <span class="n">body</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">DESCRIPTION</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">description</span><span class="p">,</span> |
| <span class="n">STATUS</span><span class="p">:</span> <span class="n">GcpTransferJobsStatus</span><span class="o">.</span><span class="n">ENABLED</span><span class="p">,</span> |
| <span class="n">TRANSFER_SPEC</span><span class="p">:</span> <span class="p">{</span> |
| <span class="n">GCS_DATA_SOURCE</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">source_bucket</span><span class="p">},</span> |
| <span class="n">GCS_DATA_SINK</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">destination_bucket</span><span class="p">},</span> |
| <span class="p">},</span> |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">PROJECT_ID</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">project_id</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">schedule</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">SCHEDULE</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">schedule</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">object_conditions</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">][</span><span class="n">OBJECT_CONDITIONS</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">object_conditions</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">transfer_options</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| <span class="n">body</span><span class="p">[</span><span class="n">TRANSFER_SPEC</span><span class="p">][</span><span class="n">TRANSFER_OPTIONS</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">transfer_options</span> |
| |
| <span class="k">return</span> <span class="n">body</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> |
