refactor(gapic): replace isClientLifecycleRelevant boolean with sampleComment property in Sample model

Author: lqiu96

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/comment/CommentComposer.java

@@ -86,8 +86,8 @@ public class CommentComposer {
           CommentStatement.withComment(
               LineComment.withComment(
                   "- The samples create a client that can be re-used for multiple requests\n"
-                      + "   and are expected to be long-lived.\n"
-                      + "   The clients should be resource managed properly and eventually closed.\n"
+                      + " and are expected to be long-lived.\n"
+                      + " The clients should be resource managed properly and eventually closed.\n"
                       + "For more information on client lifecycle, see\n"
                       + "https://docs.cloud.google.com/java/docs/client-lifecycle")));
 

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/samplecode/SampleComposer.java

@@ -43,9 +43,9 @@ static List<Statement> composeInlineSample(List<Statement> sampleBody) {
 
   static List<Statement> composeInlineSample(Sample sample) {
     return bodyWithComment(
-        sample.isClientLifecycleRelevant()
-            ? CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT
-            : CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT_BASE,
+        sample.sampleComment() != null
+            ? sample.sampleComment()
+            : CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT,
         sample.body());
   }
 
@@ -58,9 +58,9 @@ static ClassDefinition composeExecutableSample(Sample sample, String pakkage) {
         sample.name(),
         sample.variableAssignments(),
         bodyWithComment(
-            sample.isClientLifecycleRelevant()
-                ? CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT
-                : CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT_BASE,
+            sample.sampleComment() != null
+                ? sample.sampleComment()
+                : CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT,
             sample.body()),
         sample.regionTag());
   }

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/samplecode/SettingsSampleComposer.java

@@ -26,6 +26,7 @@
 import com.google.api.generator.engine.ast.Variable;
 import com.google.api.generator.engine.ast.VariableExpr;
 import com.google.api.generator.gapic.model.RegionTag;
+import com.google.api.generator.gapic.composer.comment.CommentComposer;
 import com.google.api.generator.gapic.model.Sample;
 import com.google.api.generator.gapic.utils.JavaStyle;
 import java.time.Duration;
@@ -247,7 +248,7 @@ public static Optional<Sample> composeSettingsSample(
         Sample.builder()
             .setBody(statements)
             .setRegionTag(regionTag)
-            .setIsClientLifecycleRelevant(false)
+            .setSampleComment(CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT_BASE)
             .build());
   }
 
@@ -443,7 +444,7 @@ public static Optional<Sample> composeLroSettingsSample(
         Sample.builder()
             .setBody(statements)
             .setRegionTag(regionTag)
-            .setIsClientLifecycleRelevant(false)
+            .setSampleComment(CommentComposer.AUTO_GENERATED_SAMPLE_COMMENT_BASE)
             .build());
   }
 }

sdk-platform-java/gapic-generator-java/src/main/java/com/google/api/generator/gapic/model/Sample.java

@@ -20,6 +20,7 @@
 import com.google.auto.value.AutoValue;
 import com.google.common.collect.ImmutableList;
 import java.util.List;
+import javax.annotation.Nullable;
 
 /**
  * This model represents a generated code sample. It contains the information needed to generate a
@@ -39,15 +40,15 @@ public abstract class Sample {
 
   public abstract boolean isCanonical();
 
-  public abstract boolean isClientLifecycleRelevant();
+  @Nullable
+  public abstract List<Statement> sampleComment();
 
   public static Builder builder() {
     return new AutoValue_Sample.Builder()
         .setBody(ImmutableList.of())
         .setVariableAssignments(ImmutableList.of())
         .setFileHeader(ImmutableList.of())
-        .setIsCanonical(false)
-        .setIsClientLifecycleRelevant(true);
+        .setIsCanonical(false);
   }
 
   public abstract Builder toBuilder();
@@ -91,7 +92,7 @@ public abstract static class Builder {
 
     public abstract Builder setIsCanonical(boolean isCanonical);
 
-    public abstract Builder setIsClientLifecycleRelevant(boolean isClientLifecycleRelevant);
+    public abstract Builder setSampleComment(List<Statement> sampleComment);
 
     abstract Builder setName(String name);
 

sdk-platform-java/gapic-generator-java/src/test/java/com/google/api/generator/engine/writer/goldens/GrpcServiceClientWithNestedClassImport.golden

@@ -21,8 +21,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * NestedMessageServiceClient nestedMessageServiceClient = NestedMessageServiceClient.create();
@@ -75,8 +75,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * NestedMessageServiceSettings nestedMessageServiceSettings =
@@ -96,8 +96,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * NestedMessageServiceSettings nestedMessageServiceSettings =
@@ -169,8 +169,8 @@ public class NestedMessageServiceClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * NestedMessageServiceClient nestedMessageServiceClient = NestedMessageServiceClient.create();
@@ -196,8 +196,8 @@ public class NestedMessageServiceClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * NestedMessageServiceClient nestedMessageServiceClient = NestedMessageServiceClient.create();

sdk-platform-java/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/goldens/ShowcaseWithEchoPackageInfo.golden

@@ -17,8 +17,8 @@
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * EchoClient echoClient = EchoClient.create();

sdk-platform-java/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden

@@ -22,8 +22,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * BookshopClient bookshopClient = BookshopClient.create();
@@ -81,8 +81,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * BookshopSettings bookshopSettings =
@@ -101,8 +101,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * BookshopSettings bookshopSettings =
@@ -172,8 +172,8 @@ public class BookshopClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * BookshopClient bookshopClient = BookshopClient.create();
@@ -203,8 +203,8 @@ public class BookshopClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * BookshopClient bookshopClient = BookshopClient.create();
@@ -234,8 +234,8 @@ public class BookshopClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * BookshopClient bookshopClient = BookshopClient.create();
@@ -266,8 +266,8 @@ public class BookshopClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * BookshopClient bookshopClient = BookshopClient.create();

sdk-platform-java/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceClient.golden

@@ -21,8 +21,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create();
@@ -89,8 +89,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * DeprecatedServiceSettings deprecatedServiceSettings =
@@ -110,8 +110,8 @@ import javax.annotation.Generated;
  * // - It may require specifying regional endpoints when creating the service client as shown in
  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
  * // - The samples create a client that can be re-used for multiple requests
- * //   and are expected to be long-lived.
- * //   The clients should be resource managed properly and eventually closed.
+ * // and are expected to be long-lived.
+ * // The clients should be resource managed properly and eventually closed.
  * // For more information on client lifecycle, see
  * // https://docs.cloud.google.com/java/docs/client-lifecycle
  * DeprecatedServiceSettings deprecatedServiceSettings =
@@ -186,8 +186,8 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create();
@@ -213,8 +213,8 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create();
@@ -239,8 +239,8 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create();
@@ -268,8 +268,8 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * // - It may require specifying regional endpoints when creating the service client as shown in
    * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
    * // - The samples create a client that can be re-used for multiple requests
-   * //   and are expected to be long-lived.
-   * //   The clients should be resource managed properly and eventually closed.
+   * // and are expected to be long-lived.
+   * // The clients should be resource managed properly and eventually closed.
    * // For more information on client lifecycle, see
    * // https://docs.cloud.google.com/java/docs/client-lifecycle
    * DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create();