feat: Enable REST transport for most of Java and Go clients (#190)

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 456641589 Source-Link: googleapis/googleapis@8a251f5 Source-Link: googleapis/googleapis-gen@4ca52a5 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGNhNTJhNTI5Y2YwMTMwOGQ5NzE0OTUwZWRmZmJlYTM1NjBjZmJkYiJ9 chore(deps): upgrade gapic-generator-java to 2.8.0 and update gax-java to 2.18.1 PiperOrigin-RevId: 450543911 Source-Link: googleapis/googleapis@5528344 Source-Link: googleapis/googleapis-gen@9f6775c Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiOWY2Nzc1Y2FiMTk1ODk4MmI4ODk2N2E0M2U1ZTgwNmFmMGYxMzVkYiJ9 chore: remove unused imports PiperOrigin-RevId: 450440454 Source-Link: googleapis/googleapis@a7222a7 Source-Link: googleapis/googleapis-gen@c242c55 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiYzI0MmM1NTVmMzY5YzYxM2EyMjQyMTA4YjJjMTE3NzZlMjJiYjdlOSJ9
googleapis · Jun 24, 2022 · 1fa3c0f · 1fa3c0f
1 parent e8dcd65
commit 1fa3c0f
Show file tree

Hide file tree

Showing 20 changed files with 1,765 additions and 99 deletions.
diff --git a/google-cloud-debugger-client/pom.xml b/google-cloud-debugger-client/pom.xml
@@ -58,6 +58,10 @@
       <groupId>com.google.api</groupId>
       <artifactId>gax-grpc</artifactId>
     </dependency>
+    <dependency>
+      <groupId>com.google.api</groupId>
+      <artifactId>gax-httpjson</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.threeten</groupId>
       <artifactId>threetenbp</artifactId>
@@ -77,12 +81,24 @@
       <scope>test</scope>
     </dependency>
     <!-- Need testing utility classes for generated gRPC clients tests -->
+    <dependency>
+      <groupId>com.google.api</groupId>
+      <artifactId>gax</artifactId>
+      <classifier>testlib</classifier>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>com.google.api</groupId>
       <artifactId>gax-grpc</artifactId>
       <classifier>testlib</classifier>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>com.google.api</groupId>
+      <artifactId>gax-httpjson</artifactId>
+      <classifier>testlib</classifier>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <profiles>

diff --git a/...e-cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Controller2Client.java b/...e-cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Controller2Client.java
@@ -16,7 +16,6 @@
 
 package com.google.cloud.debugger.v2;
 
-import com.google.api.core.BetaApi;
 import com.google.api.gax.core.BackgroundResource;
 import com.google.api.gax.rpc.UnaryCallable;
 import com.google.cloud.debugger.v2.stub.Controller2Stub;
@@ -113,6 +112,20 @@
  * Controller2Client controller2Client = Controller2Client.create(controller2Settings);
  * }</pre>
  *
+ * <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
+ * the wire:
+ *
+ * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
+ * Controller2Settings controller2Settings =
+ *     Controller2Settings.newBuilder()
+ *         .setTransportChannelProvider(
+ *             Controller2Settings.defaultHttpJsonTransportProviderBuilder().build())
+ *         .build();
+ * Controller2Client controller2Client = Controller2Client.create(controller2Settings);
+ * }</pre>
+ *
  * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
  */
 @Generated("by gapic-generator-java")
@@ -137,7 +150,6 @@ public static final Controller2Client create(Controller2Settings settings) throw
    * Constructs an instance of Controller2Client, using the given stub for making calls. This is for
    * advanced usage - prefer using create(Controller2Settings).
    */
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public static final Controller2Client create(Controller2Stub stub) {
     return new Controller2Client(stub);
   }
@@ -152,7 +164,6 @@ protected Controller2Client(Controller2Settings settings) throws IOException {
     this.stub = ((Controller2StubSettings) settings.getStubSettings()).createStub();
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   protected Controller2Client(Controller2Stub stub) {
     this.settings = null;
     this.stub = stub;
@@ -162,7 +173,6 @@ public final Controller2Settings getSettings() {
     return settings;
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public Controller2Stub getStub() {
     return stub;
   }

diff --git a/...cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Controller2Settings.java b/...cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Controller2Settings.java
@@ -21,6 +21,7 @@
 import com.google.api.gax.core.GoogleCredentialsProvider;
 import com.google.api.gax.core.InstantiatingExecutorProvider;
 import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
+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;
@@ -115,11 +116,18 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
     return Controller2StubSettings.defaultCredentialsProviderBuilder();
   }
 
-  /** Returns a builder for the default ChannelProvider for this service. */
+  /** Returns a builder for the default gRPC ChannelProvider for this service. */
   public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
     return Controller2StubSettings.defaultGrpcTransportProviderBuilder();
   }
 
+  /** Returns a builder for the default REST ChannelProvider for this service. */
+  @BetaApi
+  public static InstantiatingHttpJsonChannelProvider.Builder
+      defaultHttpJsonTransportProviderBuilder() {
+    return Controller2StubSettings.defaultHttpJsonTransportProviderBuilder();
+  }
+
   public static TransportChannelProvider defaultTransportChannelProvider() {
     return Controller2StubSettings.defaultTransportChannelProvider();
   }
@@ -129,11 +137,17 @@ public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuil
     return Controller2StubSettings.defaultApiClientHeaderProviderBuilder();
   }
 
