LRO for Compute Client [WIP]

google-cloud-clients/google-cloud-compute/pom.xml

@@ -31,6 +31,11 @@
       <artifactId>google-api-services-compute</artifactId>
       <scope>compile</scope>
     </dependency>
+    <dependency>
+      <groupId>com.google.auto.value</groupId>
+      <artifactId>auto-value</artifactId>
+      <scope>provided</scope>
+    </dependency>
 
     <!-- Test dependencies -->
     <dependency>

google-cloud-clients/google-cloud-compute/src/main/java/com/google/cloud/compute/v1/AddressClient.java

@@ -20,9 +20,12 @@
 import com.google.api.core.ApiFutures;
 import com.google.api.core.BetaApi;
 import com.google.api.gax.core.BackgroundResource;
+import com.google.api.gax.httpjson.EmptyMessage;
+import com.google.api.gax.longrunning.OperationFuture;
 import com.google.api.gax.paging.AbstractFixedSizeCollection;
 import com.google.api.gax.paging.AbstractPage;
 import com.google.api.gax.paging.AbstractPagedListResponse;
+import com.google.api.gax.rpc.OperationCallable;
 import com.google.api.gax.rpc.PageContext;
 import com.google.api.gax.rpc.UnaryCallable;
 import com.google.cloud.compute.v1.stub.AddressStub;
@@ -43,7 +46,7 @@
  * <code>
  * try (AddressClient addressClient = AddressClient.create()) {
  *   ProjectRegionAddressName address = ProjectRegionAddressName.of("[PROJECT]", "[REGION]", "[ADDRESS]");
- *   Operation response = addressClient.deleteAddress(address);
+ *   Address response = addressClient.getAddress(address);
  * }
  * </code>
  * </pre>
