| |
| |
| <!-- |
| Javascript to render AIRFLOW-XXX and PR references in text |
| as HTML links. |
| |
| Overrides extrahead block from sphinx_rtd_theme |
| https://www.sphinx-doc.org/en/master/templating.html |
| --> |
| |
| |
| <!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="shortcut icon" href="../../../../../_static/pin_32.png"/> |
| |
| |
| |
| |
| |
| <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/jira-links.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="stylesheet" href="../../../../../_static/graphviz.css" type="text/css" /> |
| <link rel="stylesheet" href="../../../../../_static/exampleinclude.css" type="text/css" /> |
| <link rel="index" title="Index" href="../../../../../genindex.html" /> |
| <link rel="search" title="Search" href="../../../../../search.html" /> |
| <link rel="next" title="airflow.contrib.operators.qubole_check_operator" href="../qubole_check_operator/index.html" /> |
| <link rel="prev" title="airflow.contrib.operators.postgres_to_gcs_operator" href="../postgres_to_gcs_operator/index.html" /> |
| |
| <script> |
| </script> |
| <style> |
| |
| </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.8 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../project.html">Project</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../license.html">License</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../start.html">Quick Start</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../installation.html">Installation</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../tutorial.html">Tutorial</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../howto/index.html">How-to Guides</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../ui.html">UI / Screenshots</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../concepts.html">Concepts</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../profiling.html">Data Profiling</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../cli.html">Command Line Interface Reference</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="../../../../../executor/index.html">Executor</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../plugins.html">Plugins</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../security.html">Security</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../timezone.html">Time zones</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../api.html">REST API Reference</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../integration.html">Integration</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../metrics.html">Metrics</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../errors.html">Error Tracking</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="../../../../../dag-serialization.html">DAG Serialization</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="../../../../../best-practices.html">Best Practices</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="../../../../../privacy_notice.html">Privacy Notice</a></li> |
| </ul> |
| <p class="caption"><span class="caption-text">References</span></p> |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="reference internal" href="../../../../index.html">Python API</a><ul class="current"> |
| <li class="toctree-l2 current"><a class="reference internal" href="../../../../index.html#operators">Operators</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="../../../../index.html#baseoperator">BaseOperator</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../../../../index.html#basesensoroperator">BaseSensorOperator</a></li> |
| <li class="toctree-l3 current"><a class="reference internal" href="../../../../index.html#operators-packages">Operators packages</a><ul class="current"> |
| <li class="toctree-l4"><a class="reference internal" href="../../../operators/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.operators</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.sensors</span></code></a></li> |
| <li class="toctree-l4 current"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators</span></code></a></li> |
| <li class="toctree-l4"><a class="reference internal" href="../../sensors/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.sensors</span></code></a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#hooks">Hooks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#executors">Executors</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#models">Models</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../../index.html#core-and-community-package">Core and community package</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="../../../../../configurations-ref.html">Configurations</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">Python API Reference</a> »</li> |
| |
| <li><a href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators</span></code></a> »</li> |
| |
| <li><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators.pubsub_operator</span></code></li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="../../../../../_sources/_api/airflow/contrib/operators/pubsub_operator/index.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="module-airflow.contrib.operators.pubsub_operator"> |
| <span id="airflow-contrib-operators-pubsub-operator"></span><h1><a class="reference internal" href="#module-airflow.contrib.operators.pubsub_operator" title="airflow.contrib.operators.pubsub_operator"><code class="xref py py-mod docutils literal notranslate"><span class="pre">airflow.contrib.operators.pubsub_operator</span></code></a><a class="headerlink" href="#module-airflow.contrib.operators.pubsub_operator" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="module-contents"> |
| <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> |
| <dl class="class"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.operators.pubsub_operator.</code><code class="sig-name descname">PubSubTopicCreateOperator</code><span class="sig-paren">(</span><em class="sig-param">project</em>, <em class="sig-param">topic</em>, <em class="sig-param">fail_if_exists=False</em>, <em class="sig-param">gcp_conn_id='google_cloud_default'</em>, <em class="sig-param">delegate_to=None</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicCreateOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../models/index.html#airflow.models.BaseOperator" title="airflow.models.BaseOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.BaseOperator</span></code></a></p> |
| <p>Create a PubSub topic.</p> |
| <p>By default, if the topic already exists, this operator will |
| not cause the DAG to fail.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'successful DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubTopicCreateOperator</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> |
| <span class="n">topic</span><span class="o">=</span><span class="s1">'my_new_topic'</span><span class="p">)</span> |
| <span class="o">>></span> <span class="n">PubSubTopicCreateOperator</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> |
| <span class="n">topic</span><span class="o">=</span><span class="s1">'my_new_topic'</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>The operator can be configured to fail if the topic already exists.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'failing DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubTopicCreateOperator</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> |
| <span class="n">topic</span><span class="o">=</span><span class="s1">'my_new_topic'</span><span class="p">)</span> |
| <span class="o">>></span> <span class="n">PubSubTopicCreateOperator</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> |
| <span class="n">topic</span><span class="o">=</span><span class="s1">'my_new_topic'</span><span class="p">,</span> |
| <span class="n">fail_if_exists</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Both <code class="docutils literal notranslate"><span class="pre">project</span></code> and <code class="docutils literal notranslate"><span class="pre">topic</span></code> are templated so you can use |
| variables in them.</p> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator.template_fields"> |
| <code class="sig-name descname">template_fields</code><em class="property"> = ['project', 'topic']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicCreateOperator.template_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator.template_fields" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator.ui_color"> |
| <code class="sig-name descname">ui_color</code><em class="property"> = #0273d4</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicCreateOperator.ui_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator.ui_color" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator.execute"> |
| <code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">context</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicCreateOperator.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicCreateOperator.execute" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.operators.pubsub_operator.</code><code class="sig-name descname">PubSubSubscriptionCreateOperator</code><span class="sig-paren">(</span><em class="sig-param">topic_project</em>, <em class="sig-param">topic</em>, <em class="sig-param">subscription=None</em>, <em class="sig-param">subscription_project=None</em>, <em class="sig-param">ack_deadline_secs=10</em>, <em class="sig-param">fail_if_exists=False</em>, <em class="sig-param">gcp_conn_id='google_cloud_default'</em>, <em class="sig-param">delegate_to=None</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionCreateOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../models/index.html#airflow.models.BaseOperator" title="airflow.models.BaseOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.BaseOperator</span></code></a></p> |
| <p>Create a PubSub subscription.</p> |
| <p>By default, the subscription will be created in <code class="docutils literal notranslate"><span class="pre">topic_project</span></code>. If |
| <code class="docutils literal notranslate"><span class="pre">subscription_project</span></code> is specified and the GCP credentials allow, the |
| Subscription can be created in a different project from its topic.</p> |
| <p>By default, if the subscription already exists, this operator will |
| not cause the DAG to fail. However, the topic must exist in the project.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'successful DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubSubscriptionCreateOperator</span><span class="p">(</span> |
| <span class="n">topic_project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> <span class="n">topic</span><span class="o">=</span><span class="s1">'my-topic'</span><span class="p">,</span> |
| <span class="n">subscription</span><span class="o">=</span><span class="s1">'my-subscription'</span><span class="p">)</span> |
| <span class="o">>></span> <span class="n">PubSubSubscriptionCreateOperator</span><span class="p">(</span> |
| <span class="n">topic_project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> <span class="n">topic</span><span class="o">=</span><span class="s1">'my-topic'</span><span class="p">,</span> |
| <span class="n">subscription</span><span class="o">=</span><span class="s1">'my-subscription'</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>The operator can be configured to fail if the subscription already exists.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'failing DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubSubscriptionCreateOperator</span><span class="p">(</span> |
| <span class="n">topic_project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> <span class="n">topic</span><span class="o">=</span><span class="s1">'my-topic'</span><span class="p">,</span> |
| <span class="n">subscription</span><span class="o">=</span><span class="s1">'my-subscription'</span><span class="p">)</span> |
| <span class="o">>></span> <span class="n">PubSubSubscriptionCreateOperator</span><span class="p">(</span> |
| <span class="n">topic_project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> <span class="n">topic</span><span class="o">=</span><span class="s1">'my-topic'</span><span class="p">,</span> |
| <span class="n">subscription</span><span class="o">=</span><span class="s1">'my-subscription'</span><span class="p">,</span> <span class="n">fail_if_exists</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Finally, subscription is not required. If not passed, the operator will |
| generated a universally unique identifier for the subscription’s name.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> <span class="o">>></span> <span class="n">PubSubSubscriptionCreateOperator</span><span class="p">(</span> |
| <span class="n">topic_project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> <span class="n">topic</span><span class="o">=</span><span class="s1">'my-topic'</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p><code class="docutils literal notranslate"><span class="pre">topic_project</span></code>, <code class="docutils literal notranslate"><span class="pre">topic</span></code>, <code class="docutils literal notranslate"><span class="pre">subscription</span></code>, and |
| <code class="docutils literal notranslate"><span class="pre">subscription</span></code> are templated so you can use variables in them.</p> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator.template_fields"> |
| <code class="sig-name descname">template_fields</code><em class="property"> = ['topic_project', 'topic', 'subscription', 'subscription_project']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionCreateOperator.template_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator.template_fields" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator.ui_color"> |
| <code class="sig-name descname">ui_color</code><em class="property"> = #0273d4</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionCreateOperator.ui_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator.ui_color" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator.execute"> |
| <code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">context</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionCreateOperator.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionCreateOperator.execute" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.operators.pubsub_operator.</code><code class="sig-name descname">PubSubTopicDeleteOperator</code><span class="sig-paren">(</span><em class="sig-param">project</em>, <em class="sig-param">topic</em>, <em class="sig-param">fail_if_not_exists=False</em>, <em class="sig-param">gcp_conn_id='google_cloud_default'</em>, <em class="sig-param">delegate_to=None</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicDeleteOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../models/index.html#airflow.models.BaseOperator" title="airflow.models.BaseOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.BaseOperator</span></code></a></p> |
| <p>Delete a PubSub topic.</p> |
| <p>By default, if the topic does not exist, this operator will |
| not cause the DAG to fail.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'successful DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubTopicDeleteOperator</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> |
| <span class="n">topic</span><span class="o">=</span><span class="s1">'non_existing_topic'</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>The operator can be configured to fail if the topic does not exist.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'failing DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubTopicCreateOperator</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> |
| <span class="n">topic</span><span class="o">=</span><span class="s1">'non_existing_topic'</span><span class="p">,</span> |
| <span class="n">fail_if_not_exists</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>Both <code class="docutils literal notranslate"><span class="pre">project</span></code> and <code class="docutils literal notranslate"><span class="pre">topic</span></code> are templated so you can use |
| variables in them.</p> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator.template_fields"> |
| <code class="sig-name descname">template_fields</code><em class="property"> = ['project', 'topic']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicDeleteOperator.template_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator.template_fields" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator.ui_color"> |
| <code class="sig-name descname">ui_color</code><em class="property"> = #cb4335</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicDeleteOperator.ui_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator.ui_color" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator.execute"> |
| <code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">context</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubTopicDeleteOperator.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubTopicDeleteOperator.execute" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.operators.pubsub_operator.</code><code class="sig-name descname">PubSubSubscriptionDeleteOperator</code><span class="sig-paren">(</span><em class="sig-param">project</em>, <em class="sig-param">subscription</em>, <em class="sig-param">fail_if_not_exists=False</em>, <em class="sig-param">gcp_conn_id='google_cloud_default'</em>, <em class="sig-param">delegate_to=None</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionDeleteOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../models/index.html#airflow.models.BaseOperator" title="airflow.models.BaseOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.BaseOperator</span></code></a></p> |
| <p>Delete a PubSub subscription.</p> |
| <p>By default, if the subscription does not exist, this operator will |
| not cause the DAG to fail.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'successful DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubSubscriptionDeleteOperator</span><span class="p">(</span><span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> |
| <span class="n">subscription</span><span class="o">=</span><span class="s1">'non-existing'</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p>The operator can be configured to fail if the subscription already exists.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">with</span> <span class="n">DAG</span><span class="p">(</span><span class="s1">'failing DAG'</span><span class="p">)</span> <span class="k">as</span> <span class="n">dag</span><span class="p">:</span> |
| <span class="p">(</span> |
| <span class="n">dag</span> |
| <span class="o">>></span> <span class="n">PubSubSubscriptionDeleteOperator</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span> <span class="n">subscription</span><span class="o">=</span><span class="s1">'non-existing'</span><span class="p">,</span> |
| <span class="n">fail_if_not_exists</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| <span class="p">)</span> |
| </pre></div> |
| </div> |
| <p><code class="docutils literal notranslate"><span class="pre">project</span></code>, and <code class="docutils literal notranslate"><span class="pre">subscription</span></code> are templated so you can use |
| variables in them.</p> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator.template_fields"> |
| <code class="sig-name descname">template_fields</code><em class="property"> = ['project', 'subscription']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionDeleteOperator.template_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator.template_fields" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator.ui_color"> |
| <code class="sig-name descname">ui_color</code><em class="property"> = #cb4335</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionDeleteOperator.ui_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator.ui_color" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator.execute"> |
| <code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">context</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubSubscriptionDeleteOperator.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubSubscriptionDeleteOperator.execute" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubPublishOperator"> |
| <em class="property">class </em><code class="sig-prename descclassname">airflow.contrib.operators.pubsub_operator.</code><code class="sig-name descname">PubSubPublishOperator</code><span class="sig-paren">(</span><em class="sig-param">project</em>, <em class="sig-param">topic</em>, <em class="sig-param">messages</em>, <em class="sig-param">gcp_conn_id='google_cloud_default'</em>, <em class="sig-param">delegate_to=None</em>, <em class="sig-param">*args</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubPublishOperator"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubPublishOperator" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="../../../models/index.html#airflow.models.BaseOperator" title="airflow.models.BaseOperator"><code class="xref py py-class docutils literal notranslate"><span class="pre">airflow.models.BaseOperator</span></code></a></p> |
| <p>Publish messages to a PubSub topic.</p> |
| <p>Each Task publishes all provided messages to the same topic |
| in a single GCP project. If the topic does not exist, this |
| task will fail.</p> |
| <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">base64</span> <span class="kn">import</span> <span class="n">b64encode</span> <span class="k">as</span> <span class="n">b64e</span> |
| |
| <span class="n">m1</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'data'</span><span class="p">:</span> <span class="n">b64e</span><span class="p">(</span><span class="s1">'Hello, World!'</span><span class="p">),</span> |
| <span class="s1">'attributes'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'type'</span><span class="p">:</span> <span class="s1">'greeting'</span><span class="p">}</span> |
| <span class="p">}</span> |
| <span class="n">m2</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'data'</span><span class="p">:</span> <span class="n">b64e</span><span class="p">(</span><span class="s1">'Knock, knock'</span><span class="p">)}</span> |
| <span class="n">m3</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'attributes'</span><span class="p">:</span> <span class="p">{</span><span class="s1">'foo'</span><span class="p">:</span> <span class="s1">''</span><span class="p">}}</span> |
| |
| <span class="n">t1</span> <span class="o">=</span> <span class="n">PubSubPublishOperator</span><span class="p">(</span> |
| <span class="n">project</span><span class="o">=</span><span class="s1">'my-project'</span><span class="p">,</span><span class="n">topic</span><span class="o">=</span><span class="s1">'my_topic'</span><span class="p">,</span> |
| <span class="n">messages</span><span class="o">=</span><span class="p">[</span><span class="n">m1</span><span class="p">,</span> <span class="n">m2</span><span class="p">,</span> <span class="n">m3</span><span class="p">],</span> |
| <span class="n">create_topic</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> |
| <span class="n">dag</span><span class="o">=</span><span class="n">dag</span><span class="p">)</span> |
| </pre></div> |
| </div> |
| <p><code class="docutils literal notranslate"><span class="pre">project</span></code> , <code class="docutils literal notranslate"><span class="pre">topic</span></code>, and <code class="docutils literal notranslate"><span class="pre">messages</span></code> are templated so you can use |
| variables in them.</p> |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubPublishOperator.template_fields"> |
| <code class="sig-name descname">template_fields</code><em class="property"> = ['project', 'topic', 'messages']</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubPublishOperator.template_fields"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubPublishOperator.template_fields" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubPublishOperator.ui_color"> |
| <code class="sig-name descname">ui_color</code><em class="property"> = #0273d4</em><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubPublishOperator.ui_color"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubPublishOperator.ui_color" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="method"> |
| <dt id="airflow.contrib.operators.pubsub_operator.PubSubPublishOperator.execute"> |
| <code class="sig-name descname">execute</code><span class="sig-paren">(</span><em class="sig-param">self</em>, <em class="sig-param">context</em><span class="sig-paren">)</span><a class="reference internal" href="../../../../../_modules/airflow/contrib/operators/pubsub_operator.html#PubSubPublishOperator.execute"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#airflow.contrib.operators.pubsub_operator.PubSubPublishOperator.execute" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| </div> |
| |
| |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="../qubole_check_operator/index.html" class="btn btn-neutral float-right" title="airflow.contrib.operators.qubole_check_operator" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="../postgres_to_gcs_operator/index.html" class="btn btn-neutral float-left" title="airflow.contrib.operators.postgres_to_gcs_operator" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| <div class="footer">This page uses <a href="https://analytics.google.com/"> |
| Google Analytics</a> to collect statistics. You can disable it by blocking |
| the JavaScript coming from www.google-analytics.com. Check our |
| <a href="../../../../../privacy_notice.html">Privacy Policy</a> |
| for more details. |
| </div> |
| |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.Navigation.enable(true); |
| }); |
| </script> |
| |
| |
| |
| |
| <!-- Theme Analytics --> |
| <script> |
| (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ |
| (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), |
| m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) |
| })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); |
| |
| ga('create', 'UA-140539454-1', 'auto'); |
| ga('send', 'pageview'); |
| </script> |
| |
| |
| |
| |
| </body> |
| </html> |