-  /** Returns a new builder for this class. */
+  /** Returns a new gRPC builder for this class. */
   public static Builder newBuilder() {
     return Builder.createDefault();
   }
 
+  /** Returns a new REST builder for this class. */
+  @BetaApi
+  public static Builder newHttpJsonBuilder() {
+    return Builder.createHttpJsonDefault();
+  }
+
   /** Returns a new builder for this class. */
   public static Builder newBuilder(ClientContext clientContext) {
     return new Builder(clientContext);
@@ -171,6 +185,11 @@ private static Builder createDefault() {
       return new Builder(Controller2StubSettings.newBuilder());
     }
 
+    @BetaApi
+    private static Builder createHttpJsonDefault() {
+      return new Builder(Controller2StubSettings.newHttpJsonBuilder());
+    }
+
     public Controller2StubSettings.Builder getStubSettingsBuilder() {
       return ((Controller2StubSettings.Builder) getStubSettings());
     }

diff --git a/google-cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Debugger2Client.java b/google-cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Debugger2Client.java
@@ -16,7 +16,6 @@
 
 package com.google.cloud.debugger.v2;
 
-import com.google.api.core.BetaApi;
 import com.google.api.gax.core.BackgroundResource;
 import com.google.api.gax.rpc.UnaryCallable;
 import com.google.cloud.debugger.v2.stub.Debugger2Stub;
@@ -113,6 +112,20 @@
  * Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);
  * }</pre>
  *
+ * <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
+ * the wire:
+ *
+ * <pre>{@code
+ * // This snippet has been automatically generated for illustrative purposes only.
+ * // It may require modifications to work in your environment.
+ * Debugger2Settings debugger2Settings =
+ *     Debugger2Settings.newBuilder()
+ *         .setTransportChannelProvider(
+ *             Debugger2Settings.defaultHttpJsonTransportProviderBuilder().build())
+ *         .build();
+ * Debugger2Client debugger2Client = Debugger2Client.create(debugger2Settings);
+ * }</pre>
+ *
  * <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
  */
 @Generated("by gapic-generator-java")
@@ -137,7 +150,6 @@ public static final Debugger2Client create(Debugger2Settings settings) throws IO
    * Constructs an instance of Debugger2Client, using the given stub for making calls. This is for
    * advanced usage - prefer using create(Debugger2Settings).
    */
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public static final Debugger2Client create(Debugger2Stub stub) {
     return new Debugger2Client(stub);
   }
@@ -151,7 +163,6 @@ protected Debugger2Client(Debugger2Settings settings) throws IOException {
     this.stub = ((Debugger2StubSettings) settings.getStubSettings()).createStub();
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   protected Debugger2Client(Debugger2Stub stub) {
     this.settings = null;
     this.stub = stub;
@@ -161,7 +172,6 @@ public final Debugger2Settings getSettings() {
     return settings;
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public Debugger2Stub getStub() {
     return stub;
   }

diff --git a/...e-cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Debugger2Settings.java b/...e-cloud-debugger-client/src/main/java/com/google/cloud/debugger/v2/Debugger2Settings.java
@@ -21,6 +21,7 @@
 import com.google.api.gax.core.GoogleCredentialsProvider;
 import com.google.api.gax.core.InstantiatingExecutorProvider;
 import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
+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;
@@ -127,11 +128,18 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
     return Debugger2StubSettings.defaultCredentialsProviderBuilder();
   }
 
-  /** Returns a builder for the default ChannelProvider for this service. */
+  /** Returns a builder for the default gRPC ChannelProvider for this service. */
   public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
     return Debugger2StubSettings.defaultGrpcTransportProviderBuilder();
   }
 
+  /** Returns a builder for the default REST ChannelProvider for this service. */
+  @BetaApi
+  public static InstantiatingHttpJsonChannelProvider.Builder
+      defaultHttpJsonTransportProviderBuilder() {
+    return Debugger2StubSettings.defaultHttpJsonTransportProviderBuilder();
+  }
+
   public static TransportChannelProvider defaultTransportChannelProvider() {
     return Debugger2StubSettings.defaultTransportChannelProvider();
   }
@@ -141,11 +149,17 @@ public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuil
     return Debugger2StubSettings.defaultApiClientHeaderProviderBuilder();
   }
 
-  /** Returns a new builder for this class. */
+  /** Returns a new gRPC builder for this class. */
   public static Builder newBuilder() {
     return Builder.createDefault();
   }
 
