| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (1.8.0_181-google-v7) on Mon Jan 27 16:42:29 PST 2020 --> |
| <title>AbstractArtifactRetrievalService (Apache Beam 2.20.0-SNAPSHOT)</title> |
| <meta name="date" content="2020-01-27"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractArtifactRetrievalService (Apache Beam 2.20.0-SNAPSHOT)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactStagingService.html" title="class in org.apache.beam.runners.fnexecution.artifact"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html" target="_top">Frames</a></li> |
| <li><a href="AbstractArtifactRetrievalService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.beam.runners.fnexecution.artifact</div> |
| <h2 title="Class AbstractArtifactRetrievalService" class="title">Class AbstractArtifactRetrievalService</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.model.jobmanagement.v1.ArtifactRetrievalServiceGrpc.ArtifactRetrievalServiceImplBase</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.beam.runners.fnexecution.artifact.AbstractArtifactRetrievalService</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>java.lang.AutoCloseable, <a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/ArtifactRetrievalService.html" title="interface in org.apache.beam.runners.fnexecution.artifact">ArtifactRetrievalService</a>, <a href="../../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a>, org.apache.beam.vendor.grpc.v1p26p0.io.grpc.BindableService</dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/BeamFileSystemArtifactRetrievalService.html" title="class in org.apache.beam.runners.fnexecution.artifact">BeamFileSystemArtifactRetrievalService</a>, <a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/ClassLoaderArtifactRetrievalService.html" title="class in org.apache.beam.runners.fnexecution.artifact">ClassLoaderArtifactRetrievalService</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">AbstractArtifactRetrievalService</span> |
| extends org.apache.beam.model.jobmanagement.v1.ArtifactRetrievalServiceGrpc.ArtifactRetrievalServiceImplBase |
| implements <a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/ArtifactRetrievalService.html" title="interface in org.apache.beam.runners.fnexecution.artifact">ArtifactRetrievalService</a></pre> |
| <div class="block">An <a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/ArtifactRetrievalService.html" title="interface in org.apache.beam.runners.fnexecution.artifact"><code>ArtifactRetrievalService</code></a> that handles everything aside from actually opening the |
| backing resources.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#AbstractArtifactRetrievalService--">AbstractArtifactRetrievalService</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#AbstractArtifactRetrievalService-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.cache.Cache-">AbstractArtifactRetrievalService</a></span>(org.apache.beam.vendor.guava.v26_0_jre.com.google.common.cache.Cache<java.lang.String,org.apache.beam.model.jobmanagement.v1.ArtifactApi.ProxyManifest> manifestCache)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#close--">close</a></span>()</code> |
| <div class="block">.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#getArtifact-org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetArtifactRequest-org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver-">getArtifact</a></span>(org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetArtifactRequest request, |
| org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver<org.apache.beam.model.jobmanagement.v1.ArtifactApi.ArtifactChunk> responseObserver)</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#getManifest-org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetManifestRequest-org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver-">getManifest</a></span>(org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetManifestRequest request, |
| org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver<org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetManifestResponse> responseObserver)</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>org.apache.beam.model.jobmanagement.v1.ArtifactApi.ProxyManifest</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#getManifestProxy-java.lang.String-">getManifestProxy</a></span>(java.lang.String retrievalToken)</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>abstract java.io.InputStream</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#openManifest-java.lang.String-">openManifest</a></span>(java.lang.String retrievalToken)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>abstract java.io.InputStream</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html#openUri-java.lang.String-java.lang.String-">openUri</a></span>(java.lang.String retrievalToken, |
| java.lang.String uri)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.model.jobmanagement.v1.ArtifactRetrievalServiceGrpc.ArtifactRetrievalServiceImplBase"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.beam.model.jobmanagement.v1.ArtifactRetrievalServiceGrpc.ArtifactRetrievalServiceImplBase</h3> |
| <code>bindService</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.beam.vendor.grpc.v1p26p0.io.grpc.BindableService"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.beam.vendor.grpc.v1p26p0.io.grpc.BindableService</h3> |
| <code>bindService</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractArtifactRetrievalService--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>AbstractArtifactRetrievalService</h4> |
| <pre>public AbstractArtifactRetrievalService()</pre> |
| </li> |
| </ul> |
| <a name="AbstractArtifactRetrievalService-org.apache.beam.vendor.guava.v26_0_jre.com.google.common.cache.Cache-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractArtifactRetrievalService</h4> |
| <pre>public AbstractArtifactRetrievalService(org.apache.beam.vendor.guava.v26_0_jre.com.google.common.cache.Cache<java.lang.String,org.apache.beam.model.jobmanagement.v1.ArtifactApi.ProxyManifest> manifestCache)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="openManifest-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openManifest</h4> |
| <pre>public abstract java.io.InputStream openManifest(java.lang.String retrievalToken) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="openUri-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>openUri</h4> |
| <pre>public abstract java.io.InputStream openUri(java.lang.String retrievalToken, |
| java.lang.String uri) |
| throws java.io.IOException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManifestProxy-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManifestProxy</h4> |
| <pre>public org.apache.beam.model.jobmanagement.v1.ArtifactApi.ProxyManifest getManifestProxy(java.lang.String retrievalToken) |
| throws java.io.IOException, |
| java.util.concurrent.ExecutionException</pre> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.io.IOException</code></dd> |
| <dd><code>java.util.concurrent.ExecutionException</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getManifest-org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetManifestRequest-org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getManifest</h4> |
| <pre>public void getManifest(org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetManifestRequest request, |
| org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver<org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetManifestResponse> responseObserver)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getManifest</code> in class <code>org.apache.beam.model.jobmanagement.v1.ArtifactRetrievalServiceGrpc.ArtifactRetrievalServiceImplBase</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getArtifact-org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetArtifactRequest-org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getArtifact</h4> |
| <pre>public void getArtifact(org.apache.beam.model.jobmanagement.v1.ArtifactApi.GetArtifactRequest request, |
| org.apache.beam.vendor.grpc.v1p26p0.io.grpc.stub.StreamObserver<org.apache.beam.model.jobmanagement.v1.ArtifactApi.ArtifactChunk> responseObserver)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> |
| <dd><code>getArtifact</code> in class <code>org.apache.beam.model.jobmanagement.v1.ArtifactRetrievalServiceGrpc.ArtifactRetrievalServiceImplBase</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>public void close() |
| throws java.lang.Exception</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../../org/apache/beam/runners/fnexecution/FnService.html#close--">FnService</a></code></span></div> |
| <div class="block">. |
| |
| <p>There should be no more calls to any service method by the time a call to <a href="../../../../../../org/apache/beam/runners/fnexecution/FnService.html#close--"><code>FnService.close()</code></a> |
| begins. Specifically, this means that a <code>Server</code> that this service is bound to should have |
| completed a call to the <code>Server.shutdown()</code> |
| method, and all future incoming calls will be rejected.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../../org/apache/beam/runners/fnexecution/FnService.html#close--">close</a></code> in interface <code><a href="../../../../../../org/apache/beam/runners/fnexecution/FnService.html" title="interface in org.apache.beam.runners.fnexecution">FnService</a></code></dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li>Prev Class</li> |
| <li><a href="../../../../../../org/apache/beam/runners/fnexecution/artifact/AbstractArtifactStagingService.html" title="class in org.apache.beam.runners.fnexecution.artifact"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../index.html?org/apache/beam/runners/fnexecution/artifact/AbstractArtifactRetrievalService.html" target="_top">Frames</a></li> |
| <li><a href="AbstractArtifactRetrievalService.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
