| |
| |
| <!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.requestresponse module — Apache Beam 2.58.0 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.restriction_trackers module" href="apache_beam.io.restriction_trackers.html" /> |
| <link rel="prev" title="apache_beam.io.range_trackers module" href="apache_beam.io.range_trackers.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 class="version"> |
| 2.58.0 |
| </div> |
| |
| |
| |
| |
| <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"><a class="reference internal" href="apache_beam.io.html#subpackages">Subpackages</a></li> |
| <li class="toctree-l2 current"><a class="reference internal" href="apache_beam.io.html#submodules">Submodules</a><ul class="current"> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.avroio.html">apache_beam.io.avroio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.concat_source.html">apache_beam.io.concat_source module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.debezium.html">apache_beam.io.debezium module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsink.html">apache_beam.io.filebasedsink module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filebasedsource.html">apache_beam.io.filebasedsource module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.fileio.html">apache_beam.io.fileio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystem.html">apache_beam.io.filesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystemio.html">apache_beam.io.filesystemio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.filesystems.html">apache_beam.io.filesystems module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.hadoopfilesystem.html">apache_beam.io.hadoopfilesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.iobase.html">apache_beam.io.iobase module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.jdbc.html">apache_beam.io.jdbc module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kafka.html">apache_beam.io.kafka module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.kinesis.html">apache_beam.io.kinesis module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.localfilesystem.html">apache_beam.io.localfilesystem module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.mongodbio.html">apache_beam.io.mongodbio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.parquetio.html">apache_beam.io.parquetio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.range_trackers.html">apache_beam.io.range_trackers module</a></li> |
| <li class="toctree-l3 current"><a class="current reference internal" href="#">apache_beam.io.requestresponse module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.restriction_trackers.html">apache_beam.io.restriction_trackers module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.snowflake.html">apache_beam.io.snowflake module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.source_test_utils.html">apache_beam.io.source_test_utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.textio.html">apache_beam.io.textio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.tfrecordio.html">apache_beam.io.tfrecordio module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.utils.html">apache_beam.io.utils module</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="apache_beam.io.watermark_estimators.html">apache_beam.io.watermark_estimators module</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.runners.html">apache_beam.runners package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.testing.html">apache_beam.testing package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.yaml.html">apache_beam.yaml package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" aria-label="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>apache_beam.io.requestresponse module</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/apache_beam.io.requestresponse.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.requestresponse"> |
| <span id="apache-beam-io-requestresponse-module"></span><h1>apache_beam.io.requestresponse module<a class="headerlink" href="#module-apache_beam.io.requestresponse" title="Permalink to this headline">¶</a></h1> |
| <p><code class="docutils literal notranslate"><span class="pre">PTransform</span></code> for reading from and writing to Web APIs.</p> |
| <dl class="class"> |
| <dt id="apache_beam.io.requestresponse.ExponentialBackOffRepeater"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.requestresponse.</code><code class="descname">ExponentialBackOffRepeater</code><a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#ExponentialBackOffRepeater"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.ExponentialBackOffRepeater" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.requestresponse.Repeater</span></code></p> |
| <p>Configure exponential backoff retry strategy.</p> |
| <p>It retries for exceptions due to the remote service such as |
| TooManyRequests (HTTP 429), UserCodeTimeoutException, UserCodeQuotaException.</p> |
| <p>It utilizes the decorator |
| <a class="reference internal" href="apache_beam.utils.retry.html#apache_beam.utils.retry.with_exponential_backoff" title="apache_beam.utils.retry.with_exponential_backoff"><code class="xref py py-func docutils literal notranslate"><span class="pre">apache_beam.utils.retry.with_exponential_backoff()</span></code></a>.</p> |
| <dl class="method"> |
| <dt id="apache_beam.io.requestresponse.ExponentialBackOffRepeater.repeat"> |
| <code class="descname">repeat</code><span class="sig-paren">(</span><em>caller: apache_beam.io.requestresponse.Caller[~RequestT, ~ResponseT][RequestT, ResponseT], request: RequestT, timeout: float, metrics_collector: Optional[apache_beam.io.requestresponse._MetricsCollector] = None</em><span class="sig-paren">)</span> → ResponseT<a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#ExponentialBackOffRepeater.repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.ExponentialBackOffRepeater.repeat" title="Permalink to this definition">¶</a></dt> |
| <dd><p>repeat method is called from the RequestResponseIO when |
| a repeater is enabled.</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>caller</strong> – a <cite>~apache_beam.io.requestresponse.Caller</cite> object that |
| calls the API.</li> |
| <li><strong>request</strong> – input request to repeat.</li> |
| <li><strong>timeout</strong> – time to wait for the request to complete.</li> |
| <li><strong>metrics_collector</strong> – (Optional) a |
| <cite>~apache_beam.io.requestresponse._MetricsCollector</cite> object to |
| collect the metrics for RequestResponseIO.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.io.requestresponse.NoOpsRepeater"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.requestresponse.</code><code class="descname">NoOpsRepeater</code><a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#NoOpsRepeater"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.NoOpsRepeater" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.requestresponse.Repeater</span></code></p> |
| <p>Executes a request just once irrespective of any exception.</p> |
| <dl class="method"> |
| <dt id="apache_beam.io.requestresponse.NoOpsRepeater.repeat"> |
| <code class="descname">repeat</code><span class="sig-paren">(</span><em>caller: apache_beam.io.requestresponse.Caller[~RequestT, ~ResponseT][RequestT, ResponseT], request: RequestT, timeout: float, metrics_collector: Optional[apache_beam.io.requestresponse._MetricsCollector]</em><span class="sig-paren">)</span> → ResponseT<a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#NoOpsRepeater.repeat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.NoOpsRepeater.repeat" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.io.requestresponse.DefaultThrottler"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.requestresponse.</code><code class="descname">DefaultThrottler</code><span class="sig-paren">(</span><em>window_ms: int = 1</em>, <em>bucket_ms: int = 1</em>, <em>overload_ratio: float = 2</em>, <em>delay_secs: int = 5</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#DefaultThrottler"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.DefaultThrottler" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.requestresponse.PreCallThrottler</span></code></p> |
| <p>Default throttler that uses |
| <a class="reference internal" href="apache_beam.io.components.adaptive_throttler.html#apache_beam.io.components.adaptive_throttler.AdaptiveThrottler" title="apache_beam.io.components.adaptive_throttler.AdaptiveThrottler"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.components.adaptive_throttler.AdaptiveThrottler</span></code></a></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>window_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – length of history to consider, in ms, to set throttling.</li> |
| <li><strong>bucket_ms</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – granularity of time buckets that we store data in, in ms.</li> |
| <li><strong>overload_ratio</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – the target ratio between requests sent and |
| successful requests. This is “K” in the formula in |
| <a class="reference external" href="https://landing.google.com/sre/book/chapters/handling-overload.html">https://landing.google.com/sre/book/chapters/handling-overload.html</a>.</li> |
| <li><strong>delay_secs</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – minimum number of seconds to throttle a request.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.io.requestresponse.RedisCache"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.requestresponse.</code><code class="descname">RedisCache</code><span class="sig-paren">(</span><em>host: str</em>, <em>port: int</em>, <em>time_to_live: Union[int</em>, <em>datetime.timedelta] = 86400</em>, <em>*</em>, <em>request_coder: Optional[apache_beam.coders.coders.Coder] = None</em>, <em>response_coder: Optional[apache_beam.coders.coders.Coder] = None</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#RedisCache"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.RedisCache" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.requestresponse.Cache</span></code></p> |
| <p>Configure cache using Redis for |
| <a class="reference internal" href="#apache_beam.io.requestresponse.RequestResponseIO" title="apache_beam.io.requestresponse.RequestResponseIO"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.requestresponse.RequestResponseIO</span></code></a>.</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>host</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The hostname or IP address of the Redis server.</li> |
| <li><strong>port</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><em>int</em></a>) – The port number of the Redis server.</li> |
| <li><strong>time_to_live</strong> – <cite>(Union[int, timedelta])</cite> The time-to-live (TTL) for |
| records stored in Redis. Provide an integer (in seconds) or a |
| <cite>datetime.timedelta</cite> object.</li> |
| <li><strong>request_coder</strong> – (Optional[<cite>coders.Coder</cite>]) coder for encoding requests.</li> |
| <li><strong>response_coder</strong> – (Optional[<cite>coders.Coder</cite>]) coder for decoding responses |
| received from Redis.</li> |
| <li><strong>kwargs</strong> – Optional additional keyword arguments that |
| are required to connect to your redis server. Same as <cite>redis.Redis()</cite>.</li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.io.requestresponse.RedisCache.get_read"> |
| <code class="descname">get_read</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#RedisCache.get_read"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.RedisCache.get_read" title="Permalink to this definition">¶</a></dt> |
| <dd><p>get_read returns a PTransform for reading from the cache.</p> |
| </dd></dl> |
| |
| <dl class="method"> |
| <dt id="apache_beam.io.requestresponse.RedisCache.get_write"> |
| <code class="descname">get_write</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#RedisCache.get_write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.RedisCache.get_write" title="Permalink to this definition">¶</a></dt> |
| <dd><p>returns a PTransform for writing to the cache.</p> |
| </dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.io.requestresponse.RedisCache.source_caller"> |
| <code class="descname">source_caller</code><a class="headerlink" href="#apache_beam.io.requestresponse.RedisCache.source_caller" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| <dl class="attribute"> |
| <dt id="apache_beam.io.requestresponse.RedisCache.request_coder"> |
| <code class="descname">request_coder</code><a class="headerlink" href="#apache_beam.io.requestresponse.RedisCache.request_coder" title="Permalink to this definition">¶</a></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="class"> |
| <dt id="apache_beam.io.requestresponse.RequestResponseIO"> |
| <em class="property">class </em><code class="descclassname">apache_beam.io.requestresponse.</code><code class="descname">RequestResponseIO</code><span class="sig-paren">(</span><em>caller: apache_beam.io.requestresponse.Caller[~RequestT, ~ResponseT][RequestT, ResponseT], timeout: Optional[float] = 30, should_backoff: Optional[apache_beam.io.requestresponse.ShouldBackOff] = None, repeater: apache_beam.io.requestresponse.Repeater = <apache_beam.io.requestresponse.ExponentialBackOffRepeater object>, cache: Optional[apache_beam.io.requestresponse.Cache] = None, throttler: apache_beam.io.requestresponse.PreCallThrottler = <apache_beam.io.requestresponse.DefaultThrottler object></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#RequestResponseIO"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.RequestResponseIO" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Bases: <a class="reference internal" href="apache_beam.transforms.ptransform.html#apache_beam.transforms.ptransform.PTransform" title="apache_beam.transforms.ptransform.PTransform"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.transforms.ptransform.PTransform</span></code></a></p> |
| <p>A <a class="reference internal" href="#apache_beam.io.requestresponse.RequestResponseIO" title="apache_beam.io.requestresponse.RequestResponseIO"><code class="xref py py-class docutils literal notranslate"><span class="pre">RequestResponseIO</span></code></a> transform to read and write to APIs.</p> |
| <p>Processes an input <a class="reference internal" href="apache_beam.pvalue.html#apache_beam.pvalue.PCollection" title="apache_beam.pvalue.PCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">PCollection</span></code></a> of requests |
| by making a call to the API as defined in <cite>Caller</cite>’s <cite>__call__</cite> method |
| and returns a <a class="reference internal" href="apache_beam.pvalue.html#apache_beam.pvalue.PCollection" title="apache_beam.pvalue.PCollection"><code class="xref py py-class docutils literal notranslate"><span class="pre">PCollection</span></code></a> of responses.</p> |
| <p>Instantiates a RequestResponseIO transform.</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>caller</strong> – an implementation of |
| <cite>Caller</cite> object that makes call to the API.</li> |
| <li><strong>timeout</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#float" title="(in Python v3.12)"><em>float</em></a>) – timeout value in seconds to wait for response from API.</li> |
| <li><strong>should_backoff</strong> – (Optional) provides methods for backoff.</li> |
| <li><strong>repeater</strong> – provides method to repeat failed requests to API due to service |
| errors. Defaults to |
| <a class="reference internal" href="#apache_beam.io.requestresponse.ExponentialBackOffRepeater" title="apache_beam.io.requestresponse.ExponentialBackOffRepeater"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.requestresponse.ExponentialBackOffRepeater</span></code></a> to |
| repeat requests with exponential backoff.</li> |
| <li><strong>cache</strong> – (Optional) a <cite>~apache_beam.io.requestresponse.Cache</cite> object |
| to use the appropriate cache.</li> |
| <li><strong>throttler</strong> – provides methods to pre-throttle a request. Defaults to |
| <a class="reference internal" href="#apache_beam.io.requestresponse.DefaultThrottler" title="apache_beam.io.requestresponse.DefaultThrottler"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.requestresponse.DefaultThrottler</span></code></a> for |
| client-side adaptive throttling using |
| <a class="reference internal" href="apache_beam.io.components.adaptive_throttler.html#apache_beam.io.components.adaptive_throttler.AdaptiveThrottler" title="apache_beam.io.components.adaptive_throttler.AdaptiveThrottler"><code class="xref py py-class docutils literal notranslate"><span class="pre">apache_beam.io.components.adaptive_throttler.AdaptiveThrottler</span></code></a></li> |
| </ul> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <dl class="method"> |
| <dt id="apache_beam.io.requestresponse.RequestResponseIO.expand"> |
| <code class="descname">expand</code><span class="sig-paren">(</span><em>requests: apache_beam.pvalue.PCollection[~RequestT][RequestT]</em><span class="sig-paren">)</span> → apache_beam.pvalue.PCollection[~ResponseT][ResponseT]<a class="reference internal" href="_modules/apache_beam/io/requestresponse.html#RequestResponseIO.expand"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.io.requestresponse.RequestResponseIO.expand" 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.restriction_trackers.html" class="btn btn-neutral float-right" title="apache_beam.io.restriction_trackers module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="apache_beam.io.range_trackers.html" class="btn btn-neutral float-left" title="apache_beam.io.range_trackers 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> |
