[samplecode][1/3]Implement Pure Unary RPC sample code (#573)

summer-ji-eng · summer-ji-eng · commit 16ad6def5eb9 · 2021-01-15T11:50:46.000-08:00
diff --git a/src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java b/src/main/java/com/google/api/generator/gapic/composer/ServiceClientClassComposer.java
@@ -619,7 +619,12 @@ private static List<MethodDefinition> createMethodVariants(
     return javaMethods;
   }
 
-  private static MethodDefinition createMethodDefaultMethod(Method method, TypeStore typeStore) {
+  private static MethodDefinition createMethodDefaultMethod(
+      Method method,
+      String clientName,
+      Map<String, Message> messageTypes,
+      TypeStore typeStore,
+      Map<String, ResourceName> resourceNames) {
     String methodName = JavaStyle.toLowerCamelCase(method.name());
     TypeNode methodInputType = method.inputType();
     TypeNode methodOutputType =
@@ -652,6 +657,11 @@ private static MethodDefinition createMethodDefaultMethod(Method method, TypeSto
       callableMethodName = String.format(OPERATION_CALLABLE_NAME_PATTERN, methodName);
     }
 
+    Optional<String> defaultMethodSampleCode =
+        Optional.of(
+            ServiceClientSampleCodeComposer.composeRpcDefaultMethodHeaderSampleCode(
+                method, typeStore.get(clientName), resourceNames, messageTypes));
+
     MethodInvocationExpr callableMethodExpr =
         MethodInvocationExpr.builder().setMethodName(callableMethodName).build();
     callableMethodExpr =
@@ -664,7 +674,8 @@ private static MethodDefinition createMethodDefaultMethod(Method method, TypeSto
     MethodDefinition.Builder methodBuilder =
         MethodDefinition.builder()
             .setHeaderCommentStatements(
-                ServiceClientCommentComposer.createRpcMethodHeaderComment(method))
+                ServiceClientCommentComposer.createRpcMethodHeaderComment(
+                    method, defaultMethodSampleCode))
             .setScope(ScopeNode.PUBLIC)
             .setIsFinal(true)
             .setName(String.format(method.hasLro() ? "%sAsync" : "%s", methodName))
diff --git a/test/integration/goldens/logging/MetricsClient.java b/test/integration/goldens/logging/MetricsClient.java
@@ -151,17 +151,6 @@ public MetricsServiceV2Stub getStub() {
   /**
    * Lists logs-based metrics.
    *
-   * <p>Sample code:
-   *
-   * <pre>{@code
-   * try (MetricsClient metricsClient = MetricsClient.create()) {
-   *   ProjectName parent = ProjectName.of("[PROJECT]");
-   *   for (LogMetric element : metricsClient.listLogMetrics(parent).iterateAll()) {
-   *     // doThingsWith(element);
-   *   }
-   * }
-   * }</pre>
-   *
    * @param parent Required. The name of the project containing the metrics:
    *     <p>"projects/[PROJECT_ID]"
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -178,17 +167,6 @@ public final ListLogMetricsPagedResponse listLogMetrics(ProjectName parent) {
   /**
    * Lists logs-based metrics.
    *
-   * <p>Sample code:
-   *
-   * <pre>{@code
-   * try (MetricsClient metricsClient = MetricsClient.create()) {
-   *   String parent = ProjectName.of("[PROJECT]").toString();
-   *   for (LogMetric element : metricsClient.listLogMetrics(parent).iterateAll()) {
-   *     // doThingsWith(element);
-   *   }
-   * }
-   * }</pre>
-   *
    * @param parent Required. The name of the project containing the metrics:
    *     <p>"projects/[PROJECT_ID]"
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -202,22 +180,6 @@ public final ListLogMetricsPagedResponse listLogMetrics(String parent) {
   /**
    * Lists logs-based metrics.
    *
-   * <p>Sample code:
-   *
-   * <pre>{@code
-   * try (MetricsClient metricsClient = MetricsClient.create()) {
-   *   ListLogMetricsRequest request =
-   *       ListLogMetricsRequest.newBuilder()
-   *           .setParent(ProjectName.of("[PROJECT]").toString())
-   *           .setPageToken("pageToken873572522")
-   *           .setPageSize(883849137)
-   *           .build();
-   *   for (LogMetric element : metricsClient.listLogMetrics(request).iterateAll()) {
-   *     // doThingsWith(element);
-   *   }
-   * }
-   * }</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
    */
@@ -260,7 +222,7 @@ public final ListLogMetricsPagedResponse listLogMetrics(ListLogMetricsRequest re
    * }
    * }</pre>
    *
-   * @param metricName Required. The resource name of the desired metric:
+   * @param metric_name Required. The resource name of the desired metric:
    *     <p>"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -285,7 +247,7 @@ public final LogMetric getLogMetric(LogMetricName metricName) {
    * }
    * }</pre>
    *
-   * @param metricName Required. The resource name of the desired metric:
+   * @param metric_name Required. The resource name of the desired metric:
    *     <p>"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -299,18 +261,6 @@ public final LogMetric getLogMetric(String metricName) {
   /**
    * Gets a logs-based metric.
    *
-   * <p>Sample code:
-   *
-   * <pre>{@code
-   * try (MetricsClient metricsClient = MetricsClient.create()) {
-   *   GetLogMetricRequest request =
-   *       GetLogMetricRequest.newBuilder()
-   *           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
-   *           .build();
-   *   LogMetric response = metricsClient.getLogMetric(request);
-   * }
-   * }</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
    */
@@ -389,19 +339,6 @@ public final LogMetric createLogMetric(String parent, LogMetric metric) {
   /**
    * Creates a logs-based metric.
    *
-   * <p>Sample code:
-   *
-   * <pre>{@code
-   * try (MetricsClient metricsClient = MetricsClient.create()) {
-   *   CreateLogMetricRequest request =
-   *       CreateLogMetricRequest.newBuilder()
-   *           .setParent(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
-   *           .setMetric(LogMetric.newBuilder().build())
-   *           .build();
-   *   LogMetric response = metricsClient.createLogMetric(request);
-   * }
-   * }</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
    */
@@ -433,7 +370,7 @@ public final UnaryCallable<CreateLogMetricRequest, LogMetric> createLogMetricCal
    * }
    * }</pre>
    *
-   * @param metricName Required. The resource name of the metric to update:
+   * @param metric_name Required. The resource name of the metric to update:
    *     <p>"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
    *     <p>The updated metric must be provided in the request and it's `name` field must be the
    *     same as `[METRIC_ID]` If the metric does not exist in `[PROJECT_ID]`, then a new metric is
@@ -464,7 +401,7 @@ public final LogMetric updateLogMetric(LogMetricName metricName, LogMetric metri
    * }
    * }</pre>
    *
-   * @param metricName Required. The resource name of the metric to update:
+   * @param metric_name Required. The resource name of the metric to update:
    *     <p>"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
    *     <p>The updated metric must be provided in the request and it's `name` field must be the
    *     same as `[METRIC_ID]` If the metric does not exist in `[PROJECT_ID]`, then a new metric is
@@ -482,19 +419,6 @@ public final LogMetric updateLogMetric(String metricName, LogMetric metric) {
   /**
    * Creates or updates a logs-based metric.
    *
-   * <p>Sample code:
-   *
-   * <pre>{@code
-   * try (MetricsClient metricsClient = MetricsClient.create()) {
-   *   UpdateLogMetricRequest request =
-   *       UpdateLogMetricRequest.newBuilder()
-   *           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
-   *           .setMetric(LogMetric.newBuilder().build())
-   *           .build();
-   *   LogMetric response = metricsClient.updateLogMetric(request);
-   * }
-   * }</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
    */
@@ -525,7 +449,7 @@ public final UnaryCallable<UpdateLogMetricRequest, LogMetric> updateLogMetricCal
    * }
    * }</pre>
    *
-   * @param metricName Required. The resource name of the metric to delete:
+   * @param metric_name Required. The resource name of the metric to delete:
    *     <p>"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -550,7 +474,7 @@ public final void deleteLogMetric(LogMetricName metricName) {
    * }
    * }</pre>
    *
-   * @param metricName Required. The resource name of the metric to delete:
+   * @param metric_name Required. The resource name of the metric to delete:
    *     <p>"projects/[PROJECT_ID]/metrics/[METRIC_ID]"
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
@@ -564,18 +488,6 @@ public final void deleteLogMetric(String metricName) {
   /**
    * Deletes a logs-based metric.
    *
-   * <p>Sample code:
-   *
-   * <pre>{@code
-   * try (MetricsClient metricsClient = MetricsClient.create()) {
-   *   DeleteLogMetricRequest request =
-   *       DeleteLogMetricRequest.newBuilder()
-   *           .setMetricName(LogMetricName.of("[PROJECT]", "[METRIC]").toString())
-   *           .build();
-   *   metricsClient.deleteLogMetric(request);
-   * }
-   * }</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
    */
