| <!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 Fri Oct 04 15:32:53 PDT 2019 --> |
| <title>OperationsGrpc.OperationsFutureStub (java API)</title> |
| <meta name="date" content="2019-10-04"> |
| <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="OperationsGrpc.OperationsFutureStub (java API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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><a href="../../../com/google/longrunning/OperationsGrpc.OperationsBlockingStub.html" title="class in com.google.longrunning"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/longrunning/OperationsGrpc.OperationsImplBase.html" title="class in com.google.longrunning"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/longrunning/OperationsGrpc.OperationsFutureStub.html" target="_top">Frames</a></li> |
| <li><a href="OperationsGrpc.OperationsFutureStub.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">com.google.longrunning</div> |
| <h2 title="Class OperationsGrpc.OperationsFutureStub" class="title">Class OperationsGrpc.OperationsFutureStub</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>io.grpc.stub.AbstractStub<<a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html" title="class in com.google.longrunning">OperationsGrpc.OperationsFutureStub</a>></li> |
| <li> |
| <ul class="inheritance"> |
| <li>com.google.longrunning.OperationsGrpc.OperationsFutureStub</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../com/google/longrunning/OperationsGrpc.html" title="class in com.google.longrunning">OperationsGrpc</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static final class <span class="typeNameLabel">OperationsGrpc.OperationsFutureStub</span> |
| extends io.grpc.stub.AbstractStub<<a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html" title="class in com.google.longrunning">OperationsGrpc.OperationsFutureStub</a>></pre> |
| <div class="block"><pre> |
| Manages long-running operations with an API service. |
| When an API method normally takes long time to complete, it can be designed |
| to return [Operation][google.longrunning.Operation] to the client, and the client can use this |
| interface to receive the real response asynchronously by polling the |
| operation resource, or pass the operation resource to another API (such as |
| Google Cloud Pub/Sub API) to receive the response. Any API service that |
| returns long-running operations should implement the `Operations` interface |
| so developers can have a consistent client experience. |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="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>protected <a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html" title="class in com.google.longrunning">OperationsGrpc.OperationsFutureStub</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html#build-io.grpc.Channel-io.grpc.CallOptions-">build</a></span>(io.grpc.Channel channel, |
| io.grpc.CallOptions callOptions)</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Empty.html?is-external=true" title="class or interface in com.google.protobuf">Empty</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html#cancelOperation-com.google.longrunning.CancelOperationRequest-">cancelOperation</a></span>(<a href="../../../com/google/longrunning/CancelOperationRequest.html" title="class in com.google.longrunning">CancelOperationRequest</a> request)</code> |
| <div class="block"> |
| Starts asynchronous cancellation on a long-running operation.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Empty.html?is-external=true" title="class or interface in com.google.protobuf">Empty</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html#deleteOperation-com.google.longrunning.DeleteOperationRequest-">deleteOperation</a></span>(<a href="../../../com/google/longrunning/DeleteOperationRequest.html" title="class in com.google.longrunning">DeleteOperationRequest</a> request)</code> |
| <div class="block"> |
| Deletes a long-running operation.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../com/google/longrunning/Operation.html" title="class in com.google.longrunning">Operation</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html#getOperation-com.google.longrunning.GetOperationRequest-">getOperation</a></span>(<a href="../../../com/google/longrunning/GetOperationRequest.html" title="class in com.google.longrunning">GetOperationRequest</a> request)</code> |
| <div class="block"> |
| Gets the latest state of a long-running operation.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../com/google/longrunning/ListOperationsResponse.html" title="class in com.google.longrunning">ListOperationsResponse</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html#listOperations-com.google.longrunning.ListOperationsRequest-">listOperations</a></span>(<a href="../../../com/google/longrunning/ListOperationsRequest.html" title="class in com.google.longrunning">ListOperationsRequest</a> request)</code> |
| <div class="block"> |
| Lists operations that match the specified filter in the request.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>com.google.common.util.concurrent.ListenableFuture<<a href="../../../com/google/longrunning/Operation.html" title="class in com.google.longrunning">Operation</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html#waitOperation-com.google.longrunning.WaitOperationRequest-">waitOperation</a></span>(<a href="../../../com/google/longrunning/WaitOperationRequest.html" title="class in com.google.longrunning">WaitOperationRequest</a> request)</code> |
| <div class="block"> |
| Waits for the specified long-running operation until it is done or reaches |
| at most a specified timeout, returning the latest state.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.io.grpc.stub.AbstractStub"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class io.grpc.stub.AbstractStub</h3> |
| <code>getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady</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> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="build-io.grpc.Channel-io.grpc.CallOptions-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre>protected <a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html" title="class in com.google.longrunning">OperationsGrpc.OperationsFutureStub</a> build(io.grpc.Channel channel, |
| io.grpc.CallOptions callOptions)</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>build</code> in class <code>io.grpc.stub.AbstractStub<<a href="../../../com/google/longrunning/OperationsGrpc.OperationsFutureStub.html" title="class in com.google.longrunning">OperationsGrpc.OperationsFutureStub</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="listOperations-com.google.longrunning.ListOperationsRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>listOperations</h4> |
| <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../com/google/longrunning/ListOperationsResponse.html" title="class in com.google.longrunning">ListOperationsResponse</a>> listOperations(<a href="../../../com/google/longrunning/ListOperationsRequest.html" title="class in com.google.longrunning">ListOperationsRequest</a> request)</pre> |
| <div class="block"><pre> |
| Lists operations that match the specified filter in the request. If the |
| server doesn't support this method, it returns `UNIMPLEMENTED`. |
| NOTE: the `name` binding allows API services to override the binding |
| to use different resource name schemes, such as `users/*/operations`. To |
| override the binding, API services can add a binding such as |
| `"/v1/{name=users/*}/operations"` to their service configuration. |
| For backwards compatibility, the default name includes the operations |
| collection id, however overriding users must ensure the name binding |
| is the parent resource, without the operations collection id. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="getOperation-com.google.longrunning.GetOperationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getOperation</h4> |
| <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../com/google/longrunning/Operation.html" title="class in com.google.longrunning">Operation</a>> getOperation(<a href="../../../com/google/longrunning/GetOperationRequest.html" title="class in com.google.longrunning">GetOperationRequest</a> request)</pre> |
| <div class="block"><pre> |
| Gets the latest state of a long-running operation. Clients can use this |
| method to poll the operation result at intervals as recommended by the API |
| service. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="deleteOperation-com.google.longrunning.DeleteOperationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deleteOperation</h4> |
| <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Empty.html?is-external=true" title="class or interface in com.google.protobuf">Empty</a>> deleteOperation(<a href="../../../com/google/longrunning/DeleteOperationRequest.html" title="class in com.google.longrunning">DeleteOperationRequest</a> request)</pre> |
| <div class="block"><pre> |
| Deletes a long-running operation. This method indicates that the client is |
| no longer interested in the operation result. It does not cancel the |
| operation. If the server doesn't support this method, it returns |
| `google.rpc.Code.UNIMPLEMENTED`. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="cancelOperation-com.google.longrunning.CancelOperationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>cancelOperation</h4> |
| <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="https://developers.google.com/protocol-buffers/docs/reference/java/com/google/protobuf/Empty.html?is-external=true" title="class or interface in com.google.protobuf">Empty</a>> cancelOperation(<a href="../../../com/google/longrunning/CancelOperationRequest.html" title="class in com.google.longrunning">CancelOperationRequest</a> request)</pre> |
| <div class="block"><pre> |
| Starts asynchronous cancellation on a long-running operation. The server |
| makes a best effort to cancel the operation, but success is not |
| guaranteed. If the server doesn't support this method, it returns |
| `google.rpc.Code.UNIMPLEMENTED`. Clients can use |
| [Operations.GetOperation][google.longrunning.Operations.GetOperation] or |
| other methods to check whether the cancellation succeeded or whether the |
| operation completed despite cancellation. On successful cancellation, |
| the operation is not deleted; instead, it becomes an operation with |
| an [Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, |
| corresponding to `Code.CANCELLED`. |
| </pre></div> |
| </li> |
| </ul> |
| <a name="waitOperation-com.google.longrunning.WaitOperationRequest-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>waitOperation</h4> |
| <pre>public com.google.common.util.concurrent.ListenableFuture<<a href="../../../com/google/longrunning/Operation.html" title="class in com.google.longrunning">Operation</a>> waitOperation(<a href="../../../com/google/longrunning/WaitOperationRequest.html" title="class in com.google.longrunning">WaitOperationRequest</a> request)</pre> |
| <div class="block"><pre> |
| Waits for the specified long-running operation until it is done or reaches |
| at most a specified timeout, returning the latest state. If the operation |
| is already done, the latest state is immediately returned. If the timeout |
| specified is greater than the default HTTP/RPC timeout, the HTTP/RPC |
| timeout is used. If the server does not support this method, it returns |
| `google.rpc.Code.UNIMPLEMENTED`. |
| Note that this method is on a best-effort basis. It may return the latest |
| state before the specified timeout (including immediately), meaning even an |
| immediate response is no guarantee that the operation is done. |
| </pre></div> |
| </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><a href="../../../com/google/longrunning/OperationsGrpc.OperationsBlockingStub.html" title="class in com.google.longrunning"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../com/google/longrunning/OperationsGrpc.OperationsImplBase.html" title="class in com.google.longrunning"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?com/google/longrunning/OperationsGrpc.OperationsFutureStub.html" target="_top">Frames</a></li> |
| <li><a href="OperationsGrpc.OperationsFutureStub.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>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
