blob: e34dc567484ffa2cdc25ec67f3456ac168e8ffa8 [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.portability.api.beam_artifact_api_pb2_grpc 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.portability.api.beam_artifact_api_pb2_urns module" href="apache_beam.portability.api.beam_artifact_api_pb2_urns.html" />
<link rel="prev" title="apache_beam.portability.api package" href="apache_beam.portability.api.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.io.html">apache_beam.io package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.metrics.html">apache_beam.metrics package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.ml.html">apache_beam.ml package</a></li>
<li class="toctree-l1"><a class="reference internal" href="apache_beam.options.html">apache_beam.options package</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="apache_beam.portability.html">apache_beam.portability package</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="apache_beam.portability.html#subpackages">Subpackages</a><ul class="current">
<li class="toctree-l3 current"><a class="reference internal" href="apache_beam.portability.api.html">apache_beam.portability.api package</a><ul class="current">
<li class="toctree-l4 current"><a class="reference internal" href="apache_beam.portability.api.html#submodules">Submodules</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="apache_beam.portability.html#submodules">Submodules</a></li>
</ul>
</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.portability.html">apache_beam.portability package</a> &raquo;</li>
<li><a href="apache_beam.portability.api.html">apache_beam.portability.api package</a> &raquo;</li>
<li>apache_beam.portability.api.beam_artifact_api_pb2_grpc module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/apache_beam.portability.api.beam_artifact_api_pb2_grpc.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.portability.api.beam_artifact_api_pb2_grpc">
<span id="apache-beam-portability-api-beam-artifact-api-pb2-grpc-module"></span><h1>apache_beam.portability.api.beam_artifact_api_pb2_grpc module<a class="headerlink" href="#module-apache_beam.portability.api.beam_artifact_api_pb2_grpc" title="Permalink to this headline"></a></h1>
<p>Client and server classes corresponding to protobuf-defined services.</p>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceStub">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">ArtifactRetrievalServiceStub</code><span class="sig-paren">(</span><em>channel</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactRetrievalServiceStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceStub" 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 service to retrieve artifacts for use in a Job.</p>
<p>Constructor.</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>channel</strong> – A grpc.Channel.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceServicer">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">ArtifactRetrievalServiceServicer</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactRetrievalServiceServicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceServicer" 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 service to retrieve artifacts for use in a Job.</p>
<dl class="method">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceServicer.ResolveArtifacts">
<code class="descname">ResolveArtifacts</code><span class="sig-paren">(</span><em>request</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactRetrievalServiceServicer.ResolveArtifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceServicer.ResolveArtifacts" title="Permalink to this definition"></a></dt>
<dd><p>Resolves the given artifact references into one or more replacement
artifact references (e.g. a Maven dependency into a (transitive) set
of jars.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceServicer.GetArtifact">
<code class="descname">GetArtifact</code><span class="sig-paren">(</span><em>request</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactRetrievalServiceServicer.GetArtifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceServicer.GetArtifact" title="Permalink to this definition"></a></dt>
<dd><p>Retrieves the given artifact as a stream of bytes.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_ArtifactRetrievalServiceServicer_to_server">
<code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">add_ArtifactRetrievalServiceServicer_to_server</code><span class="sig-paren">(</span><em>servicer</em>, <em>server</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#add_ArtifactRetrievalServiceServicer_to_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_ArtifactRetrievalServiceServicer_to_server" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalService">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">ArtifactRetrievalService</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactRetrievalService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalService" 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 service to retrieve artifacts for use in a Job.</p>
<dl class="staticmethod">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalService.ResolveArtifacts">
<em class="property">static </em><code class="descname">ResolveArtifacts</code><span class="sig-paren">(</span><em>request</em>, <em>target</em>, <em>options=()</em>, <em>channel_credentials=None</em>, <em>call_credentials=None</em>, <em>insecure=False</em>, <em>compression=None</em>, <em>wait_for_ready=None</em>, <em>timeout=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactRetrievalService.ResolveArtifacts"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalService.ResolveArtifacts" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalService.GetArtifact">
<em class="property">static </em><code class="descname">GetArtifact</code><span class="sig-paren">(</span><em>request</em>, <em>target</em>, <em>options=()</em>, <em>channel_credentials=None</em>, <em>call_credentials=None</em>, <em>insecure=False</em>, <em>compression=None</em>, <em>wait_for_ready=None</em>, <em>timeout=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactRetrievalService.GetArtifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalService.GetArtifact" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceStub">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">ArtifactStagingServiceStub</code><span class="sig-paren">(</span><em>channel</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactStagingServiceStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceStub" 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 service that allows the client to act as an ArtifactRetrievalService,
for a particular job with the server initiating requests and receiving
responses.</p>
<p>A client calls the service with an ArtifactResponseWrapper that has the
staging token set, and thereafter responds to the server’s requests.</p>
<p>Constructor.</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>channel</strong> – A grpc.Channel.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceServicer">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">ArtifactStagingServiceServicer</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactStagingServiceServicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceServicer" 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 service that allows the client to act as an ArtifactRetrievalService,
for a particular job with the server initiating requests and receiving
responses.</p>
<p>A client calls the service with an ArtifactResponseWrapper that has the
staging token set, and thereafter responds to the server’s requests.</p>
<dl class="method">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceServicer.ReverseArtifactRetrievalService">
<code class="descname">ReverseArtifactRetrievalService</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactStagingServiceServicer.ReverseArtifactRetrievalService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceServicer.ReverseArtifactRetrievalService" title="Permalink to this definition"></a></dt>
<dd><p>Missing associated documentation comment in .proto file.</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_ArtifactStagingServiceServicer_to_server">
<code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">add_ArtifactStagingServiceServicer_to_server</code><span class="sig-paren">(</span><em>servicer</em>, <em>server</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#add_ArtifactStagingServiceServicer_to_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_ArtifactStagingServiceServicer_to_server" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingService">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">ArtifactStagingService</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactStagingService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingService" 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 service that allows the client to act as an ArtifactRetrievalService,
for a particular job with the server initiating requests and receiving
responses.</p>
<p>A client calls the service with an ArtifactResponseWrapper that has the
staging token set, and thereafter responds to the server’s requests.</p>
<dl class="staticmethod">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingService.ReverseArtifactRetrievalService">
<em class="property">static </em><code class="descname">ReverseArtifactRetrievalService</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>target</em>, <em>options=()</em>, <em>channel_credentials=None</em>, <em>call_credentials=None</em>, <em>insecure=False</em>, <em>compression=None</em>, <em>wait_for_ready=None</em>, <em>timeout=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#ArtifactStagingService.ReverseArtifactRetrievalService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingService.ReverseArtifactRetrievalService" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceStub">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">LegacyArtifactStagingServiceStub</code><span class="sig-paren">(</span><em>channel</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactStagingServiceStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceStub" 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>Legacy artifact staging service for pipeline-level artifacts.</p>
<p>A service to stage artifacts for use in a Job.</p>
<p>Constructor.</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>channel</strong> – A grpc.Channel.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceServicer">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">LegacyArtifactStagingServiceServicer</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactStagingServiceServicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceServicer" 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>Legacy artifact staging service for pipeline-level artifacts.</p>
<p>A service to stage artifacts for use in a Job.</p>
<dl class="method">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceServicer.PutArtifact">
<code class="descname">PutArtifact</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactStagingServiceServicer.PutArtifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceServicer.PutArtifact" title="Permalink to this definition"></a></dt>
<dd><p>Stage an artifact to be available during job execution. The first request must contain the
name of the artifact. All future requests must contain sequential chunks of the content of
the artifact.</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceServicer.CommitManifest">
<code class="descname">CommitManifest</code><span class="sig-paren">(</span><em>request</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactStagingServiceServicer.CommitManifest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingServiceServicer.CommitManifest" title="Permalink to this definition"></a></dt>
<dd><p>Commit the manifest for a Job. All artifacts must have been successfully uploaded
before this call is made.</p>
<p>Throws error INVALID_ARGUMENT if not all of the members of the manifest are present</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_LegacyArtifactStagingServiceServicer_to_server">
<code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">add_LegacyArtifactStagingServiceServicer_to_server</code><span class="sig-paren">(</span><em>servicer</em>, <em>server</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#add_LegacyArtifactStagingServiceServicer_to_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_LegacyArtifactStagingServiceServicer_to_server" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingService">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">LegacyArtifactStagingService</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactStagingService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingService" 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>Legacy artifact staging service for pipeline-level artifacts.</p>
<p>A service to stage artifacts for use in a Job.</p>
<dl class="staticmethod">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingService.PutArtifact">
<em class="property">static </em><code class="descname">PutArtifact</code><span class="sig-paren">(</span><em>request_iterator</em>, <em>target</em>, <em>options=()</em>, <em>channel_credentials=None</em>, <em>call_credentials=None</em>, <em>insecure=False</em>, <em>compression=None</em>, <em>wait_for_ready=None</em>, <em>timeout=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactStagingService.PutArtifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingService.PutArtifact" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingService.CommitManifest">
<em class="property">static </em><code class="descname">CommitManifest</code><span class="sig-paren">(</span><em>request</em>, <em>target</em>, <em>options=()</em>, <em>channel_credentials=None</em>, <em>call_credentials=None</em>, <em>insecure=False</em>, <em>compression=None</em>, <em>wait_for_ready=None</em>, <em>timeout=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactStagingService.CommitManifest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactStagingService.CommitManifest" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceStub">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">LegacyArtifactRetrievalServiceStub</code><span class="sig-paren">(</span><em>channel</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactRetrievalServiceStub"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceStub" 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 service to retrieve artifacts for use in a Job.</p>
<p>Constructor.</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>channel</strong> – A grpc.Channel.</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceServicer">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">LegacyArtifactRetrievalServiceServicer</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactRetrievalServiceServicer"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceServicer" 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 service to retrieve artifacts for use in a Job.</p>
<dl class="method">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceServicer.GetManifest">
<code class="descname">GetManifest</code><span class="sig-paren">(</span><em>request</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactRetrievalServiceServicer.GetManifest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceServicer.GetManifest" title="Permalink to this definition"></a></dt>
<dd><p>Get the manifest for the job</p>
</dd></dl>
<dl class="method">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceServicer.GetArtifact">
<code class="descname">GetArtifact</code><span class="sig-paren">(</span><em>request</em>, <em>context</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactRetrievalServiceServicer.GetArtifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalServiceServicer.GetArtifact" title="Permalink to this definition"></a></dt>
<dd><p>Get an artifact staged for the job. The requested artifact must be within the manifest</p>
</dd></dl>
</dd></dl>
<dl class="function">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_LegacyArtifactRetrievalServiceServicer_to_server">
<code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">add_LegacyArtifactRetrievalServiceServicer_to_server</code><span class="sig-paren">(</span><em>servicer</em>, <em>server</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#add_LegacyArtifactRetrievalServiceServicer_to_server"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.add_LegacyArtifactRetrievalServiceServicer_to_server" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalService">
<em class="property">class </em><code class="descclassname">apache_beam.portability.api.beam_artifact_api_pb2_grpc.</code><code class="descname">LegacyArtifactRetrievalService</code><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactRetrievalService"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalService" 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 service to retrieve artifacts for use in a Job.</p>
<dl class="staticmethod">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalService.GetManifest">
<em class="property">static </em><code class="descname">GetManifest</code><span class="sig-paren">(</span><em>request</em>, <em>target</em>, <em>options=()</em>, <em>channel_credentials=None</em>, <em>call_credentials=None</em>, <em>insecure=False</em>, <em>compression=None</em>, <em>wait_for_ready=None</em>, <em>timeout=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactRetrievalService.GetManifest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalService.GetManifest" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="staticmethod">
<dt id="apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalService.GetArtifact">
<em class="property">static </em><code class="descname">GetArtifact</code><span class="sig-paren">(</span><em>request</em>, <em>target</em>, <em>options=()</em>, <em>channel_credentials=None</em>, <em>call_credentials=None</em>, <em>insecure=False</em>, <em>compression=None</em>, <em>wait_for_ready=None</em>, <em>timeout=None</em>, <em>metadata=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/apache_beam/portability/api/beam_artifact_api_pb2_grpc.html#LegacyArtifactRetrievalService.GetArtifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.LegacyArtifactRetrievalService.GetArtifact" 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.portability.api.beam_artifact_api_pb2_urns.html" class="btn btn-neutral float-right" title="apache_beam.portability.api.beam_artifact_api_pb2_urns module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="apache_beam.portability.api.html" class="btn btn-neutral float-left" title="apache_beam.portability.api package" 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>