@@ -103,6 +106,7 @@
 public class AddressClient implements BackgroundResource {
   private final AddressSettings settings;
   private final AddressStub stub;
+  private final RegionOperationClient operationsClient;
 
   /** Constructs an instance of AddressClient with default settings. */
   public static final AddressClient create() throws IOException {
@@ -133,12 +137,14 @@ public static final AddressClient create(AddressStub stub) {
   protected AddressClient(AddressSettings settings) throws IOException {
     this.settings = settings;
     this.stub = ((AddressStubSettings) settings.getStubSettings()).createStub();
+    this.operationsClient = RegionOperationClient.create(this.stub.getOperationsStub());
   }
 
   @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   protected AddressClient(AddressStub stub) {
     this.settings = null;
     this.stub = stub;
+    this.operationsClient = RegionOperationClient.create(this.stub.getOperationsStub());
   }
 
   public final AddressSettings getSettings() {
@@ -150,6 +156,16 @@ public AddressStub getStub() {
     return stub;
   }
 
+  /**
+   * Returns the RegionOperationClient that can be used to query the status of a long-running
+   * operation returned by another API method call.
+   */
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public final RegionOperationClient getOperationsClient() {
+    return operationsClient;
+  }
+
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
    * Retrieves an aggregated list of addresses.
@@ -298,21 +314,23 @@ public final AggregatedListAddressesPagedResponse aggregatedListAddresses(
    * <pre><code>
    * try (AddressClient addressClient = AddressClient.create()) {
    *   ProjectRegionAddressName address = ProjectRegionAddressName.of("[PROJECT]", "[REGION]", "[ADDRESS]");
-   *   Operation response = addressClient.deleteAddress(address);
+   *   addressClient.deleteAddressAsync(address).get();
    * }
    * </code></pre>
    *
    * @param address Name of the address resource to delete.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  @BetaApi
-  public final Operation deleteAddress(ProjectRegionAddressName address) {
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public final OperationFuture<EmptyMessage, Operation> deleteAddressAsync(
+      ProjectRegionAddressName address) {
 
     DeleteAddressHttpRequest request =
         DeleteAddressHttpRequest.newBuilder()
             .setAddress(address == null ? null : address.toString())
             .build();
-    return deleteAddress(request);
+    return deleteAddressAsync(request);
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
@@ -324,19 +342,20 @@ public final Operation deleteAddress(ProjectRegionAddressName address) {
    * <pre><code>
    * try (AddressClient addressClient = AddressClient.create()) {
    *   ProjectRegionAddressName address = ProjectRegionAddressName.of("[PROJECT]", "[REGION]", "[ADDRESS]");
-   *   Operation response = addressClient.deleteAddress(address.toString());
+   *   addressClient.deleteAddressAsync(address.toString()).get();
    * }
    * </code></pre>
    *
    * @param address Name of the address resource to delete.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  @BetaApi
-  public final Operation deleteAddress(String address) {
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public final OperationFuture<EmptyMessage, Operation> deleteAddressAsync(String address) {
 
     DeleteAddressHttpRequest request =
         DeleteAddressHttpRequest.newBuilder().setAddress(address).build();
-    return deleteAddress(request);
+    return deleteAddressAsync(request);
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
@@ -351,16 +370,42 @@ public final Operation deleteAddress(String address) {
    *   DeleteAddressHttpRequest request = DeleteAddressHttpRequest.newBuilder()
    *     .setAddress(address.toString())
    *     .build();
-   *   Operation response = addressClient.deleteAddress(request);
+   *   addressClient.deleteAddressAsync(request).get();
    * }
    * </code></pre>
    *
    * @param request The request object containing all of the parameters for the API call.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  @BetaApi
-  public final Operation deleteAddress(DeleteAddressHttpRequest request) {
-    return deleteAddressCallable().call(request);
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public final OperationFuture<EmptyMessage, Operation> deleteAddressAsync(
+      DeleteAddressHttpRequest request) {
+    return deleteAddressOperationCallable().futureCall(request);
+  }
+
+  // AUTO-GENERATED DOCUMENTATION AND METHOD
+  /**
+   * Deletes the specified address resource.
+   *
+   * <p>Sample code:
+   *
+   * <pre><code>
+   * try (AddressClient addressClient = AddressClient.create()) {
+   *   ProjectRegionAddressName address = ProjectRegionAddressName.of("[PROJECT]", "[REGION]", "[ADDRESS]");
+   *   DeleteAddressHttpRequest request = DeleteAddressHttpRequest.newBuilder()
+   *     .setAddress(address.toString())
+   *     .build();
+   *   OperationFuture&lt;EmptyMessage, Operation&gt; future = addressClient.deleteAddressOperationCallable().futureCall(request);
+   *   // Do something
+   *   future.get();
+   * }
+   * </code></pre>
+   */
+  @BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
+  public final OperationCallable<DeleteAddressHttpRequest, EmptyMessage, Operation>
+      deleteAddressOperationCallable() {
+    return stub.deleteAddressOperationCallable();
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
@@ -377,7 +422,7 @@ public final Operation deleteAddress(DeleteAddressHttpRequest request) {
    *     .build();
    *   ApiFuture&lt;Operation&gt; future = addressClient.deleteAddressCallable().futureCall(request);
    *   // Do something
-   *   Operation response = future.get();
+   *   future.get();
    * }
    * </code></pre>
    */
@@ -492,7 +537,7 @@ public final UnaryCallable<GetAddressHttpRequest, Address> getAddressCallable()
    * try (AddressClient addressClient = AddressClient.create()) {
    *   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
    *   Address addressResource = Address.newBuilder().build();
-   *   Operation response = addressClient.insertAddress(region, addressResource);
+   *   addressClient.insertAddressAsync(region, addressResource).get();
    * }
    * </code></pre>
    *
@@ -502,15 +547,17 @@ public final UnaryCallable<GetAddressHttpRequest, Address> getAddressCallable()
    *     v1.globalAddresses ==)
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  @BetaApi
-  public final Operation insertAddress(ProjectRegionName region, Address addressResource) {
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public final OperationFuture<EmptyMessage, Operation> insertAddressAsync(
+      ProjectRegionName region, Address addressResource) {
 
     InsertAddressHttpRequest request =
         InsertAddressHttpRequest.newBuilder()
             .setRegion(region == null ? null : region.toString())
             .setAddressResource(addressResource)
             .build();
-    return insertAddress(request);
+    return insertAddressAsync(request);
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
@@ -523,7 +570,7 @@ public final Operation insertAddress(ProjectRegionName region, Address addressRe
    * try (AddressClient addressClient = AddressClient.create()) {
    *   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
    *   Address addressResource = Address.newBuilder().build();
-   *   Operation response = addressClient.insertAddress(region.toString(), addressResource);
+   *   addressClient.insertAddressAsync(region.toString(), addressResource).get();
    * }
    * </code></pre>
    *
@@ -533,15 +580,17 @@ public final Operation insertAddress(ProjectRegionName region, Address addressRe
    *     v1.globalAddresses ==)
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  @BetaApi
-  public final Operation insertAddress(String region, Address addressResource) {
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public final OperationFuture<EmptyMessage, Operation> insertAddressAsync(
+      String region, Address addressResource) {
 
     InsertAddressHttpRequest request =
         InsertAddressHttpRequest.newBuilder()
             .setRegion(region)
             .setAddressResource(addressResource)
             .build();
-    return insertAddress(request);
+    return insertAddressAsync(request);
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
@@ -558,16 +607,44 @@ public final Operation insertAddress(String region, Address addressResource) {
    *     .setRegion(region.toString())
    *     .setAddressResource(addressResource)
    *     .build();
-   *   Operation response = addressClient.insertAddress(request);
+   *   addressClient.insertAddressAsync(request).get();
    * }
    * </code></pre>
    *
    * @param request The request object containing all of the parameters for the API call.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  @BetaApi
-  public final Operation insertAddress(InsertAddressHttpRequest request) {
-    return insertAddressCallable().call(request);
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public final OperationFuture<EmptyMessage, Operation> insertAddressAsync(
+      InsertAddressHttpRequest request) {
+    return insertAddressOperationCallable().futureCall(request);
+  }
+
+  // AUTO-GENERATED DOCUMENTATION AND METHOD
+  /**
+   * Creates an address resource in the specified project using the data included in the request.
+   *
+   * <p>Sample code:
+   *
+   * <pre><code>
+   * try (AddressClient addressClient = AddressClient.create()) {
+   *   ProjectRegionName region = ProjectRegionName.of("[PROJECT]", "[REGION]");
+   *   Address addressResource = Address.newBuilder().build();
+   *   InsertAddressHttpRequest request = InsertAddressHttpRequest.newBuilder()
+   *     .setRegion(region.toString())
+   *     .setAddressResource(addressResource)
+   *     .build();
+   *   OperationFuture&lt;EmptyMessage, Operation&gt; future = addressClient.insertAddressOperationCallable().futureCall(request);
+   *   // Do something
+   *   future.get();
+   * }
+   * </code></pre>
+   */
+  @BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
+  public final OperationCallable<InsertAddressHttpRequest, EmptyMessage, Operation>
+      insertAddressOperationCallable() {
+    return stub.insertAddressOperationCallable();
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
@@ -586,7 +663,7 @@ public final Operation insertAddress(InsertAddressHttpRequest request) {
    *     .build();
    *   ApiFuture&lt;Operation&gt; future = addressClient.insertAddressCallable().futureCall(request);
    *   // Do something
-   *   Operation response = future.get();
+   *   future.get();
    * }
    * </code></pre>
    */

google-cloud-clients/google-cloud-compute/src/main/java/com/google/cloud/compute/v1/AddressSettings.java

@@ -22,10 +22,12 @@
 import com.google.api.core.BetaApi;
 import com.google.api.gax.core.GoogleCredentialsProvider;
 import com.google.api.gax.core.InstantiatingExecutorProvider;
+import com.google.api.gax.httpjson.EmptyMessage;
 import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
 import com.google.api.gax.rpc.ApiClientHeaderProvider;
 import com.google.api.gax.rpc.ClientContext;
 import com.google.api.gax.rpc.ClientSettings;
+import com.google.api.gax.rpc.OperationCallSettings;
 import com.google.api.gax.rpc.PagedCallSettings;
 import com.google.api.gax.rpc.TransportChannelProvider;
 import com.google.api.gax.rpc.UnaryCallSettings;
@@ -49,13 +51,13 @@
  *
  * <p>The builder of this class is recursive, so contained classes are themselves builders. When
  * build() is called, the tree of builders is called to create the complete settings object. For
- * example, to set the total timeout of deleteAddress to 30 seconds:
+ * example, to set the total timeout of getAddress to 30 seconds:
  *
  * <pre>
  * <code>
  * AddressSettings.Builder addressSettingsBuilder =
  *     AddressSettings.newBuilder();
- * addressSettingsBuilder.deleteAddressSettings().getRetrySettings().toBuilder()
+ * addressSettingsBuilder.getAddressSettings().getRetrySettings().toBuilder()
  *     .setTotalTimeout(Duration.ofSeconds(30));
  * AddressSettings addressSettings = addressSettingsBuilder.build();
  * </code>
@@ -78,6 +80,14 @@ public UnaryCallSettings<DeleteAddressHttpRequest, Operation> deleteAddressSetti
     return ((AddressStubSettings) getStubSettings()).deleteAddressSettings();
   }
 
+  /** Returns the object with the settings used for calls to deleteAddress. */
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public OperationCallSettings<DeleteAddressHttpRequest, EmptyMessage, Operation>
+      deleteAddressOperationSettings() {
+    return ((AddressStubSettings) getStubSettings()).deleteAddressOperationSettings();
+  }
+
   /** Returns the object with the settings used for calls to getAddress. */
   public UnaryCallSettings<GetAddressHttpRequest, Address> getAddressSettings() {
     return ((AddressStubSettings) getStubSettings()).getAddressSettings();
@@ -88,6 +98,14 @@ public UnaryCallSettings<InsertAddressHttpRequest, Operation> insertAddressSetti
     return ((AddressStubSettings) getStubSettings()).insertAddressSettings();
   }
 
+  /** Returns the object with the settings used for calls to insertAddress. */
+  @BetaApi(
+      "The surface for long-running operations is not stable yet and may change in the future.")
+  public OperationCallSettings<InsertAddressHttpRequest, EmptyMessage, Operation>
+      insertAddressOperationSettings() {
+    return ((AddressStubSettings) getStubSettings()).insertAddressOperationSettings();
+  }
+
   /** Returns the object with the settings used for calls to listAddresses. */
   public PagedCallSettings<ListAddressesHttpRequest, AddressList, ListAddressesPagedResponse>
       listAddressesSettings() {
@@ -209,6 +227,14 @@ public UnaryCallSettings.Builder<DeleteAddressHttpRequest, Operation> deleteAddr
       return getStubSettingsBuilder().deleteAddressSettings();
     }
 
+    /** Returns the builder for the settings used for calls to deleteAddress. */
+    @BetaApi(
+        "The surface for long-running operations is not stable yet and may change in the future.")
+    public OperationCallSettings.Builder<DeleteAddressHttpRequest, EmptyMessage, Operation>
+        deleteAddressOperationSettings() {
+      return getStubSettingsBuilder().deleteAddressOperationSettings();
+    }
+
     /** Returns the builder for the settings used for calls to getAddress. */
     public UnaryCallSettings.Builder<GetAddressHttpRequest, Address> getAddressSettings() {
       return getStubSettingsBuilder().getAddressSettings();
@@ -219,6 +245,14 @@ public UnaryCallSettings.Builder<InsertAddressHttpRequest, Operation> insertAddr
       return getStubSettingsBuilder().insertAddressSettings();
     }
 
+    /** Returns the builder for the settings used for calls to insertAddress. */
+    @BetaApi(
+        "The surface for long-running operations is not stable yet and may change in the future.")
+    public OperationCallSettings.Builder<InsertAddressHttpRequest, EmptyMessage, Operation>
+        insertAddressOperationSettings() {
+      return getStubSettingsBuilder().insertAddressOperationSettings();
+    }
+
     /** Returns the builder for the settings used for calls to listAddresses. */
     public PagedCallSettings.Builder<
             ListAddressesHttpRequest, AddressList, ListAddressesPagedResponse>