pydoc/2.68.0/apache_beam.transforms.display.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.transforms.display module &mdash; Apache Beam 2.68.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=2388e03a"></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.transforms.enrichment module" href="apache_beam.transforms.enrichment.html" />
     <link rel="prev" title="apache_beam.transforms.deduplicate module" href="apache_beam.transforms.deduplicate.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"><a class="reference internal" href="apache_beam.io.html">apache_beam.io package</a></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 current"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a><ul class="current">
 <li class="toctree-l2"><a class="reference internal" href="apache_beam.transforms.html#subpackages">Subpackages</a></li>
 <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.transforms.html#submodules">Submodules</a><ul class="current">
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.async_dofn.html">apache_beam.transforms.async_dofn module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combinefn_lifecycle_pipeline.html">apache_beam.transforms.combinefn_lifecycle_pipeline module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.combiners.html">apache_beam.transforms.combiners module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.core.html">apache_beam.transforms.core module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.create_source.html">apache_beam.transforms.create_source module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.deduplicate.html">apache_beam.transforms.deduplicate module</a></li>
 <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.transforms.display module</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData"><code class="docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem"><code class="docutils literal notranslate"><span class="pre">DisplayDataItem</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#apache_beam.transforms.display.DisplayData"><code class="docutils literal notranslate"><span class="pre">DisplayData</span></code></a></li>
 </ul>
 </li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.enrichment.html">apache_beam.transforms.enrichment module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.environments.html">apache_beam.transforms.environments module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.error_handling.html">apache_beam.transforms.error_handling module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external.html">apache_beam.transforms.external module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_java.html">apache_beam.transforms.external_java module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.external_transform_provider.html">apache_beam.transforms.external_transform_provider module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.fully_qualified_named_transform.html">apache_beam.transforms.fully_qualified_named_transform module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.managed.html">apache_beam.transforms.managed module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.periodicsequence.html">apache_beam.transforms.periodicsequence module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.ptransform.html">apache_beam.transforms.ptransform module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.resources.html">apache_beam.transforms.resources module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sideinputs.html">apache_beam.transforms.sideinputs module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.sql.html">apache_beam.transforms.sql module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.stats.html">apache_beam.transforms.stats module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.timeutil.html">apache_beam.transforms.timeutil module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.trigger.html">apache_beam.transforms.trigger module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.userstate.html">apache_beam.transforms.userstate module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.util.html">apache_beam.transforms.util module</a></li>
 <li class="toctree-l3"><a class="reference internal" href="apache_beam.transforms.window.html">apache_beam.transforms.window module</a></li>
 </ul>
 </li>
 </ul>
 </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.transforms.html">apache_beam.transforms package</a></li>
       <li class="breadcrumb-item active">apache_beam.transforms.display module</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/apache_beam.transforms.display.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.transforms.display">
 <span id="apache-beam-transforms-display-module"></span><h1>apache_beam.transforms.display module<a class="headerlink" href="#module-apache_beam.transforms.display" title="Link to this heading"></a></h1>
 <p><a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayData</span></code></a>, its classes, interfaces and methods.</p>
 <p>The classes in this module allow users and transform developers to define
 static display data to be displayed when a pipeline runs.
 <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> s,
 <a class="reference internal" href="apache_beam.transforms.core.html#apache_beam.transforms.core.DoFn" title="apache_beam.transforms.core.DoFn"><code class="xref py py-class docutils literal notranslate"><span class="pre">DoFn</span></code></a> s
 and other pipeline components are subclasses of the <a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a>
 mixin. To add static display data to a component, you can override the
 <a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData.display_data" title="apache_beam.transforms.display.HasDisplayData.display_data"><code class="xref py py-meth docutils literal notranslate"><span class="pre">HasDisplayData.display_data()</span></code></a> method.</p>
 <p>Available classes:</p>
 <ul class="simple">
 <li><p><a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a> - Components that inherit from this class can have
 static display data shown in the UI.</p></li>
 <li><p><a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem" title="apache_beam.transforms.display.DisplayDataItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayDataItem</span></code></a> - This class represents static display data
 elements.</p></li>
 <li><p><a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayData</span></code></a> - Internal class that is used to create display data
 and communicate it to the API.</p></li>
 </ul>
 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.HasDisplayData">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.display.</span></span><span class="sig-name descname"><span class="pre">HasDisplayData</span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#HasDisplayData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.HasDisplayData" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Basic mixin for elements that contain display data.</p>
 <p>It implements only the display_data method and a
 _get_display_data_namespace method.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.HasDisplayData.display_data">
 <span class="sig-name descname"><span class="pre">display_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#HasDisplayData.display_data"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.HasDisplayData.display_data" title="Link to this definition"></a></dt>
 <dd><p>Returns the display data associated to a pipeline component.</p>
 <p>It should be reimplemented in pipeline components that wish to have
 static display data.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p><p>A dictionary containing <code class="docutils literal notranslate"><span class="pre">key:value</span></code> pairs.
 The value might be an integer, float or string value; a
 <a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem" title="apache_beam.transforms.display.DisplayDataItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayDataItem</span></code></a> for values that have more data
 (e.g. short value, label, url); or a <a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a> instance
 that has more display data that should be picked up. For example:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">{</span>
   <span class="s1">&#39;key1&#39;</span><span class="p">:</span> <span class="s1">&#39;string_value&#39;</span><span class="p">,</span>
   <span class="s1">&#39;key2&#39;</span><span class="p">:</span> <span class="mi">1234</span><span class="p">,</span>
   <span class="s1">&#39;key3&#39;</span><span class="p">:</span> <span class="mf">3.14159265</span><span class="p">,</span>
   <span class="s1">&#39;key4&#39;</span><span class="p">:</span> <span class="n">DisplayDataItem</span><span class="p">(</span><span class="s1">&#39;apache.org&#39;</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="s1">&#39;http://apache.org&#39;</span><span class="p">),</span>
   <span class="s1">&#39;key5&#39;</span><span class="p">:</span> <span class="n">subComponent</span>
 <span class="p">}</span>
 </pre></div>
 </div>
 </p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p>Dict[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, Any]</p>
 </dd>
 </dl>
 </dd></dl>

 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayDataItem">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.display.</span></span><span class="sig-name descname"><span class="pre">DisplayDataItem</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">url</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">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">namespace</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">key</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">shortValue</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/transforms/display.html#DisplayDataItem"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayDataItem" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>A DisplayDataItem represents a unit of static display data.</p>
 <p>Each item is identified by a key and the namespace of the component the
 display item belongs to.</p>
 <dl class="py attribute">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayDataItem.typeDict">
 <span class="sig-name descname"><span class="pre">typeDict</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{&lt;class</span> <span class="pre">'bool'&gt;:</span> <span class="pre">'BOOLEAN',</span> <span class="pre">&lt;class</span> <span class="pre">'datetime.datetime'&gt;:</span> <span class="pre">'TIMESTAMP',</span> <span class="pre">&lt;class</span> <span class="pre">'datetime.timedelta'&gt;:</span> <span class="pre">'DURATION',</span> <span class="pre">&lt;class</span> <span class="pre">'float'&gt;:</span> <span class="pre">'FLOAT',</span> <span class="pre">&lt;class</span> <span class="pre">'int'&gt;:</span> <span class="pre">'INTEGER',</span> <span class="pre">&lt;class</span> <span class="pre">'str'&gt;:</span> <span class="pre">'STRING'}</span></em><a class="headerlink" href="#apache_beam.transforms.display.DisplayDataItem.typeDict" title="Link to this definition"></a></dt>
 <dd></dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayDataItem.drop_if_none">
 <span class="sig-name descname"><span class="pre">drop_if_none</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem" title="apache_beam.transforms.display.DisplayDataItem"><span class="pre">DisplayDataItem</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayDataItem.drop_if_none"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayDataItem.drop_if_none" title="Link to this definition"></a></dt>
 <dd><p>The item should be dropped if its value is None.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>Returns self.</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayDataItem.drop_if_default">
 <span class="sig-name descname"><span class="pre">drop_if_default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">default</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem" title="apache_beam.transforms.display.DisplayDataItem"><span class="pre">DisplayDataItem</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayDataItem.drop_if_default"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayDataItem.drop_if_default" title="Link to this definition"></a></dt>
 <dd><p>The item should be dropped if its value is equal to its default.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>Returns self.</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayDataItem.should_drop">
 <span class="sig-name descname"><span class="pre">should_drop</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><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></span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayDataItem.should_drop"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayDataItem.should_drop" title="Link to this definition"></a></dt>
 <dd><p>Return True if the item should be dropped, or False if it should not
 be dropped. This depends on the drop_if_none, and drop_if_default calls.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>True or False; depending on whether the item should be dropped or kept.</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayDataItem.is_valid">
 <span class="sig-name descname"><span class="pre">is_valid</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><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></span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayDataItem.is_valid"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayDataItem.is_valid" title="Link to this definition"></a></dt>
 <dd><p>Checks that all the necessary fields of the <a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem" title="apache_beam.transforms.display.DisplayDataItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayDataItem</span></code></a>
 are filled in. It checks that neither key, namespace, value or type are
 <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.13)"><code class="xref py py-data docutils literal notranslate"><span class="pre">None</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – If the item does not have a key, namespace,
     value or type.</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayDataItem.get_dict">
 <span class="sig-name descname"><span class="pre">get_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a></span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayDataItem.get_dict"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayDataItem.get_dict" title="Link to this definition"></a></dt>
 <dd><p>Returns the internal-API dictionary representing the
 <a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem" title="apache_beam.transforms.display.DisplayDataItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayDataItem</span></code></a>.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>A dictionary. The internal-API dictionary representing
 the <a class="reference internal" href="#apache_beam.transforms.display.DisplayDataItem" title="apache_beam.transforms.display.DisplayDataItem"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayDataItem</span></code></a>.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p>Dict[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.13)">str</a>, Any]</p>
 </dd>
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – if the item is not valid.</p>
 </dd>
 </dl>
 </dd></dl>

 </dd></dl>

 <dl class="py class">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayData">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">apache_beam.transforms.display.</span></span><span class="sig-name descname"><span class="pre">DisplayData</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">namespace</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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></em>, <em class="sig-param"><span class="n"><span class="pre">display_data_dict</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.13)"><span class="pre">dict</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayData"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayData" title="Link to this definition"></a></dt>
 <dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/functions.html#object" title="(in Python v3.13)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Static display data associated with a pipeline component.</p>
 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayData.to_proto">
 <span class="sig-name descname"><span class="pre">to_proto</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.List" title="(in Python v3.13)"><span class="pre">List</span></a><span class="p"><span class="pre">[</span></span><span class="pre">DisplayData</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayData.to_proto"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayData.to_proto" title="Link to this definition"></a></dt>
 <dd><p>Returns a List of Beam proto representation of Display data.</p>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayData.create_from_options">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from_options</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">pipeline_options</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/transforms/display.html#DisplayData.create_from_options"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayData.create_from_options" title="Link to this definition"></a></dt>
 <dd><p>Creates <a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayData</span></code></a> from a
 <a class="reference internal" href="apache_beam.options.pipeline_options.html#apache_beam.options.pipeline_options.PipelineOptions" title="apache_beam.options.pipeline_options.PipelineOptions"><code class="xref py py-class docutils literal notranslate"><span class="pre">PipelineOptions</span></code></a> instance.</p>
 <p>When creating <a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayData</span></code></a>, this
 method will convert the value of any item of a non-supported type to its
 string representation.
 The normal <a class="reference internal" href="#apache_beam.transforms.display.DisplayData.create_from" title="apache_beam.transforms.display.DisplayData.create_from"><code class="xref py py-meth docutils literal notranslate"><span class="pre">create_from()</span></code></a> method rejects those items.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>A <a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayData</span></code></a> instance with
 populated items.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><em>DisplayData</em></a></p>
 </dd>
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – If the <strong>has_display_data</strong> argument is
     not an instance of <a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a>.</p>
 </dd>
 </dl>
 </dd></dl>

 <dl class="py method">
 <dt class="sig sig-object py" id="apache_beam.transforms.display.DisplayData.create_from">
 <em class="property"><span class="pre">classmethod</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">create_from</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">has_display_data</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">extra_items</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/transforms/display.html#DisplayData.create_from"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#apache_beam.transforms.display.DisplayData.create_from" title="Link to this definition"></a></dt>
 <dd><p>Creates <a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayData</span></code></a> from a
 <a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a> instance.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
 <dd class="field-odd"><p>A <a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">DisplayData</span></code></a> instance with
 populated items.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference internal" href="#apache_beam.transforms.display.DisplayData" title="apache_beam.transforms.display.DisplayData"><em>DisplayData</em></a></p>
 </dd>
 <dt class="field-odd">Raises<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.13)"><strong>ValueError</strong></a> – If the <strong>has_display_data</strong> argument is
     not an instance of <a class="reference internal" href="#apache_beam.transforms.display.HasDisplayData" title="apache_beam.transforms.display.HasDisplayData"><code class="xref py py-class docutils literal notranslate"><span class="pre">HasDisplayData</span></code></a>.</p>
 </dd>
 </dl>
 </dd></dl>

 </dd></dl>

 </section>


            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="apache_beam.transforms.deduplicate.html" class="btn btn-neutral float-left" title="apache_beam.transforms.deduplicate module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="apache_beam.transforms.enrichment.html" class="btn btn-neutral float-right" title="apache_beam.transforms.enrichment 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>