pydoc/2.23.0/apache_beam.io.gcp.datastore.v1new.types.html - beam-site - Git at Google



 <!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>apache_beam.io.gcp.datastore.v1new.types module &mdash; Apache Beam  documentation</title>


   <script type="text/javascript" src="_static/js/modernizr.min.js"></script>


       <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
         <script type="text/javascript" src="_static/jquery.js"></script>
         <script type="text/javascript" src="_static/underscore.js"></script>
         <script type="text/javascript" src="_static/doctools.js"></script>
         <script type="text/javascript" src="_static/language_data.js"></script>

     <script type="text/javascript" src="_static/js/theme.js"></script>


   <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
   <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="apache_beam.io.gcp.datastore.v1new.util module" href="apache_beam.io.gcp.datastore.v1new.util.html" />
     <link rel="prev" title="apache_beam.io.gcp.datastore.v1new.query_splitter module" href="apache_beam.io.gcp.datastore.v1new.query_splitter.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" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
 </div>


         </div>

         <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">


               <ul class="current">
 <li class="toctree-l1"><a class="reference internal" href="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.internal.html">apache_beam.internal 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.external.html">apache_beam.io.external package</a></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 current"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a><ul class="current">
 <li class="toctree-l4 current"><a class="reference internal" href="apache_beam.io.gcp.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="apache_beam.io.gcp.html#submodules">Submodules</a></li>
 </ul>
 </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.tools.html">apache_beam.tools 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>
 </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>
 <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version 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="top navigation">

           <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="breadcrumbs navigation">

   <ul class="wy-breadcrumbs">

       <li><a href="index.html">Docs</a> &raquo;</li>

           <li><a href="apache_beam.io.html">apache_beam.io package</a> &raquo;</li>

           <li><a href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a> &raquo;</li>

           <li><a href="apache_beam.io.gcp.datastore.html">apache_beam.io.gcp.datastore package</a> &raquo;</li>

           <li><a href="apache_beam.io.gcp.datastore.v1new.html">apache_beam.io.gcp.datastore.v1new package</a> &raquo;</li>

       <li>apache_beam.io.gcp.datastore.v1new.types module</li>


       <li class="wy-breadcrumbs-aside">


             <a href="_sources/apache_beam.io.gcp.datastore.v1new.types.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-apache_beam.io.gcp.datastore.v1new.types">
 <span id="apache-beam-io-gcp-datastore-v1new-types-module"></span><h1>apache_beam.io.gcp.datastore.v1new.types module<a class="headerlink" href="#module-apache_beam.io.gcp.datastore.v1new.types" title="Permalink to this headline">¶</a></h1>
 <p>Beam Datastore types.</p>
 <dl class="class">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Query">
 <em class="property">class </em><code class="descclassname">apache_beam.io.gcp.datastore.v1new.types.</code><code class="descname">Query</code><span class="sig-paren">(</span><em>kind=None</em>, <em>project=None</em>, <em>namespace=None</em>, <em>ancestor=None</em>, <em>filters=()</em>, <em>projection=()</em>, <em>order=()</em>, <em>distinct_on=()</em>, <em>limit=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Query" title="Permalink 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Represents a Datastore query.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>kind</strong> – (str) The kind to query.</li>
 <li><strong>project</strong> – (str) Required. Project associated with query.</li>
 <li><strong>namespace</strong> – (str, ValueProvider(str)) (Optional) Namespace to restrict
 results to.</li>
 <li><strong>ancestor</strong> – (<a class="reference internal" href="#apache_beam.io.gcp.datastore.v1new.types.Key" title="apache_beam.io.gcp.datastore.v1new.types.Key"><code class="xref py py-class docutils literal notranslate"><span class="pre">Key</span></code></a>)
 (Optional) key of the ancestor to which this query’s results are
 restricted.</li>
 <li><strong>filters</strong> – (sequence of tuple[str, str, str],
 sequence of
 tuple[ValueProvider(str), ValueProvider(str), ValueProvider(str)])
 Property filters applied by this query.
 The sequence is <code class="docutils literal notranslate"><span class="pre">(property_name,</span> <span class="pre">operator,</span> <span class="pre">value)</span></code>.</li>
 <li><strong>projection</strong> – (sequence of string) fields returned as part of query results.</li>
 <li><strong>order</strong> – (sequence of string) field names used to order query results.
 Prepend <code class="docutils literal notranslate"><span class="pre">-</span></code> to a field name to sort it in descending order.</li>
 <li><strong>distinct_on</strong> – (sequence of string) field names used to group query
 results.</li>
 <li><strong>limit</strong> – (int) Maximum amount of results to return.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Query.clone">
 <code class="descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Query.clone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Query.clone" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Key">
 <em class="property">class </em><code class="descclassname">apache_beam.io.gcp.datastore.v1new.types.</code><code class="descname">Key</code><span class="sig-paren">(</span><em>path_elements</em>, <em>parent=None</em>, <em>project=None</em>, <em>namespace=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Key" title="Permalink 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Represents a Datastore key.</p>
 <p>The partition ID is represented by its components: namespace and project.
 If key has a parent, project and namespace should either be unset or match
 the parent’s.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>path_elements</strong> – (list of str and int) Key path: an alternating sequence of
 kind and identifier. The kind must be of type <code class="docutils literal notranslate"><span class="pre">str</span></code> and identifier may
 be a <code class="docutils literal notranslate"><span class="pre">str</span></code> or an <code class="docutils literal notranslate"><span class="pre">int</span></code>.
 If the last identifier is omitted this is an incomplete key, which is
 unsupported in <code class="docutils literal notranslate"><span class="pre">WriteToDatastore</span></code> and <code class="docutils literal notranslate"><span class="pre">DeleteFromDatastore</span></code>.
 See <a class="reference external" href="https://googleapis.dev/python/datastore/latest/keys.html#google.cloud.datastore.key.Key" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.key.Key</span></code></a> for more details.</li>
 <li><strong>parent</strong> – (<a class="reference internal" href="#apache_beam.io.gcp.datastore.v1new.types.Key" title="apache_beam.io.gcp.datastore.v1new.types.Key"><code class="xref py py-class docutils literal notranslate"><span class="pre">Key</span></code></a>)
 (optional) Parent for this key.</li>
 <li><strong>project</strong> – (str) Project ID. Required unless set by parent.</li>
 <li><strong>namespace</strong> – (str) (optional) Namespace ID</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="staticmethod">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Key.from_client_key">
 <em class="property">static </em><code class="descname">from_client_key</code><span class="sig-paren">(</span><em>client_key</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Key.from_client_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Key.from_client_key" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Key.to_client_key">
 <code class="descname">to_client_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Key.to_client_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Key.to_client_key" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns a <a class="reference external" href="https://googleapis.dev/python/datastore/latest/keys.html#google.cloud.datastore.key.Key" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.key.Key</span></code></a> instance that represents
 this key.</p>
 </dd></dl>

 </dd></dl>

 <dl class="class">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Entity">
 <em class="property">class </em><code class="descclassname">apache_beam.io.gcp.datastore.v1new.types.</code><code class="descname">Entity</code><span class="sig-paren">(</span><em>key</em>, <em>exclude_from_indexes=()</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity" title="Permalink 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Represents a Datastore entity.</p>
 <p>Does not support the property value “meaning” field.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><strong>key</strong> – (Key) A complete Key representing this Entity.</li>
 <li><strong>exclude_from_indexes</strong> – (iterable of str) List of property keys whose values
 should not be indexed for this entity.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="method">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Entity.set_properties">
 <code class="descname">set_properties</code><span class="sig-paren">(</span><em>property_dict</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity.set_properties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity.set_properties" title="Permalink to this definition">¶</a></dt>
 <dd><p>Sets a dictionary of properties on this entity.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
 <tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>property_dict</strong> – A map from property name to value. See
 <a class="reference external" href="https://googleapis.dev/python/datastore/latest/entities.html#google.cloud.datastore.entity.Entity" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.entity.Entity</span></code></a> documentation for allowed
 values.</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="staticmethod">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Entity.from_client_entity">
 <em class="property">static </em><code class="descname">from_client_entity</code><span class="sig-paren">(</span><em>client_entity</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity.from_client_entity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity.from_client_entity" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.datastore.v1new.types.Entity.to_client_entity">
 <code class="descname">to_client_entity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity.to_client_entity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity.to_client_entity" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns a <a class="reference external" href="https://googleapis.dev/python/datastore/latest/entities.html#google.cloud.datastore.entity.Entity" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.entity.Entity</span></code></a> instance that
 represents this entity.</p>
 </dd></dl>

 </dd></dl>

 </div>


            </div>

           </div>
           <footer>

     <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

         <a href="apache_beam.io.gcp.datastore.v1new.util.html" class="btn btn-neutral float-right" title="apache_beam.io.gcp.datastore.v1new.util module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.io.gcp.datastore.v1new.query_splitter.html" class="btn btn-neutral float-left" title="apache_beam.io.gcp.datastore.v1new.query_splitter module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

     </div>


   <hr/>

   <div role="contentinfo">
     <p>
         &copy; Copyright

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

 </footer>

         </div>
       </div>

     </section>

   </div>


   <script type="text/javascript">
       jQuery(function () {
           SphinxRtdTheme.Navigation.enable(true);
       });
   </script>


 </body>
 </html>


	<!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>apache_beam.io.gcp.datastore.v1new.types module — Apache Beam documentation</title>








	<script type="text/javascript" src="_static/js/modernizr.min.js"></script>


	<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
	<script type="text/javascript" src="_static/jquery.js"></script>
	<script type="text/javascript" src="_static/underscore.js"></script>
	<script type="text/javascript" src="_static/doctools.js"></script>
	<script type="text/javascript" src="_static/language_data.js"></script>

	<script type="text/javascript" src="_static/js/theme.js"></script>




	<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
	<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
	<link rel="index" title="Index" href="genindex.html" />
	<link rel="search" title="Search" href="search.html" />
	<link rel="next" title="apache_beam.io.gcp.datastore.v1new.util module" href="apache_beam.io.gcp.datastore.v1new.util.html" />
	<link rel="prev" title="apache_beam.io.gcp.datastore.v1new.query_splitter module" href="apache_beam.io.gcp.datastore.v1new.query_splitter.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" />
	<input type="hidden" name="check_keywords" value="yes" />
	<input type="hidden" name="area" value="default" />
	</form>
	</div>


	</div>

	<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">






	<ul class="current">
	<li class="toctree-l1"><a class="reference internal" href="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.internal.html">apache_beam.internal 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.external.html">apache_beam.io.external package</a></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 current"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a><ul class="current">
	<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.io.gcp.html#subpackages">Subpackages</a></li>
	<li class="toctree-l4"><a class="reference internal" href="apache_beam.io.gcp.html#submodules">Submodules</a></li>
	</ul>
	</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.tools.html">apache_beam.tools 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>
	</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>
	<li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version 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="top navigation">

	<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="breadcrumbs navigation">

	<ul class="wy-breadcrumbs">

	<li><a href="index.html">Docs</a> »</li>

	<li><a href="apache_beam.io.html">apache_beam.io package</a> »</li>

	<li><a href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a> »</li>

	<li><a href="apache_beam.io.gcp.datastore.html">apache_beam.io.gcp.datastore package</a> »</li>

	<li><a href="apache_beam.io.gcp.datastore.v1new.html">apache_beam.io.gcp.datastore.v1new package</a> »</li>

	<li>apache_beam.io.gcp.datastore.v1new.types module</li>


	<li class="wy-breadcrumbs-aside">


	<a href="_sources/apache_beam.io.gcp.datastore.v1new.types.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-apache_beam.io.gcp.datastore.v1new.types">
	<span id="apache-beam-io-gcp-datastore-v1new-types-module"></span><h1>apache_beam.io.gcp.datastore.v1new.types module<a class="headerlink" href="#module-apache_beam.io.gcp.datastore.v1new.types" title="Permalink to this headline">¶</a></h1>
	<p>Beam Datastore types.</p>
	<dl class="class">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Query">
	<em class="property">class </em><code class="descclassname">apache_beam.io.gcp.datastore.v1new.types.</code><code class="descname">Query</code><span class="sig-paren">(</span><em>kind=None</em>, <em>project=None</em>, <em>namespace=None</em>, <em>ancestor=None</em>, <em>filters=()</em>, <em>projection=()</em>, <em>order=()</em>, <em>distinct_on=()</em>, <em>limit=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Query"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Query" title="Permalink 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
	<p>Represents a Datastore query.</p>
	<table class="docutils field-list" frame="void" rules="none">
	<col class="field-name" />
	<col class="field-body" />
	<tbody valign="top">
	<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
	<li><strong>kind</strong> – (str) The kind to query.</li>
	<li><strong>project</strong> – (str) Required. Project associated with query.</li>
	<li><strong>namespace</strong> – (str, ValueProvider(str)) (Optional) Namespace to restrict
	results to.</li>
	<li><strong>ancestor</strong> – (<a class="reference internal" href="#apache_beam.io.gcp.datastore.v1new.types.Key" title="apache_beam.io.gcp.datastore.v1new.types.Key"><code class="xref py py-class docutils literal notranslate"><span class="pre">Key</span></code></a>)
	(Optional) key of the ancestor to which this query’s results are
	restricted.</li>
	<li><strong>filters</strong> – (sequence of tuple[str, str, str],
	sequence of
	tuple[ValueProvider(str), ValueProvider(str), ValueProvider(str)])
	Property filters applied by this query.
	The sequence is <code class="docutils literal notranslate"><span class="pre">(property_name,</span> <span class="pre">operator,</span> <span class="pre">value)</span></code>.</li>
	<li><strong>projection</strong> – (sequence of string) fields returned as part of query results.</li>
	<li><strong>order</strong> – (sequence of string) field names used to order query results.
	Prepend <code class="docutils literal notranslate"><span class="pre">-</span></code> to a field name to sort it in descending order.</li>
	<li><strong>distinct_on</strong> – (sequence of string) field names used to group query
	results.</li>
	<li><strong>limit</strong> – (int) Maximum amount of results to return.</li>
	</ul>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="method">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Query.clone">
	<code class="descname">clone</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Query.clone"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Query.clone" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	</dd></dl>

	<dl class="class">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Key">
	<em class="property">class </em><code class="descclassname">apache_beam.io.gcp.datastore.v1new.types.</code><code class="descname">Key</code><span class="sig-paren">(</span><em>path_elements</em>, <em>parent=None</em>, <em>project=None</em>, <em>namespace=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Key" title="Permalink 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
	<p>Represents a Datastore key.</p>
	<p>The partition ID is represented by its components: namespace and project.
	If key has a parent, project and namespace should either be unset or match
	the parent’s.</p>
	<table class="docutils field-list" frame="void" rules="none">
	<col class="field-name" />
	<col class="field-body" />
	<tbody valign="top">
	<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
	<li><strong>path_elements</strong> – (list of str and int) Key path: an alternating sequence of
	kind and identifier. The kind must be of type <code class="docutils literal notranslate"><span class="pre">str</span></code> and identifier may
	be a <code class="docutils literal notranslate"><span class="pre">str</span></code> or an <code class="docutils literal notranslate"><span class="pre">int</span></code>.
	If the last identifier is omitted this is an incomplete key, which is
	unsupported in <code class="docutils literal notranslate"><span class="pre">WriteToDatastore</span></code> and <code class="docutils literal notranslate"><span class="pre">DeleteFromDatastore</span></code>.
	See <a class="reference external" href="https://googleapis.dev/python/datastore/latest/keys.html#google.cloud.datastore.key.Key" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.key.Key</span></code></a> for more details.</li>
	<li><strong>parent</strong> – (<a class="reference internal" href="#apache_beam.io.gcp.datastore.v1new.types.Key" title="apache_beam.io.gcp.datastore.v1new.types.Key"><code class="xref py py-class docutils literal notranslate"><span class="pre">Key</span></code></a>)
	(optional) Parent for this key.</li>
	<li><strong>project</strong> – (str) Project ID. Required unless set by parent.</li>
	<li><strong>namespace</strong> – (str) (optional) Namespace ID</li>
	</ul>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="staticmethod">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Key.from_client_key">
	<em class="property">static </em><code class="descname">from_client_key</code><span class="sig-paren">(</span><em>client_key</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Key.from_client_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Key.from_client_key" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	<dl class="method">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Key.to_client_key">
	<code class="descname">to_client_key</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Key.to_client_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Key.to_client_key" title="Permalink to this definition">¶</a></dt>
	<dd><p>Returns a <a class="reference external" href="https://googleapis.dev/python/datastore/latest/keys.html#google.cloud.datastore.key.Key" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.key.Key</span></code></a> instance that represents
	this key.</p>
	</dd></dl>

	</dd></dl>

	<dl class="class">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Entity">
	<em class="property">class </em><code class="descclassname">apache_beam.io.gcp.datastore.v1new.types.</code><code class="descname">Entity</code><span class="sig-paren">(</span><em>key</em>, <em>exclude_from_indexes=()</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity" title="Permalink 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.8)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
	<p>Represents a Datastore entity.</p>
	<p>Does not support the property value “meaning” field.</p>
	<table class="docutils field-list" frame="void" rules="none">
	<col class="field-name" />
	<col class="field-body" />
	<tbody valign="top">
	<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
	<li><strong>key</strong> – (Key) A complete Key representing this Entity.</li>
	<li><strong>exclude_from_indexes</strong> – (iterable of str) List of property keys whose values
	should not be indexed for this entity.</li>
	</ul>
	</td>
	</tr>
	</tbody>
	</table>
	<dl class="method">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Entity.set_properties">
	<code class="descname">set_properties</code><span class="sig-paren">(</span><em>property_dict</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity.set_properties"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity.set_properties" title="Permalink to this definition">¶</a></dt>
	<dd><p>Sets a dictionary of properties on this entity.</p>
	<table class="docutils field-list" frame="void" rules="none">
	<col class="field-name" />
	<col class="field-body" />
	<tbody valign="top">
	<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>property_dict</strong> – A map from property name to value. See
	<a class="reference external" href="https://googleapis.dev/python/datastore/latest/entities.html#google.cloud.datastore.entity.Entity" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.entity.Entity</span></code></a> documentation for allowed
	values.</td>
	</tr>
	</tbody>
	</table>
	</dd></dl>

	<dl class="staticmethod">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Entity.from_client_entity">
	<em class="property">static </em><code class="descname">from_client_entity</code><span class="sig-paren">(</span><em>client_entity</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity.from_client_entity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity.from_client_entity" title="Permalink to this definition">¶</a></dt>
	<dd></dd></dl>

	<dl class="method">
	<dt id="apache_beam.io.gcp.datastore.v1new.types.Entity.to_client_entity">
	<code class="descname">to_client_entity</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/datastore/v1new/types.html#Entity.to_client_entity"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.datastore.v1new.types.Entity.to_client_entity" title="Permalink to this definition">¶</a></dt>
	<dd><p>Returns a <a class="reference external" href="https://googleapis.dev/python/datastore/latest/entities.html#google.cloud.datastore.entity.Entity" title="(in google-cloud-datastore)"><code class="xref py py-class docutils literal notranslate"><span class="pre">google.cloud.datastore.entity.Entity</span></code></a> instance that
	represents this entity.</p>
	</dd></dl>

	</dd></dl>

	</div>


	</div>

	</div>
	<footer>

	<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

	<a href="apache_beam.io.gcp.datastore.v1new.util.html" class="btn btn-neutral float-right" title="apache_beam.io.gcp.datastore.v1new.util module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


	<a href="apache_beam.io.gcp.datastore.v1new.query_splitter.html" class="btn btn-neutral float-left" title="apache_beam.io.gcp.datastore.v1new.query_splitter module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

	</div>


	<hr/>

	<div role="contentinfo">
	<p>
	© Copyright

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

	</footer>

	</div>
	</div>

	</section>

	</div>



	<script type="text/javascript">
	jQuery(function () {
	SphinxRtdTheme.Navigation.enable(true);
	});
	</script>






	</body>
	</html>