| |
| |
| |
| |
| <!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>Google Cloud Transfer Service Operators — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="../../../_static/js/modernizr.min.js"></script> |
| |
| |
| <script type="text/javascript" id="documentation_options" data-url_root="../../../" src="../../../_static/documentation_options.js"></script> |
| <script type="text/javascript" src="../../../_static/jquery.js"></script> |
| <script type="text/javascript" src="../../../_static/underscore.js"></script> |
| <script type="text/javascript" src="../../../_static/doctools.js"></script> |
| <script type="text/javascript" src="../../../_static/language_data.js"></script> |
| |
| <script type="text/javascript" src="../../../_static/js/theme.js"></script> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../search.html" /> |
| <link rel="next" title="Google Cloud Translate Operators" href="translate.html" /> |
| <link rel="prev" title="Google Cloud Sql Operators" href="sql.html" /> |
| |
| <script> |
| document.addEventListener('DOMContentLoaded', function() { |
| var el = document.getElementById('changelog'); |
| if (el !== null ) { |
| // [AIRFLOW-...] |
| el.innerHTML = el.innerHTML.replace( |
| /\[(AIRFLOW-[\d]+)\]/g, |
| `<a href="https://issues.apache.org/jira/browse/$1">[$1]</a>` |
| ); |
| // (#...) |
| el.innerHTML = el.innerHTML.replace( |
| /\(#([\d]+)\)/g, |
| `<a href="https://github.com/apache/airflow/pull/$1">(#$1)</a>` |
| ); |
| }; |
| }) |
| </script> |
| <style> |
| .example-header { |
| position: relative; |
| background: #9AAA7A; |
| padding: 8px 16px; |
| margin-bottom: 0; |
| } |
| .example-header--with-button { |
| padding-right: 166px; |
| } |
| .example-header:after{ |
| content: ''; |
| display: table; |
| clear: both; |
| } |
| .example-title { |
| display:block; |
| padding: 4px; |
| margin-right: 16px; |
| color: white; |
| overflow-x: auto; |
| } |
| .example-header-button { |
| top: 8px; |
| right: 16px; |
| position: absolute; |
| } |
| .example-header + .highlight-python { |
| margin-top: 0 !important; |
| } |
| .viewcode-button { |
| display: inline-block; |
| padding: 8px 16px; |
| border: 0; |
| margin: 0; |
| outline: 0; |
| border-radius: 2px; |
| -webkit-box-shadow: 0 3px 5px 0 rgba(0,0,0,.3); |
| box-shadow: 0 3px 6px 0 rgba(0,0,0,.3); |
| color: #404040; |
| background-color: #e7e7e7; |
| cursor: pointer; |
| font-size: 16px; |
| font-weight: 500; |
| line-height: 1; |
| text-decoration: none; |
| text-overflow: ellipsis; |
| overflow: hidden; |
| text-transform: uppercase; |
| -webkit-transition: background-color .2s; |
| transition: background-color .2s; |
| vertical-align: middle; |
| white-space: nowrap; |
| } |
| .viewcode-button:visited { |
| color: #404040; |
| } |
| .viewcode-button:hover, .viewcode-button:focus { |
| color: #404040; |
| background-color: #d6d6d6; |
| } |
| </style> |
| |
| </head> |
| |
| <body class="wy-body-for-nav"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search" > |
| |
| |
| |
| <a href="../../../index.html" class="icon icon-home"> Airflow |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 1.10.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 class="current"> |
| <li class="toctree-l1"><a class="reference internal" href="../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">How-to Guides</a><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="../../set-config.html">Setting Configuration Options</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../initialize-database.html">Initializing a Database Backend</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Using Operators</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../bash.html">BashOperator</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../dingding.html">Dingding Operators</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="index.html">Google Cloud Operators</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="bigtable.html">Google Cloud Bigtable Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="compute.html">Google Compute Engine Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="function.html">Google Cloud Functions Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="gcs.html">Google Cloud Storage Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="natural_language.html">Google Cloud Natural Language Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="spanner.html">Google Cloud Spanner Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="sql.html">Google Cloud Sql Operators</a></li> |
| <li class="toctree-l4 current"><a class="current reference internal" href="#">Google Cloud Transfer Service Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="translate.html">Google Cloud Translate Operators</a></li> |
| <li class="toctree-l4"><a class="reference internal" href="vision.html">Google Cloud Vision Operators</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l3"><a class="reference internal" href="../python.html">PythonOperator</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../connection/index.html">Managing Connections</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../secure-connections.html">Securing Connections</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../secure-connections.html#rotating-encryption-keys">Rotating encryption keys</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../write-logs.html">Writing Logs</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../executor/use-celery.html">Scaling Out with Celery</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../executor/use-dask.html">Scaling Out with Dask</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../executor/use-mesos.html">Scaling Out with Mesos (community contributed)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../run-behind-proxy.html">Running Airflow behind a reverse proxy</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../run-with-systemd.html">Running Airflow with systemd</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../run-with-upstart.html">Running Airflow with upstart</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../use-test-config.html">Using the Test Mode Configuration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../check-health.html">Checking Airflow Health Status</a></li> |
| </ul> |
| </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">How-to Guides</a> »</li> |
| |
| <li><a href="../index.html">Using Operators</a> »</li> |
| |
| <li><a href="index.html">Google Cloud Operators</a> »</li> |
| |
| <li>Google Cloud Transfer Service Operators</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../_sources/howto/operator/gcp/transfer.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="google-cloud-transfer-service-operators"> |
| <h1>Google Cloud Transfer Service Operators<a class="headerlink" href="#google-cloud-transfer-service-operators" title="Permalink to this headline">¶</a></h1> |
| <div class="contents local topic" id="contents"> |
| <ul class="simple"> |
| <li><p><a class="reference internal" href="#gcptransferservicejobcreateoperator" id="id33">GcpTransferServiceJobCreateOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferservicejobdeleteoperator" id="id34">GcpTransferServiceJobDeleteOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferservicejobupdateoperator" id="id35">GcpTransferServiceJobUpdateOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferserviceoperationcanceloperator" id="id36">GcpTransferServiceOperationCancelOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferserviceoperationgetoperator" id="id37">GcpTransferServiceOperationGetOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferserviceoperationslistoperator" id="id38">GcpTransferServiceOperationsListOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferserviceoperationpauseoperator" id="id39">GcpTransferServiceOperationPauseOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferserviceoperationresumeoperator" id="id40">GcpTransferServiceOperationResumeOperator</a></p></li> |
| <li><p><a class="reference internal" href="#gcptransferservicewaitforjobstatussensor" id="id41">GCPTransferServiceWaitForJobStatusSensor</a></p></li> |
| </ul> |
| </div> |
| <div class="section" id="gcptransferservicejobcreateoperator"> |
| <span id="howto-operator-gcptransferservicejobcreateoperator"></span><h2><a class="toc-backref" href="#id33">GcpTransferServiceJobCreateOperator</a><a class="headerlink" href="#gcptransferservicejobcreateoperator" title="Permalink to this headline">¶</a></h2> |
| <p>Create a transfer job.</p> |
| <p>The function accepts dates in two formats:</p> |
| <ul> |
| <li><p>consistent with <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TimeOfDay">Google API</a></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"year"</span><span class="p">:</span> <span class="mi">2019</span><span class="p">,</span> <span class="s2">"month"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="s2">"day"</span><span class="p">:</span> <span class="mi">11</span> <span class="p">}</span> |
| </pre></div> |
| </div> |
| </li> |
| <li><p>as an <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.datetime" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">datetime</span></code></a> object</p></li> |
| </ul> |
| <p>The function accepts time in two formats:</p> |
| <ul> |
| <li><p>consistent with <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#TimeOfDay">Google API</a></p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span> <span class="s2">"hours"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span> <span class="s2">"minutes"</span><span class="p">:</span> <span class="mi">30</span><span class="p">,</span> <span class="s2">"seconds"</span><span class="p">:</span> <span class="mi">0</span> <span class="p">}</span> |
| </pre></div> |
| </div> |
| </li> |
| <li><p>as an <a class="reference external" href="https://docs.python.org/3/library/datetime.html#datetime.time" title="(in Python v3.7)"><code class="xref py py-class docutils literal notranslate"><span class="pre">time</span></code></a> object</p></li> |
| </ul> |
| <p>If you want to create a job transfer that copies data from AWS S3 then you must have a connection configured. Information about configuration for AWS is available: <a class="reference internal" href="../../connection/aws.html"><span class="doc">Amazon Web Services Connection</span></a> |
| The selected connection for AWS can be indicated by the parameter <code class="docutils literal notranslate"><span class="pre">aws_conn_id</span></code>.</p> |
| <div class="section" id="arguments"> |
| <h3>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="using-the-operator"> |
| <h3>Using the operator<a class="headerlink" href="#using-the-operator" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">gcs_to_gcs_transfer_body</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">DESCRIPTION</span><span class="p">:</span> <span class="n">GCP_DESCRIPTION</span><span class="p">,</span> |
| <span class="n">STATUS</span><span class="p">:</span> <span class="n">GcpTransferJobsStatus</span><span class="o">.</span><span class="n">ENABLED</span><span class="p">,</span> |
| <span class="n">PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span> |
| <span class="n">SCHEDULE</span><span class="p">:</span> <span class="p">{</span> |
| <span class="n">SCHEDULE_START_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2015</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span> |
| <span class="n">SCHEDULE_END_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2030</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span> |
| <span class="n">START_TIME_OF_DAY</span><span class="p">:</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> |
| <span class="p">},</span> |
| <span class="n">TRANSFER_SPEC</span><span class="p">:</span> <span class="p">{</span> |
| <span class="n">GCS_DATA_SOURCE</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span><span class="p">},</span> |
| <span class="n">GCS_DATA_SINK</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span><span class="p">},</span> |
| <span class="n">TRANSFER_OPTIONS</span><span class="p">:</span> <span class="p">{</span><span class="n">ALREADY_EXISTING_IN_SINK</span><span class="p">:</span> <span class="bp">True</span><span class="p">},</span> |
| <span class="p">},</span> |
| <span class="p">}</span> <span class="c1"># type: Dict[str, Any]</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">aws_to_gcs_transfer_body</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">DESCRIPTION</span><span class="p">:</span> <span class="n">GCP_DESCRIPTION</span><span class="p">,</span> |
| <span class="n">STATUS</span><span class="p">:</span> <span class="n">GcpTransferJobsStatus</span><span class="o">.</span><span class="n">ENABLED</span><span class="p">,</span> |
| <span class="n">PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span> |
| <span class="n">SCHEDULE</span><span class="p">:</span> <span class="p">{</span> |
| <span class="n">SCHEDULE_START_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2015</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span> |
| <span class="n">SCHEDULE_END_DATE</span><span class="p">:</span> <span class="n">datetime</span><span class="p">(</span><span class="mi">2030</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span><span class="o">.</span><span class="n">date</span><span class="p">(),</span> |
| <span class="n">START_TIME_OF_DAY</span><span class="p">:</span> <span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span> <span class="o">+</span> <span class="n">timedelta</span><span class="p">(</span><span class="n">minutes</span><span class="o">=</span><span class="mi">2</span><span class="p">))</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span> |
| <span class="p">},</span> |
| <span class="n">TRANSFER_SPEC</span><span class="p">:</span> <span class="p">{</span> |
| <span class="n">AWS_S3_DATA_SOURCE</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span><span class="p">},</span> |
| <span class="n">GCS_DATA_SINK</span><span class="p">:</span> <span class="p">{</span><span class="n">BUCKET_NAME</span><span class="p">:</span> <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span><span class="p">},</span> |
| <span class="n">TRANSFER_OPTIONS</span><span class="p">:</span> <span class="p">{</span><span class="n">ALREADY_EXISTING_IN_SINK</span><span class="p">:</span> <span class="bp">True</span><span class="p">},</span> |
| <span class="p">},</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">create_transfer_job_from_aws</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobCreateOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"create_transfer_job_from_aws"</span><span class="p">,</span> <span class="n">body</span><span class="o">=</span><span class="n">aws_to_gcs_transfer_body</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="templating"> |
| <h3>Templating<a class="headerlink" href="#templating" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="more-information"> |
| <h3>More information<a class="headerlink" href="#more-information" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/create">Google Cloud Transfer Service - Method: transferJobs.create</a>.</p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferservicejobdeleteoperator"> |
| <span id="howto-operator-gcptransferservicejobdeleteoperator"></span><h2><a class="toc-backref" href="#id34">GcpTransferServiceJobDeleteOperator</a><a class="headerlink" href="#gcptransferservicejobdeleteoperator" title="Permalink to this headline">¶</a></h2> |
| <p>Deletes a transfer job.</p> |
| <div class="section" id="id2"> |
| <h3>Arguments<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id3"> |
| <h3>Using the operator<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">delete_transfer_from_aws_job</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobDeleteOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"delete_transfer_from_aws_job"</span><span class="p">,</span> |
| <span class="n">job_name</span><span class="o">=</span><span class="s2">"{{task_instance.xcom_pull('create_transfer_job_from_aws')['name']}}"</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="n">GCP_PROJECT_ID</span><span class="p">,</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id4"> |
| <h3>Templating<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id5"> |
| <h3>More information<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs#Status">Google Cloud Transfer Service - REST Resource: transferJobs - Status</a></p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferservicejobupdateoperator"> |
| <span id="howto-operator-gcptransferservicejobupdateoperator"></span><h2><a class="toc-backref" href="#id35">GcpTransferServiceJobUpdateOperator</a><a class="headerlink" href="#gcptransferservicejobupdateoperator" title="Permalink to this headline">¶</a></h2> |
| <p>Updates a transfer job.</p> |
| <div class="section" id="id6"> |
| <h3>Arguments<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id7"> |
| <h3>Using the operator<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">update_body</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="n">PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span> |
| <span class="n">TRANSFER_JOB</span><span class="p">:</span> <span class="p">{</span><span class="n">DESCRIPTION</span><span class="p">:</span> <span class="s2">"{}_updated"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">GCP_DESCRIPTION</span><span class="p">)},</span> |
| <span class="n">TRANSFER_JOB_FIELD_MASK</span><span class="p">:</span> <span class="s2">"description"</span><span class="p">,</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">update_job</span> <span class="o">=</span> <span class="n">GcpTransferServiceJobUpdateOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"update_job"</span><span class="p">,</span> |
| <span class="n">job_name</span><span class="o">=</span><span class="s2">"{{task_instance.xcom_pull('create_transfer_job_from_aws')['name']}}"</span><span class="p">,</span> |
| <span class="n">body</span><span class="o">=</span><span class="n">update_body</span><span class="p">,</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id8"> |
| <h3>Templating<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id9"> |
| <h3>More information<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferJobs/patch">Google Cloud Transfer Service - Method: transferJobs.patch</a></p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferserviceoperationcanceloperator"> |
| <span id="howto-operator-gcptransferserviceoperationcanceloperator"></span><h2><a class="toc-backref" href="#id36">GcpTransferServiceOperationCancelOperator</a><a class="headerlink" href="#gcptransferserviceoperationcanceloperator" title="Permalink to this headline">¶</a></h2> |
| <p>Gets a transfer operation. The result is returned to XCOM.</p> |
| <div class="section" id="id10"> |
| <h3>Arguments<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id11"> |
| <h3>Using the operator<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">cancel_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationCancelOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"cancel_operation"</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="s2">"{{task_instance.xcom_pull("</span> |
| <span class="s2">"'wait_for_second_operation_to_start', key='sensed_operations')[0]['name']}}"</span><span class="p">,</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id12"> |
| <h3>Templating<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id13"> |
| <h3>More information<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations/cancel">Google Cloud Transfer Service - Method: transferOperations.cancel</a></p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferserviceoperationgetoperator"> |
| <span id="howto-operator-gcptransferserviceoperationgetoperator"></span><h2><a class="toc-backref" href="#id37">GcpTransferServiceOperationGetOperator</a><a class="headerlink" href="#gcptransferserviceoperationgetoperator" title="Permalink to this headline">¶</a></h2> |
| <p>Gets a transfer operation. The result is returned to XCOM.</p> |
| <div class="section" id="id14"> |
| <h3>Arguments<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id15"> |
| <h3>Using the operator<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">get_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationGetOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"get_operation"</span><span class="p">,</span> <span class="n">operation_name</span><span class="o">=</span><span class="s2">"{{task_instance.xcom_pull('list_operations')[0]['name']}}"</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id16"> |
| <h3>Templating<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id17"> |
| <h3>More information<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations/get">Google Cloud Transfer Service - Method: transferOperations.get</a></p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferserviceoperationslistoperator"> |
| <span id="howto-operator-gcptransferserviceoperationslistoperator"></span><h2><a class="toc-backref" href="#id38">GcpTransferServiceOperationsListOperator</a><a class="headerlink" href="#gcptransferserviceoperationslistoperator" title="Permalink to this headline">¶</a></h2> |
| <p>List a transfer operations. The result is returned to XCOM.</p> |
| <div class="section" id="id18"> |
| <h3>Arguments<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id19"> |
| <h3>Using the operator<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">list_operations</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationsListOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"list_operations"</span><span class="p">,</span> |
| <span class="nb">filter</span><span class="o">=</span><span class="p">{</span> |
| <span class="n">FILTER_PROJECT_ID</span><span class="p">:</span> <span class="n">GCP_PROJECT_ID</span><span class="p">,</span> |
| <span class="n">FILTER_JOB_NAMES</span><span class="p">:</span> <span class="p">[</span><span class="s2">"{{task_instance.xcom_pull('create_transfer_job_from_aws')['name']}}"</span><span class="p">],</span> |
| <span class="p">},</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id20"> |
| <h3>Templating<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id21"> |
| <h3>More information<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations/list">Google Cloud Transfer Service - Method: transferOperations.list</a></p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferserviceoperationpauseoperator"> |
| <span id="howto-operator-gcptransferserviceoperationpauseoperator"></span><h2><a class="toc-backref" href="#id39">GcpTransferServiceOperationPauseOperator</a><a class="headerlink" href="#gcptransferserviceoperationpauseoperator" title="Permalink to this headline">¶</a></h2> |
| <p>Pauses a transfer operations.</p> |
| <div class="section" id="id22"> |
| <h3>Arguments<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id23"> |
| <h3>Using the operator<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">pause_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationPauseOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"pause_operation"</span><span class="p">,</span> |
| <span class="n">operation_name</span><span class="o">=</span><span class="s2">"{{task_instance.xcom_pull('wait_for_operation_to_start', "</span> |
| <span class="s2">"key='sensed_operations')[0]['name']}}"</span><span class="p">,</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id24"> |
| <h3>Templating<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id25"> |
| <h3>More information<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations/pause">Google Cloud Transfer Service - Method: transferOperations.pause</a></p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferserviceoperationresumeoperator"> |
| <span id="howto-operator-gcptransferserviceoperationresumeoperator"></span><h2><a class="toc-backref" href="#id40">GcpTransferServiceOperationResumeOperator</a><a class="headerlink" href="#gcptransferserviceoperationresumeoperator" title="Permalink to this headline">¶</a></h2> |
| <p>Resumes a transfer operations.</p> |
| <div class="section" id="id26"> |
| <h3>Arguments<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id27"> |
| <h3>Using the operator<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">resume_operation</span> <span class="o">=</span> <span class="n">GcpTransferServiceOperationResumeOperator</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"resume_operation"</span><span class="p">,</span> <span class="n">operation_name</span><span class="o">=</span><span class="s2">"{{task_instance.xcom_pull('get_operation')['name']}}"</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id28"> |
| <h3>Templating<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/operators/gcp_transfer_operator.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/operators/gcp_transfer_operator.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><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> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id29"> |
| <h3>More information<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h3> |
| <p>See <a class="reference external" href="https://cloud.google.com/storage-transfer/docs/reference/rest/v1/transferOperations/resume">Google Cloud Transfer Service - Method: transferOperations.resume</a></p> |
| </div> |
| </div> |
| <div class="section" id="gcptransferservicewaitforjobstatussensor"> |
| <h2><a class="toc-backref" href="#id41">GCPTransferServiceWaitForJobStatusSensor</a><a class="headerlink" href="#gcptransferservicewaitforjobstatussensor" title="Permalink to this headline">¶</a></h2> |
| <p>Waits for at least one operation belonging to the job to have the expected status.</p> |
| <div class="section" id="id30"> |
| <h3>Arguments<a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h3> |
| <p>Some arguments in the example DAG are taken from the OS environment variables:</p> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">GCP_PROJECT_ID</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_PROJECT_ID'</span><span class="p">,</span> <span class="s1">'example-project'</span><span class="p">)</span> |
| <span class="n">GCP_DESCRIPTION</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_DESCRIPTION'</span><span class="p">,</span> <span class="s1">'description'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_TARGET_BUCKET'</span><span class="p">)</span> |
| <span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'WAIT_FOR_OPERATION_POKE_INTERVAL'</span><span class="p">,</span> <span class="mi">5</span><span class="p">))</span> |
| |
| <span class="n">GCP_TRANSFER_SOURCE_AWS_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'GCP_TRANSFER_SOURCE_AWS_BUCKET'</span><span class="p">)</span> |
| <span class="n">GCP_TRANSFER_FIRST_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_FIRST_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-first-target'</span> |
| <span class="p">)</span> |
| <span class="n">GCP_TRANSFER_SECOND_TARGET_BUCKET</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span> |
| <span class="s1">'GCP_TRANSFER_SECOND_TARGET_BUCKET'</span><span class="p">,</span> <span class="s1">'gcp-transfer-second-target'</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id31"> |
| <h3>Using the operator<a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/example_dags/example_gcp_transfer.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/example_dags/example_gcp_transfer.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">wait_for_operation_to_end</span> <span class="o">=</span> <span class="n">GCPTransferServiceWaitForJobStatusSensor</span><span class="p">(</span> |
| <span class="n">task_id</span><span class="o">=</span><span class="s2">"wait_for_operation_to_end"</span><span class="p">,</span> |
| <span class="n">job_name</span><span class="o">=</span><span class="s2">"{{task_instance.xcom_pull('create_transfer_job_from_aws')['name']}}"</span><span class="p">,</span> |
| <span class="n">project_id</span><span class="o">=</span><span class="n">GCP_PROJECT_ID</span><span class="p">,</span> |
| <span class="n">expected_statuses</span><span class="o">=</span><span class="p">{</span><span class="n">GcpTransferOperationStatus</span><span class="o">.</span><span class="n">SUCCESS</span><span class="p">},</span> |
| <span class="n">poke_interval</span><span class="o">=</span><span class="n">WAIT_FOR_OPERATION_POKE_INTERVAL</span><span class="p">,</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| <div class="section" id="id32"> |
| <h3>Templating<a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h3> |
| <div class="example-block-wrapper docutils container"> |
| <p class="example-header example-header--with-button"><span class="example-title">airflow/contrib/sensors/gcp_transfer_sensor.py</span><a class="example-header-button viewcode-button reference internal" href="../../../_modules/airflow/contrib/sensors/gcp_transfer_sensor.html"><span>View Source</span></a></p> |
| <div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">template_fields</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'job_name'</span><span class="p">,)</span> |
| </pre></div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="translate.html" class="btn btn-neutral float-right" title="Google Cloud Translate Operators" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="sql.html" class="btn btn-neutral float-left" title="Google Cloud Sql Operators" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| |
| |
| </body> |
| </html> |
