pydoc/2.35.0/apache_beam.io.gcp.gcsio.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.gcsio 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 async="async" type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?config=TeX-AMS-MML_HTMLorMML"></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.gcsio_overrides module" href="apache_beam.io.gcp.gcsio_overrides.html" />
     <link rel="prev" title="apache_beam.io.gcp.gcsfilesystem module" href="apache_beam.io.gcp.gcsfilesystem.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 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.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"><a class="reference internal" href="apache_beam.io.gcp.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4 current"><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.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>
 </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>apache_beam.io.gcp.gcsio module</li>


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


             <a href="_sources/apache_beam.io.gcp.gcsio.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.gcsio">
 <span id="apache-beam-io-gcp-gcsio-module"></span><h1>apache_beam.io.gcp.gcsio module<a class="headerlink" href="#module-apache_beam.io.gcp.gcsio" title="Permalink to this headline">¶</a></h1>
 <p>Google Cloud Storage client.</p>
 <p>This library evolved from the Google App Engine GCS client available at
 <a class="reference external" href="https://github.com/GoogleCloudPlatform/appengine-gcs-client">https://github.com/GoogleCloudPlatform/appengine-gcs-client</a>.</p>
 <dl class="class">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO">
 <em class="property">class </em><code class="descclassname">apache_beam.io.gcp.gcsio.</code><code class="descname">GcsIO</code><span class="sig-paren">(</span><em>storage_client=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO" 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.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></a></p>
 <p>Google Cloud Storage I/O client.</p>
 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.get_project_number">
 <code class="descname">get_project_number</code><span class="sig-paren">(</span><em>bucket</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.get_project_number"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.get_project_number" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.get_bucket">
 <code class="descname">get_bucket</code><span class="sig-paren">(</span><em>bucket_name</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.get_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.get_bucket" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns an object bucket from its name, or None if it does not exist.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.create_bucket">
 <code class="descname">create_bucket</code><span class="sig-paren">(</span><em>bucket_name</em>, <em>project</em>, <em>kms_key=None</em>, <em>location=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.create_bucket"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.create_bucket" title="Permalink to this definition">¶</a></dt>
 <dd><p>Create and return a GCS bucket in a specific project.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.open">
 <code class="descname">open</code><span class="sig-paren">(</span><em>filename</em>, <em>mode='r'</em>, <em>read_buffer_size=16777216</em>, <em>mime_type='application/octet-stream'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.open" title="Permalink to this definition">¶</a></dt>
 <dd><p>Open a GCS file path for reading or writing.</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 simple">
 <li><strong>filename</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – GCS file path in the form <code class="docutils literal notranslate"><span class="pre">gs://&lt;bucket&gt;/&lt;object&gt;</span></code>.</li>
 <li><strong>mode</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – <code class="docutils literal notranslate"><span class="pre">'r'</span></code> for reading or <code class="docutils literal notranslate"><span class="pre">'w'</span></code> for writing.</li>
 <li><strong>read_buffer_size</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.10)"><em>int</em></a>) – Buffer size to use during read operations.</li>
 <li><strong>mime_type</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.10)"><em>str</em></a>) – Mime type to set for write operations.</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">GCS file object.</p>
 </td>
 </tr>
 <tr class="field-odd field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.10)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code></a> – Invalid open file mode.</p>
 </td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.delete">
 <code class="descname">delete</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.delete" title="Permalink to this definition">¶</a></dt>
 <dd><p>Deletes the object at the given GCS path.</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>path</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;.</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.delete_batch">
 <code class="descname">delete_batch</code><span class="sig-paren">(</span><em>paths</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.delete_batch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.delete_batch" title="Permalink to this definition">¶</a></dt>
 <dd><p>Deletes the objects at the given GCS paths.</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>paths</strong> – List of GCS file path patterns in the form gs://&lt;bucket&gt;/&lt;name&gt;,
 not to exceed MAX_BATCH_OPERATION_SIZE in length.</td>
 </tr>
 </tbody>
 </table>
 <dl class="docutils">
 <dt>Returns: List of tuples of (path, exception) in the same order as the paths</dt>
 <dd>argument, where exception is None if the operation succeeded or
 the relevant exception if the operation failed.</dd>
 </dl>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.copy">
 <code class="descname">copy</code><span class="sig-paren">(</span><em>src</em>, <em>dest</em>, <em>dest_kms_key_name=None</em>, <em>max_bytes_rewritten_per_call=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.copy" title="Permalink to this definition">¶</a></dt>
 <dd><p>Copies the given GCS object from src to dest.</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 simple">
 <li><strong>src</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;.</li>
 <li><strong>dest</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;.</li>
 <li><strong>dest_kms_key_name</strong> – Experimental. No backwards compatibility guarantees.
 Encrypt dest with this Cloud KMS key. If None, will use dest bucket
 encryption defaults.</li>
 <li><strong>max_bytes_rewritten_per_call</strong> – Experimental. No backwards compatibility
 guarantees. Each rewrite API call will return after these many bytes.
 Used for testing.</li>
 </ul>
 </td>
 </tr>
 <tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><p class="first last"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#TimeoutError" title="(in Python v3.10)"><code class="xref py py-exc docutils literal notranslate"><span class="pre">TimeoutError</span></code></a> – on timeout.</p>
 </td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.copy_batch">
 <code class="descname">copy_batch</code><span class="sig-paren">(</span><em>src_dest_pairs</em>, <em>dest_kms_key_name=None</em>, <em>max_bytes_rewritten_per_call=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.copy_batch"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.copy_batch" title="Permalink to this definition">¶</a></dt>
 <dd><p>Copies the given GCS object from src to dest.</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>src_dest_pairs</strong> – list of (src, dest) tuples of gs://&lt;bucket&gt;/&lt;name&gt; files
 paths to copy from src to dest, not to exceed
 MAX_BATCH_OPERATION_SIZE in length.</li>
 <li><strong>dest_kms_key_name</strong> – Experimental. No backwards compatibility guarantees.
 Encrypt dest with this Cloud KMS key. If None, will use dest bucket
 encryption defaults.</li>
 <li><strong>max_bytes_rewritten_per_call</strong> – Experimental. No backwards compatibility
 guarantees. Each rewrite call will return after these many bytes. Used
 primarily for testing.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 <dl class="docutils">
 <dt>Returns: List of tuples of (src, dest, exception) in the same order as the</dt>
 <dd>src_dest_pairs argument, where exception is None if the operation
 succeeded or the relevant exception if the operation failed.</dd>
 </dl>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.copytree">
 <code class="descname">copytree</code><span class="sig-paren">(</span><em>src</em>, <em>dest</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.copytree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.copytree" title="Permalink to this definition">¶</a></dt>
 <dd><p>Renames the given GCS “directory” recursively from src to dest.</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>src</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;/.</li>
 <li><strong>dest</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;/.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.rename">
 <code class="descname">rename</code><span class="sig-paren">(</span><em>src</em>, <em>dest</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.rename" title="Permalink to this definition">¶</a></dt>
 <dd><p>Renames the given GCS object from src to dest.</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>src</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;.</li>
 <li><strong>dest</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;.</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.exists">
 <code class="descname">exists</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.exists" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns whether the given GCS object exists.</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>path</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;.</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.checksum">
 <code class="descname">checksum</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.checksum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.checksum" title="Permalink to this definition">¶</a></dt>
 <dd><p>Looks up the checksum of a GCS object.</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>path</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/&lt;name&gt;.</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.size">
 <code class="descname">size</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.size" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the size of a single GCS object.</p>
 <p>This method does not perform glob expansion. Hence the given path must be
 for a single GCS object.</p>
 <p>Returns: size of the GCS object in bytes.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.kms_key">
 <code class="descname">kms_key</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.kms_key"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.kms_key" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the KMS key of a single GCS object.</p>
 <p>This method does not perform glob expansion. Hence the given path must be
 for a single GCS object.</p>
 <dl class="docutils">
 <dt>Returns: KMS key name of the GCS object as a string, or None if it doesn’t</dt>
 <dd>have one.</dd>
 </dl>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.last_updated">
 <code class="descname">last_updated</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.last_updated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.last_updated" title="Permalink to this definition">¶</a></dt>
 <dd><p>Returns the last updated epoch time of a single GCS object.</p>
 <p>This method does not perform glob expansion. Hence the given path must be
 for a single GCS object.</p>
 <p>Returns: last updated time of the GCS object in second.</p>
 </dd></dl>

 <dl class="method">
 <dt id="apache_beam.io.gcp.gcsio.GcsIO.list_prefix">
 <code class="descname">list_prefix</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/gcp/gcsio.html#GcsIO.list_prefix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.gcp.gcsio.GcsIO.list_prefix" title="Permalink to this definition">¶</a></dt>
 <dd><p>Lists files matching the prefix.</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>path</strong> – GCS file path pattern in the form gs://&lt;bucket&gt;/[name].</td>
 </tr>
 <tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">Dictionary of file name -&gt; size.</td>
 </tr>
 </tbody>
 </table>
 </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.gcsio_overrides.html" class="btn btn-neutral float-right" title="apache_beam.io.gcp.gcsio_overrides module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


         <a href="apache_beam.io.gcp.gcsfilesystem.html" class="btn btn-neutral float-left" title="apache_beam.io.gcp.gcsfilesystem 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>