| |
| |
| <!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.pubsub_operator — Airflow Documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <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 src="../../../../_static/js/modernizr.min.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 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="../../../../lineage.html">Lineage</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="../../../../code.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>airflow.contrib.operators.pubsub_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.pubsub_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="kn">from</span> <span class="nn">airflow.contrib.hooks.gcp_pubsub_hook</span> <span class="k">import</span> <span class="n">PubSubHook</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> |
| |
| |
| <div class="viewcode-block" id="PubSubTopicCreateOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">PubSubTopicCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""Create a PubSub topic.</span> |
| |
| <span class="sd"> By default, if the topic already exists, this operator will</span> |
| <span class="sd"> not cause the DAG to fail. ::</span> |
| |
| <span class="sd"> with DAG('successful DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubTopicCreateOperator(project='my-project',</span> |
| <span class="sd"> topic='my_new_topic')</span> |
| <span class="sd"> >> PubSubTopicCreateOperator(project='my-project',</span> |
| <span class="sd"> topic='my_new_topic')</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> The operator can be configured to fail if the topic already exists. ::</span> |
| |
| <span class="sd"> with DAG('failing DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubTopicCreateOperator(project='my-project',</span> |
| <span class="sd"> topic='my_new_topic')</span> |
| <span class="sd"> >> PubSubTopicCreateOperator(project='my-project',</span> |
| <span class="sd"> topic='my_new_topic',</span> |
| <span class="sd"> fail_if_exists=True)</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> Both ``project`` and ``topic`` are templated so you can use</span> |
| <span class="sd"> variables in them.</span> |
| <span class="sd"> """</span> |
| <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'project'</span><span class="p">,</span> <span class="s1">'topic'</span><span class="p">]</span> |
| <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#0273d4'</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">project</span><span class="p">,</span> |
| <span class="n">topic</span><span class="p">,</span> |
| <span class="n">fail_if_exists</span><span class="o">=</span><span class="kc">False</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="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="sd">"""</span> |
| <span class="sd"> :param project: the GCP project ID where the topic will be created</span> |
| <span class="sd"> :type project: string</span> |
| <span class="sd"> :param topic: the topic to create. Do not include the</span> |
| <span class="sd"> full topic path. In other words, instead of</span> |
| <span class="sd"> ``projects/{project}/topics/{topic}``, provide only</span> |
| <span class="sd"> ``{topic}``. (templated)</span> |
| <span class="sd"> :type topic: string</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to</span> |
| <span class="sd"> Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: string</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</span> |
| <span class="sd"> must have domain-wide delegation enabled.</span> |
| <span class="sd"> :type delegate_to: string</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">PubSubTopicCreateOperator</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">project</span> <span class="o">=</span> <span class="n">project</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">topic</span> <span class="o">=</span> <span class="n">topic</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">fail_if_exists</span> <span class="o">=</span> <span class="n">fail_if_exists</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> |
| |
| <div class="viewcode-block" id="PubSubTopicCreateOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator.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">PubSubHook</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">hook</span><span class="o">.</span><span class="n">create_topic</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">topic</span><span class="p">,</span> |
| <span class="n">fail_if_exists</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">fail_if_exists</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="PubSubSubscriptionCreateOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator">[docs]</a><span class="k">class</span> <span class="nc">PubSubSubscriptionCreateOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""Create a PubSub subscription.</span> |
| |
| <span class="sd"> By default, the subscription will be created in ``topic_project``. If</span> |
| <span class="sd"> ``subscription_project`` is specified and the GCP credentials allow, the</span> |
| <span class="sd"> Subscription can be created in a different project from its topic.</span> |
| |
| <span class="sd"> By default, if the subscription already exists, this operator will</span> |
| <span class="sd"> not cause the DAG to fail. However, the topic must exist in the project. ::</span> |
| |
| <span class="sd"> with DAG('successful DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubSubscriptionCreateOperator(</span> |
| <span class="sd"> topic_project='my-project', topic='my-topic',</span> |
| <span class="sd"> subscription='my-subscription')</span> |
| <span class="sd"> >> PubSubSubscriptionCreateOperator(</span> |
| <span class="sd"> topic_project='my-project', topic='my-topic',</span> |
| <span class="sd"> subscription='my-subscription')</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> The operator can be configured to fail if the subscription already exists.</span> |
| <span class="sd"> ::</span> |
| |
| <span class="sd"> with DAG('failing DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubSubscriptionCreateOperator(</span> |
| <span class="sd"> topic_project='my-project', topic='my-topic',</span> |
| <span class="sd"> subscription='my-subscription')</span> |
| <span class="sd"> >> PubSubSubscriptionCreateOperator(</span> |
| <span class="sd"> topic_project='my-project', topic='my-topic',</span> |
| <span class="sd"> subscription='my-subscription', fail_if_exists=True)</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> Finally, subscription is not required. If not passed, the operator will</span> |
| <span class="sd"> generated a universally unique identifier for the subscription's name. ::</span> |
| |
| <span class="sd"> with DAG('DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag >> PubSubSubscriptionCreateOperator(</span> |
| <span class="sd"> topic_project='my-project', topic='my-topic')</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> ``topic_project``, ``topic``, ``subscription``, and</span> |
| <span class="sd"> ``subscription`` are templated so you can use variables in them.</span> |
| <span class="sd"> """</span> |
| <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'topic_project'</span><span class="p">,</span> <span class="s1">'topic'</span><span class="p">,</span> <span class="s1">'subscription'</span><span class="p">,</span> |
| <span class="s1">'subscription_project'</span><span class="p">]</span> |
| <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#0273d4'</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">topic_project</span><span class="p">,</span> |
| <span class="n">topic</span><span class="p">,</span> |
| <span class="n">subscription</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">subscription_project</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> |
| <span class="n">ack_deadline_secs</span><span class="o">=</span><span class="mi">10</span><span class="p">,</span> |
| <span class="n">fail_if_exists</span><span class="o">=</span><span class="kc">False</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="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="sd">"""</span> |
| <span class="sd"> :param topic_project: the GCP project ID where the topic exists</span> |
| <span class="sd"> :type topic_project: string</span> |
| <span class="sd"> :param topic: the topic to create. Do not include the</span> |
| <span class="sd"> full topic path. In other words, instead of</span> |
| <span class="sd"> ``projects/{project}/topics/{topic}``, provide only</span> |
| <span class="sd"> ``{topic}``. (templated)</span> |
| <span class="sd"> :type topic: string</span> |
| <span class="sd"> :param subscription: the Pub/Sub subscription name. If empty, a random</span> |
| <span class="sd"> name will be generated using the uuid module</span> |
| <span class="sd"> :type subscription: string</span> |
| <span class="sd"> :param subscription_project: the GCP project ID where the subscription</span> |
| <span class="sd"> will be created. If empty, ``topic_project`` will be used.</span> |
| <span class="sd"> :type subscription_project: string</span> |
| <span class="sd"> :param ack_deadline_secs: Number of seconds that a subscriber has to</span> |
| <span class="sd"> acknowledge each message pulled from the subscription</span> |
| <span class="sd"> :type ack_deadline_secs: int</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to</span> |
| <span class="sd"> Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: string</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</span> |
| <span class="sd"> must have domain-wide delegation enabled.</span> |
| <span class="sd"> :type delegate_to: string</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">PubSubSubscriptionCreateOperator</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">topic_project</span> <span class="o">=</span> <span class="n">topic_project</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">topic</span> <span class="o">=</span> <span class="n">topic</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">subscription</span> <span class="o">=</span> <span class="n">subscription</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">subscription_project</span> <span class="o">=</span> <span class="n">subscription_project</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">ack_deadline_secs</span> <span class="o">=</span> <span class="n">ack_deadline_secs</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">fail_if_exists</span> <span class="o">=</span> <span class="n">fail_if_exists</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> |
| |
| <div class="viewcode-block" id="PubSubSubscriptionCreateOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator.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">PubSubHook</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="k">return</span> <span class="n">hook</span><span class="o">.</span><span class="n">create_subscription</span><span class="p">(</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">topic_project</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">topic</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">subscription</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">subscription_project</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">ack_deadline_secs</span><span class="p">,</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">fail_if_exists</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="PubSubTopicDeleteOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">PubSubTopicDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""Delete a PubSub topic.</span> |
| |
| <span class="sd"> By default, if the topic does not exist, this operator will</span> |
| <span class="sd"> not cause the DAG to fail. ::</span> |
| |
| <span class="sd"> with DAG('successful DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubTopicDeleteOperator(project='my-project',</span> |
| <span class="sd"> topic='non_existing_topic')</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> The operator can be configured to fail if the topic does not exist. ::</span> |
| |
| <span class="sd"> with DAG('failing DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubTopicCreateOperator(project='my-project',</span> |
| <span class="sd"> topic='non_existing_topic',</span> |
| <span class="sd"> fail_if_not_exists=True)</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> Both ``project`` and ``topic`` are templated so you can use</span> |
| <span class="sd"> variables in them.</span> |
| <span class="sd"> """</span> |
| <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'project'</span><span class="p">,</span> <span class="s1">'topic'</span><span class="p">]</span> |
| <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#cb4335'</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">project</span><span class="p">,</span> |
| <span class="n">topic</span><span class="p">,</span> |
| <span class="n">fail_if_not_exists</span><span class="o">=</span><span class="kc">False</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="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="sd">"""</span> |
| <span class="sd"> :param project: the GCP project ID in which to work (templated)</span> |
| <span class="sd"> :type project: string</span> |
| <span class="sd"> :param topic: the topic to delete. Do not include the</span> |
| <span class="sd"> full topic path. In other words, instead of</span> |
| <span class="sd"> ``projects/{project}/topics/{topic}``, provide only</span> |
| <span class="sd"> ``{topic}``. (templated)</span> |
| <span class="sd"> :type topic: string</span> |
| <span class="sd"> :param fail_if_not_exists: If True and the topic does not exist, fail</span> |
| <span class="sd"> the task</span> |
| <span class="sd"> :type fail_if_not_exists: bool</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to</span> |
| <span class="sd"> Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: string</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</span> |
| <span class="sd"> must have domain-wide delegation enabled.</span> |
| <span class="sd"> :type delegate_to: string</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">PubSubTopicDeleteOperator</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">project</span> <span class="o">=</span> <span class="n">project</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">topic</span> <span class="o">=</span> <span class="n">topic</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">fail_if_not_exists</span> <span class="o">=</span> <span class="n">fail_if_not_exists</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> |
| |
| <div class="viewcode-block" id="PubSubTopicDeleteOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator.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">PubSubHook</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">hook</span><span class="o">.</span><span class="n">delete_topic</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">topic</span><span class="p">,</span> |
| <span class="n">fail_if_not_exists</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">fail_if_not_exists</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="PubSubSubscriptionDeleteOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator">[docs]</a><span class="k">class</span> <span class="nc">PubSubSubscriptionDeleteOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""Delete a PubSub subscription.</span> |
| |
| <span class="sd"> By default, if the subscription does not exist, this operator will</span> |
| <span class="sd"> not cause the DAG to fail. ::</span> |
| |
| <span class="sd"> with DAG('successful DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubSubscriptionDeleteOperator(project='my-project',</span> |
| <span class="sd"> subscription='non-existing')</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> The operator can be configured to fail if the subscription already exists.</span> |
| |
| <span class="sd"> ::</span> |
| |
| <span class="sd"> with DAG('failing DAG') as dag:</span> |
| <span class="sd"> (</span> |
| <span class="sd"> dag</span> |
| <span class="sd"> >> PubSubSubscriptionDeleteOperator(</span> |
| <span class="sd"> project='my-project', subscription='non-existing',</span> |
| <span class="sd"> fail_if_not_exists=True)</span> |
| <span class="sd"> )</span> |
| |
| <span class="sd"> ``project``, and ``subscription`` are templated so you can use</span> |
| <span class="sd"> variables in them.</span> |
| <span class="sd"> """</span> |
| <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'project'</span><span class="p">,</span> <span class="s1">'subscription'</span><span class="p">]</span> |
| <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#cb4335'</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">project</span><span class="p">,</span> |
| <span class="n">subscription</span><span class="p">,</span> |
| <span class="n">fail_if_not_exists</span><span class="o">=</span><span class="kc">False</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="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="sd">"""</span> |
| <span class="sd"> :param project: the GCP project ID in which to work (templated)</span> |
| <span class="sd"> :type project: string</span> |
| <span class="sd"> :param subscription: the subscription to delete. Do not include the</span> |
| <span class="sd"> full subscription path. In other words, instead of</span> |
| <span class="sd"> ``projects/{project}/subscription/{subscription}``, provide only</span> |
| <span class="sd"> ``{subscription}``. (templated)</span> |
| <span class="sd"> :type subscription: string</span> |
| <span class="sd"> :param fail_if_not_exists: If True and the subscription does not exist,</span> |
| <span class="sd"> fail the task</span> |
| <span class="sd"> :type fail_if_not_exists: bool</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to</span> |
| <span class="sd"> Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: string</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</span> |
| <span class="sd"> must have domain-wide delegation enabled.</span> |
| <span class="sd"> :type delegate_to: string</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">PubSubSubscriptionDeleteOperator</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">project</span> <span class="o">=</span> <span class="n">project</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">subscription</span> <span class="o">=</span> <span class="n">subscription</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">fail_if_not_exists</span> <span class="o">=</span> <span class="n">fail_if_not_exists</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> |
| |
| <div class="viewcode-block" id="PubSubSubscriptionDeleteOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator.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">PubSubHook</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">hook</span><span class="o">.</span><span class="n">delete_subscription</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">subscription</span><span class="p">,</span> |
| <span class="n">fail_if_not_exists</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">fail_if_not_exists</span><span class="p">)</span></div></div> |
| |
| |
| <div class="viewcode-block" id="PubSubPublishOperator"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubPublishOperator">[docs]</a><span class="k">class</span> <span class="nc">PubSubPublishOperator</span><span class="p">(</span><span class="n">BaseOperator</span><span class="p">):</span> |
| <span class="sd">"""Publish messages to a PubSub topic.</span> |
| |
| <span class="sd"> Each Task publishes all provided messages to the same topic</span> |
| <span class="sd"> in a single GCP project. If the topic does not exist, this</span> |
| <span class="sd"> task will fail. ::</span> |
| |
| <span class="sd"> from base64 import b64encode as b64e</span> |
| |
| <span class="sd"> m1 = {'data': b64e('Hello, World!'),</span> |
| <span class="sd"> 'attributes': {'type': 'greeting'}</span> |
| <span class="sd"> }</span> |
| <span class="sd"> m2 = {'data': b64e('Knock, knock')}</span> |
| <span class="sd"> m3 = {'attributes': {'foo': ''}}</span> |
| |
| <span class="sd"> t1 = PubSubPublishOperator(</span> |
| <span class="sd"> project='my-project',topic='my_topic',</span> |
| <span class="sd"> messages=[m1, m2, m3],</span> |
| <span class="sd"> create_topic=True,</span> |
| <span class="sd"> dag=dag)</span> |
| |
| <span class="sd"> ``project`` , ``topic``, and ``messages`` are templated so you can use</span> |
| <span class="sd"> variables in them.</span> |
| <span class="sd"> """</span> |
| <span class="n">template_fields</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'project'</span><span class="p">,</span> <span class="s1">'topic'</span><span class="p">,</span> <span class="s1">'messages'</span><span class="p">]</span> |
| <span class="n">ui_color</span> <span class="o">=</span> <span class="s1">'#0273d4'</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">project</span><span class="p">,</span> |
| <span class="n">topic</span><span class="p">,</span> |
| <span class="n">messages</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="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="sd">"""</span> |
| <span class="sd"> :param project: the GCP project ID in which to work (templated)</span> |
| <span class="sd"> :type project: string</span> |
| <span class="sd"> :param topic: the topic to which to publish. Do not include the</span> |
| <span class="sd"> full topic path. In other words, instead of</span> |
| <span class="sd"> ``projects/{project}/topics/{topic}``, provide only</span> |
| <span class="sd"> ``{topic}``. (templated)</span> |
| <span class="sd"> :type topic: string</span> |
| <span class="sd"> :param messages: a list of messages to be published to the</span> |
| <span class="sd"> topic. Each message is a dict with one or more of the</span> |
| <span class="sd"> following keys-value mappings:</span> |
| <span class="sd"> * 'data': a base64-encoded string</span> |
| <span class="sd"> * 'attributes': {'key1': 'value1', ...}</span> |
| <span class="sd"> Each message must contain at least a non-empty 'data' value</span> |
| <span class="sd"> or an attribute dict with at least one key (templated). See</span> |
| <span class="sd"> https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage</span> |
| <span class="sd"> :type messages: list</span> |
| <span class="sd"> :param gcp_conn_id: The connection ID to use connecting to</span> |
| <span class="sd"> Google Cloud Platform.</span> |
| <span class="sd"> :type gcp_conn_id: string</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</span> |
| <span class="sd"> must have domain-wide delegation enabled.</span> |
| <span class="sd"> :type delegate_to: string</span> |
| <span class="sd"> """</span> |
| <span class="nb">super</span><span class="p">(</span><span class="n">PubSubPublishOperator</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">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">project</span> <span class="o">=</span> <span class="n">project</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">topic</span> <span class="o">=</span> <span class="n">topic</span> |
| <span class="bp">self</span><span class="o">.</span><span class="n">messages</span> <span class="o">=</span> <span class="n">messages</span> |
| |
| <div class="viewcode-block" id="PubSubPublishOperator.execute"><a class="viewcode-back" href="../../../../code.html#airflow.contrib.operators.pubsub_operator.PubSubPublishOperator.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">PubSubHook</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">hook</span><span class="o">.</span><span class="n">publish</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">project</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">topic</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">messages</span><span class="p">)</span></div></div> |
| </pre></div> |
| |
| </div> |
| |
| </div> |
| <footer> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| |
| |
| <script type="text/javascript" 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/js/theme.js"></script> |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| </body> |
| </html> |