+  /** Returns a new REST builder for this class. */
+  @BetaApi
+  public static Builder newHttpJsonBuilder() {
+    return Builder.createHttpJsonDefault();
+  }
+
   /** Returns a new builder for this class. */
   public static Builder newBuilder(ClientContext clientContext) {
     return new Builder(clientContext);
@@ -183,6 +197,11 @@ private static Builder createDefault() {
       return new Builder(Debugger2StubSettings.newBuilder());
     }
 
+    @BetaApi
+    private static Builder createHttpJsonDefault() {
+      return new Builder(Debugger2StubSettings.newHttpJsonBuilder());
+    }
+
     public Debugger2StubSettings.Builder getStubSettingsBuilder() {
       return ((Debugger2StubSettings.Builder) getStubSettings());
     }

diff --git a/...ugger-client/src/main/java/com/google/cloud/debugger/v2/stub/Controller2StubSettings.java b/...ugger-client/src/main/java/com/google/cloud/debugger/v2/stub/Controller2StubSettings.java
@@ -24,6 +24,9 @@
 import com.google.api.gax.grpc.GaxGrpcProperties;
 import com.google.api.gax.grpc.GrpcTransportChannel;
 import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
+import com.google.api.gax.httpjson.GaxHttpJsonProperties;
+import com.google.api.gax.httpjson.HttpJsonTransportChannel;
+import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
 import com.google.api.gax.retrying.RetrySettings;
 import com.google.api.gax.rpc.ApiClientHeaderProvider;
 import com.google.api.gax.rpc.ClientContext;
@@ -114,13 +117,17 @@ public class Controller2StubSettings extends StubSettings<Controller2StubSetting
     return updateActiveBreakpointSettings;
   }
 
-  @BetaApi("A restructuring of stub classes is planned, so this may break in the future")
   public Controller2Stub createStub() throws IOException {
     if (getTransportChannelProvider()
         .getTransportName()
         .equals(GrpcTransportChannel.getGrpcTransportName())) {
       return GrpcController2Stub.create(this);
     }
+    if (getTransportChannelProvider()
+        .getTransportName()
+        .equals(HttpJsonTransportChannel.getHttpJsonTransportName())) {
+      return HttpJsonController2Stub.create(this);
+    }
     throw new UnsupportedOperationException(
         String.format(
             "Transport not supported: %s", getTransportChannelProvider().getTransportName()));
@@ -153,30 +160,56 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
         .setUseJwtAccessWithScope(true);
   }
 
-  /** Returns a builder for the default ChannelProvider for this service. */
+  /** Returns a builder for the default gRPC ChannelProvider for this service. */
   public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
     return InstantiatingGrpcChannelProvider.newBuilder()
         .setMaxInboundMessageSize(Integer.MAX_VALUE);
   }
 
+  /** Returns a builder for the default REST ChannelProvider for this service. */
+  @BetaApi
+  public static InstantiatingHttpJsonChannelProvider.Builder
+      defaultHttpJsonTransportProviderBuilder() {
+    return InstantiatingHttpJsonChannelProvider.newBuilder();
+  }
+
   public static TransportChannelProvider defaultTransportChannelProvider() {
     return defaultGrpcTransportProviderBuilder().build();
   }
 
   @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
-  public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
+  public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() {
     return ApiClientHeaderProvider.newBuilder()
         .setGeneratedLibToken(
             "gapic", GaxProperties.getLibraryVersion(Controller2StubSettings.class))
         .setTransportToken(
             GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
   }
 
-  /** Returns a new builder for this class. */
+  @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
+  public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() {
+    return ApiClientHeaderProvider.newBuilder()
+        .setGeneratedLibToken(
+            "gapic", GaxProperties.getLibraryVersion(Controller2StubSettings.class))
+        .setTransportToken(
+            GaxHttpJsonProperties.getHttpJsonTokenName(),
+            GaxHttpJsonProperties.getHttpJsonVersion());
+  }
+
+  public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
+    return Controller2StubSettings.defaultGrpcApiClientHeaderProviderBuilder();
+  }
+
+  /** Returns a new gRPC builder for this class. */
   public static Builder newBuilder() {
     return Builder.createDefault();
   }
 
+  /** Returns a new REST builder for this class. */
+  public static Builder newHttpJsonBuilder() {
+    return Builder.createHttpJsonDefault();
+  }
+
   /** Returns a new builder for this class. */
   public static Builder newBuilder(ClientContext clientContext) {
     return new Builder(clientContext);
@@ -295,6 +328,19 @@ private static Builder createDefault() {
       return initDefaults(builder);
     }
 
+    private static Builder createHttpJsonDefault() {
+      Builder builder = new Builder(((ClientContext) null));
+
+      builder.setTransportChannelProvider(defaultHttpJsonTransportProviderBuilder().build());
+      builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
+      builder.setInternalHeaderProvider(defaultHttpJsonApiClientHeaderProviderBuilder().build());
+      builder.setEndpoint(getDefaultEndpoint());
+      builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
+      builder.setSwitchToMtlsEndpointAllowed(true);
+
+      return initDefaults(builder);
+    }
+
     private static Builder initDefaults(Builder builder) {
       builder
           .registerDebuggeeSettings()