blob: 7868a0c059cc01882b57eb1721e5851427a9991d [file] [log] [blame]
<!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.azure.blobstorageio 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.external package" href="apache_beam.io.external.html" />
<link rel="prev" title="apache_beam.io.azure.blobstoragefilesystem module" href="apache_beam.io.azure.blobstoragefilesystem.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 current"><a class="reference internal" href="apache_beam.io.azure.html">apache_beam.io.azure package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.io.azure.html#submodules">Submodules</a></li>
</ul>
</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"><a class="reference internal" href="apache_beam.io.gcp.html">apache_beam.io.gcp package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.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.azure.html">apache_beam.io.azure package</a> &raquo;</li>
<li>apache_beam.io.azure.blobstorageio module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.io.azure.blobstorageio.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.azure.blobstorageio">
<span id="apache-beam-io-azure-blobstorageio-module"></span><h1>apache_beam.io.azure.blobstorageio module<a class="headerlink" href="#module-apache_beam.io.azure.blobstorageio" title="Permalink to this headline"></a></h1>
<p>Azure Blob Storage client.</p>
<dl class="function">
<dt id="apache_beam.io.azure.blobstorageio.parse_azfs_path">
<code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">parse_azfs_path</code><span class="sig-paren">(</span><em>azfs_path</em>, <em>blob_optional=False</em>, <em>get_account=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#parse_azfs_path"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.parse_azfs_path" title="Permalink to this definition"></a></dt>
<dd><p>Return the storage account, the container and
blob names of the given azfs:// path.</p>
</dd></dl>
<dl class="function">
<dt id="apache_beam.io.azure.blobstorageio.get_azfs_url">
<code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">get_azfs_url</code><span class="sig-paren">(</span><em>storage_account</em>, <em>container</em>, <em>blob=''</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#get_azfs_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.get_azfs_url" title="Permalink to this definition"></a></dt>
<dd><p>Returns the url in the form of
<a class="reference external" href="https://account.blob.core.windows.net/container/blob-name">https://account.blob.core.windows.net/container/blob-name</a></p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.azure.blobstorageio.Blob">
<em class="property">class </em><code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">Blob</code><span class="sig-paren">(</span><em>etag</em>, <em>name</em>, <em>last_updated</em>, <em>size</em>, <em>mime_type</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#Blob"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.Blob" 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>A Blob in Azure Blob Storage.</p>
</dd></dl>
<dl class="exception">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIOError">
<em class="property">exception </em><code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">BlobStorageIOError</code><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageIOError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIOError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#OSError" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">OSError</span></code></a>, <a class="reference internal" href="apache_beam.utils.retry.html#apache_beam.utils.retry.PermanentException" title="apache_beam.utils.retry.PermanentException"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.utils.retry.PermanentException</span></code></a></p>
<p>Blob Strorage IO error that should not be retried.</p>
</dd></dl>
<dl class="exception">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageError">
<em class="property">exception </em><code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">BlobStorageError</code><span class="sig-paren">(</span><em>message=None</em>, <em>code=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageError"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageError" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/exceptions.html#Exception" title="(in Python v3.10)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></a></p>
<p>Blob Storage client error.</p>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO">
<em class="property">class </em><code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">BlobStorageIO</code><span class="sig-paren">(</span><em>client=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageIO"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO" 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>Azure Blob Storage I/O client.</p>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.open"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.open" title="Permalink to this definition"></a></dt>
<dd><p>Open an Azure Blob Storage 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>) – Azure Blob Storage file path in the form
<code class="docutils literal notranslate"><span class="pre">azfs://&lt;storage-account&gt;/&lt;container&gt;/&lt;path&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">Azure Blob Storage 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.azure.blobstorageio.BlobStorageIO.copy">
<code class="descname">copy</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/azure/blobstorageio.html#BlobStorageIO.copy"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.copy" title="Permalink to this definition"></a></dt>
<dd><p>Copies a single Azure Blob Storage blob 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> – Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</li>
<li><strong>dest</strong> – Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</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.azure.blobstorageio.BlobStorageIO.copy_tree">
<code class="descname">copy_tree</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/azure/blobstorageio.html#BlobStorageIO.copy_tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.copy_tree" title="Permalink to this definition"></a></dt>
<dd><p>Renames the given Azure Blob storage directory and its contents
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 simple">
<li><strong>src</strong> – Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</li>
<li><strong>dest</strong> – Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</li>
</ul>
</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">List of tuples of (src, dest, exception) where exception is None if the
operation succeeded or the relevant exception if the operation failed.</p>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.copy_paths">
<code class="descname">copy_paths</code><span class="sig-paren">(</span><em>src_dest_pairs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageIO.copy_paths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.copy_paths" title="Permalink to this definition"></a></dt>
<dd><p>Copies the given Azure Blob Storage blobs from src to dest. This can
handle directory or file 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>src_dest_pairs</strong> – List of (src, dest) tuples of
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name] file paths
to copy from src to dest.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of tuples of (src, dest, exception) in the same order as the
src_dest_pairs argument, where exception is None if the operation
succeeded or the relevant exception if the operation failed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.rename"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.rename" title="Permalink to this definition"></a></dt>
<dd><p>Renames the given Azure Blob Storage blob 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> – Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</li>
<li><strong>dest</strong> – Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.rename_files">
<code class="descname">rename_files</code><span class="sig-paren">(</span><em>src_dest_pairs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageIO.rename_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.rename_files" title="Permalink to this definition"></a></dt>
<dd><p>Renames the given Azure Blob Storage blobs 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"><strong>src_dest_pairs</strong> – List of (src, dest) tuples of
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name]
file paths to rename from src to dest.</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.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.exists"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.exists" title="Permalink to this definition"></a></dt>
<dd><p>Returns whether the given Azure Blob Storage blob 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> – Azure Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.size"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.size" title="Permalink to this definition"></a></dt>
<dd><p>Returns the size of a single Blob Storage blob.</p>
<p>This method does not perform glob expansion. Hence the
given path must be for a single Blob Storage blob.</p>
<p>Returns: size of the Blob Storage blob in bytes.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.last_updated"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.last_updated" title="Permalink to this definition"></a></dt>
<dd><p>Returns the last updated epoch time of a single
Azure Blob Storage blob.</p>
<p>This method does not perform glob expansion. Hence the
given path must be for a single Azure Blob Storage blob.</p>
<p>Returns: last updated time of the Azure Blob Storage blob
in seconds.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.checksum"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.checksum" title="Permalink to this definition"></a></dt>
<dd><p>Looks up the checksum of an Azure Blob Storage blob.</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> – Azure Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.delete" title="Permalink to this definition"></a></dt>
<dd><p>Deletes a single blob at the given Azure Blob Storage 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> – Azure Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name].</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.delete_paths">
<code class="descname">delete_paths</code><span class="sig-paren">(</span><em>paths</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageIO.delete_paths"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.delete_paths" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the given Azure Blob Storage blobs from src to dest.
This can handle directory or file 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 Azure Blob Storage paths in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name] that give the
file blobs to be deleted.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of tuples of (src, dest, exception) in the same order as the
src_dest_pairs argument, where exception is None if the operation
succeeded or the relevant exception if the operation failed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.delete_tree">
<code class="descname">delete_tree</code><span class="sig-paren">(</span><em>root</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageIO.delete_tree"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.delete_tree" title="Permalink to this definition"></a></dt>
<dd><p>Deletes all blobs under the given Azure BlobStorage virtual
directory.</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> – Azure Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name]
(ending with a “/”).</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of tuples of (path, exception), where each path is a blob
under the given root. exception is None if the operation succeeded
or the relevant exception if the operation failed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.delete_files">
<code class="descname">delete_files</code><span class="sig-paren">(</span><em>paths</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageIO.delete_files"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.delete_files" title="Permalink to this definition"></a></dt>
<dd><p>Deletes the given Azure Blob Storage blobs 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"><strong>paths</strong> – list of Azure Blob Storage paths in the form
azfs://&lt;storage-account&gt;/&lt;container&gt;/[name] that give the
file blobs to be deleted.</td>
</tr>
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">List of tuples of (src, dest, exception) in the same order as the
src_dest_pairs argument, where exception is None if the operation
succeeded or the relevant exception if the operation failed.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageIO.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/azure/blobstorageio.html#BlobStorageIO.list_prefix"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageIO.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> – Azure Blob Storage file path pattern in the form
azfs://&lt;storage-account&gt;/&lt;container&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>
<dl class="class">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageDownloader">
<em class="property">class </em><code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">BlobStorageDownloader</code><span class="sig-paren">(</span><em>client</em>, <em>path</em>, <em>buffer_size</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageDownloader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageDownloader" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.io.filesystemio.html#apache_beam.io.filesystemio.Downloader" title="apache_beam.io.filesystemio.Downloader"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.filesystemio.Downloader</span></code></a></p>
<dl class="attribute">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageDownloader.size">
<code class="descname">size</code><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageDownloader.size" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageDownloader.get_range">
<code class="descname">get_range</code><span class="sig-paren">(</span><em>start</em>, <em>end</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageDownloader.get_range"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageDownloader.get_range" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageUploader">
<em class="property">class </em><code class="descclassname">apache_beam.io.azure.blobstorageio.</code><code class="descname">BlobStorageUploader</code><span class="sig-paren">(</span><em>client</em>, <em>path</em>, <em>mime_type='application/octet-stream'</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageUploader"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageUploader" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="apache_beam.io.filesystemio.html#apache_beam.io.filesystemio.Uploader" title="apache_beam.io.filesystemio.Uploader"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.filesystemio.Uploader</span></code></a></p>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageUploader.put">
<code class="descname">put</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageUploader.put"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageUploader.put" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="apache_beam.io.azure.blobstorageio.BlobStorageUploader.finish">
<code class="descname">finish</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/azure/blobstorageio.html#BlobStorageUploader.finish"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.azure.blobstorageio.BlobStorageUploader.finish" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="apache_beam.io.external.html" class="btn btn-neutral float-right" title="apache_beam.io.external package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.io.azure.blobstoragefilesystem.html" class="btn btn-neutral float-left" title="apache_beam.io.azure.blobstoragefilesystem 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>