| |
| |
| <!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 — Apache Beam documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <link rel="index" title="Index" |
| href="genindex.html"/> |
| <link rel="search" title="Search" href="search.html"/> |
| <link rel="top" title="Apache Beam documentation" href="index.html"/> |
| <link rel="up" title="apache_beam.portability.api package" href="apache_beam.portability.api.html"/> |
| <link rel="next" title="apache_beam.portability.api.beam_expansion_api_pb2_grpc module" href="apache_beam.portability.api.beam_expansion_api_pb2_grpc.html"/> |
| <link rel="prev" title="apache_beam.portability.api package" href="apache_beam.portability.api.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| |
| <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.internal.html">apache_beam.internal 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.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.testing.html">apache_beam.testing package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.tools.html">apache_beam.tools package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.transforms.html">apache_beam.transforms package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.typehints.html">apache_beam.typehints package</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.utils.html">apache_beam.utils package</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.error.html">apache_beam.error module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pipeline.html">apache_beam.pipeline module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.pvalue.html">apache_beam.pvalue module</a></li> |
| <li class="toctree-l1"><a class="reference internal" href="apache_beam.version.html">apache_beam.version module</a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" 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.portability.html">apache_beam.portability package</a> »</li> |
| |
| <li><a href="apache_beam.portability.api.html">apache_beam.portability.api package</a> »</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> |
| <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: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></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.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: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></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.ArtifactStagingServiceServicer.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#ArtifactStagingServiceServicer.PutArtifact"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceServicer.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.ArtifactStagingServiceServicer.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#ArtifactStagingServiceServicer.CommitManifest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactStagingServiceServicer.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_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.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: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></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: <code class="xref py py-class docutils literal"><span class="pre">future.types.newobject.newobject</span></code></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.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#ArtifactRetrievalServiceServicer.GetManifest"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#apache_beam.portability.api.beam_artifact_api_pb2_grpc.ArtifactRetrievalServiceServicer.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.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>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_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> |
| |
| </div> |
| |
| |
| </div> |
| <div class="articleComments"> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="apache_beam.portability.api.beam_expansion_api_pb2_grpc.html" class="btn btn-neutral float-right" title="apache_beam.portability.api.beam_expansion_api_pb2_grpc 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" 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> |
| © Copyright . |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/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"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </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/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |
