pydoc/2.67.0/apache_beam.io.external.gcp.pubsub.html - beam-site - Git at Google



 <!DOCTYPE html>
 <html class="writer-html5" lang="en" data-content_root="./">
 <head>
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>apache_beam.io.external.gcp.pubsub module &mdash; Apache Beam 2.67.0 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />


       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
       <script src="_static/documentation_options.js?v=959b4fbe"></script>
       <script src="_static/doctools.js?v=9a2dae69"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="apache_beam.io.external.generate_sequence module" href="apache_beam.io.external.generate_sequence.html" />
     <link rel="prev" title="apache_beam.io.external.gcp package" href="apache_beam.io.external.gcp.html" />
 </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">
             Apache Beam
           </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" aria-label="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="Navigation menu">
               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.coders.html">apache_beam.coders package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.dataframe.html">apache_beam.dataframe package</a></li>
 <li class="toctree-l1 current"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a><ul class="current">
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.aws.html">apache_beam.io.aws package</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.azure.html">apache_beam.io.azure package</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.components.html">apache_beam.io.components package</a></li>
 <li class="toctree-l3 current"><a class="reference internal" href="apache_beam.io.external.html">apache_beam.io.external package</a><ul class="current">
 <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.io.external.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="apache_beam.io.external.html#submodules">Submodules</a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.flink.html">apache_beam.io.flink package</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li>
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li>
 </ul>

         </div>
       </div>
     </nav>

     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
           <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
           <a href="index.html">Apache Beam</a>
       </nav>

       <div class="wy-nav-content">
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
           <li class="breadcrumb-item"><a href="apache_beam.io.html">apache_beam.io package</a></li>
           <li class="breadcrumb-item"><a href="apache_beam.io.external.html">apache_beam.io.external package</a></li>
           <li class="breadcrumb-item"><a href="apache_beam.io.external.gcp.html">apache_beam.io.external.gcp package</a></li>
       <li class="breadcrumb-item active">apache_beam.io.external.gcp.pubsub module</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/apache_beam.io.external.gcp.pubsub.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">

   <section id="module-apache_beam.io.external.gcp.pubsub">
 <span id="apache-beam-io-external-gcp-pubsub-module"></span><h1>apache_beam.io.external.gcp.pubsub module<a class="headerlink" href="#module-apache_beam.io.external.gcp.pubsub" title="Link to this heading"></a></h1>
 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.external.gcp.pubsub.</span></span><span class="sig-name descname"><span class="pre">ReadFromPubsubSchema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subscription</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id_label</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_attributes</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp_attribute</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
 <p>Create new instance of ReadFromPubsubSchema(topic, subscription, id_label, with_attributes, timestamp_attribute)</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.id_label">
 <span class="sig-name descname"><span class="pre">id_label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.id_label" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 2</p>
 </dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.subscription">
 <span class="sig-name descname"><span class="pre">subscription</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.subscription" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 1</p>
 </dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.timestamp_attribute">
 <span class="sig-name descname"><span class="pre">timestamp_attribute</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.timestamp_attribute" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 4</p>
 </dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.topic">
 <span class="sig-name descname"><span class="pre">topic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.topic" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 0</p>
 </dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.with_attributes">
 <span class="sig-name descname"><span class="pre">with_attributes</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.13)"><span class="pre">bool</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubsubSchema.with_attributes" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 3</p>
 </dd></dl>

 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubSub">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.external.gcp.pubsub.</span></span><span class="sig-name descname"><span class="pre">ReadFromPubSub</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">subscription</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id_label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp_attribute</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/external/gcp/pubsub.html#ReadFromPubSub"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubSub" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">PTransform</span></code></a></p>
 <p>An external <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for reading from Cloud Pub/Sub.</p>
 <p>Experimental; no backwards compatibility guarantees.  It requires special
 preparation of the Java SDK.  See <a class="reference external" href="https://github.com/apache/beam/issues/19728">https://github.com/apache/beam/issues/19728</a>.</p>
 <p>Initializes <code class="docutils literal notranslate"><span class="pre">ReadFromPubSub</span></code>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>topic</strong> – Cloud Pub/Sub topic in the form
 “projects/&lt;project&gt;/topics/&lt;topic&gt;”. If provided, subscription must be
 None.</p></li>
 <li><p><strong>subscription</strong> – Existing Cloud Pub/Sub subscription to use in the
 form “projects/&lt;project&gt;/subscriptions/&lt;subscription&gt;”. If not
 specified, a temporary subscription will be created from the specified
 topic. If provided, topic must be None.</p></li>
 <li><p><strong>id_label</strong> – The attribute on incoming Pub/Sub messages to use as a unique
 record identifier. When specified, the value of this attribute (which
 can be any string that uniquely identifies the record) will be used for
 deduplication of messages. If not provided, we cannot guarantee
 that no duplicate data will be delivered on the Pub/Sub stream. In this
 case, deduplication of the stream will be strictly best effort.</p></li>
 <li><p><strong>with_attributes</strong> – True - output elements will be
 <a class="reference internal" href="apache_beam.io.gcp.pubsub.html#apache_beam.io.gcp.pubsub.PubsubMessage" title="apache_beam.io.gcp.pubsub.PubsubMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">PubsubMessage</span></code></a> objects.
 False - output elements will be of type <code class="docutils literal notranslate"><span class="pre">bytes</span></code> (message
 data only).</p></li>
 <li><p><strong>timestamp_attribute</strong> – <p>Message value to use as element timestamp. If None,
 uses message publishing time as the timestamp.</p>
 <p>Timestamp values should be in one of two formats:</p>
 <ul>
 <li><p>A numerical value representing the number of milliseconds since the
 Unix epoch.</p></li>
 <li><p>A string in RFC 3339 format, UTC timezone. Example:
 <code class="docutils literal notranslate"><span class="pre">2015-10-29T23:41:41.123Z</span></code>. The sub-second component of the
 timestamp is optional, and digits beyond the first three (i.e., time
 units smaller than milliseconds) may be ignored.</p></li>
 </ul>
 </p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubSub.URN">
 <span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:transform:org.apache.beam:pubsub_read:v1'</span></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubSub.URN" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.ReadFromPubSub.expand">
 <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pbegin</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/external/gcp/pubsub.html#ReadFromPubSub.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.ReadFromPubSub.expand" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.external.gcp.pubsub.</span></span><span class="sig-name descname"><span class="pre">WriteToPubsubSchema</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id_label</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp_attribute</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">tuple</span></code></a></p>
 <p>Create new instance of WriteToPubsubSchema(topic, id_label, timestamp_attribute)</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema.id_label">
 <span class="sig-name descname"><span class="pre">id_label</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema.id_label" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 1</p>
 </dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema.timestamp_attribute">
 <span class="sig-name descname"><span class="pre">timestamp_attribute</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><span class="pre">None</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema.timestamp_attribute" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 2</p>
 </dd></dl>

 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema.topic">
 <span class="sig-name descname"><span class="pre">topic</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)"><span class="pre">str</span></a></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.WriteToPubsubSchema.topic" title="Link to this definition"></a></dt>
 <dd><p>Alias for field number 0</p>
 </dd></dl>

 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.WriteToPubSub">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.io.external.gcp.pubsub.</span></span><span class="sig-name descname"><span class="pre">WriteToPubSub</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">topic</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">with_attributes</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">id_label</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timestamp_attribute</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">expansion_service</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/external/gcp/pubsub.html#WriteToPubSub"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.WriteToPubSub" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">PTransform</span></code></a></p>
 <p>An external <code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for writing messages to Cloud Pub/Sub.</p>
 <p>Experimental; no backwards compatibility guarantees.  It requires special
 preparation of the Java SDK.  See <a class="reference external" href="https://github.com/apache/beam/issues/19728">https://github.com/apache/beam/issues/19728</a>.</p>
 <p>Initializes <code class="docutils literal notranslate"><span class="pre">WriteToPubSub</span></code>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>topic</strong> – Cloud Pub/Sub topic in the form “/topics/&lt;project&gt;/&lt;topic&gt;”.</p></li>
 <li><p><strong>with_attributes</strong> – True - input elements will be
 <a class="reference internal" href="apache_beam.io.gcp.pubsub.html#apache_beam.io.gcp.pubsub.PubsubMessage" title="apache_beam.io.gcp.pubsub.PubsubMessage"><code class="xref py py-class docutils literal notranslate"><span class="pre">PubsubMessage</span></code></a> objects.
 False - input elements will be of type <code class="docutils literal notranslate"><span class="pre">bytes</span></code> (message
 data only).</p></li>
 <li><p><strong>id_label</strong> – If set, will set an attribute for each Cloud Pub/Sub message
 with the given name and a unique value. This attribute can then be used
 in a ReadFromPubSub PTransform to deduplicate messages.</p></li>
 <li><p><strong>timestamp_attribute</strong> – If set, will set an attribute for each Cloud Pub/Sub
 message with the given name and the message’s publish time as the value.</p></li>
 </ul>
 </dd>
 </dl>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.WriteToPubSub.URN">
 <span class="sig-name descname"><span class="pre">URN</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'beam:transform:org.apache.beam:pubsub_write:v1'</span></em><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.WriteToPubSub.URN" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.io.external.gcp.pubsub.WriteToPubSub.expand">
 <span class="sig-name descname"><span class="pre">expand</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pvalue</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/external/gcp/pubsub.html#WriteToPubSub.expand"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.io.external.gcp.pubsub.WriteToPubSub.expand" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 </dd></dl>

 </section>


            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="apache_beam.io.external.gcp.html" class="btn btn-neutral float-left" title="apache_beam.io.external.gcp package" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="apache_beam.io.external.generate_sequence.html" class="btn btn-neutral float-right" title="apache_beam.io.external.generate_sequence module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>

   <hr/>

   <div role="contentinfo">
     <p>&#169; Copyright %Y, Apache Beam.</p>
   </div>

   Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
     <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
     provided by <a href="https://readthedocs.org">Read the Docs</a>.


 </footer>
         </div>
       </div>
     </section>
   </div>
   <script>
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>

 </body>
 </html>