feat: update autogenerated snippet disclaimer (#1029)

* feat: update autogenerated snippet disclaimer * update integration tests
googleapis · Aug 24, 2022 · 16f26f6 · 16f26f6
1 parent 0a89829
commit 16f26f6
Show file tree

Hide file tree

Showing 944 changed files with 9,100 additions and 3,638 deletions.
diff --git a/src/main/java/com/google/api/generator/gapic/composer/comment/CommentComposer.java b/src/main/java/com/google/api/generator/gapic/composer/comment/CommentComposer.java
@@ -60,8 +60,16 @@ public class CommentComposer {
       Arrays.asList(
           CommentStatement.withComment(
               LineComment.withComment(
-                  "This snippet has been automatically generated for illustrative purposes only.")),
+                  "This snippet has been automatically generated and should be regarded as a code template only.")),
+          CommentStatement.withComment(
+              LineComment.withComment("It will require modifications to work:")),
+          CommentStatement.withComment(
+              LineComment.withComment(
+                  "- It may require correct/in-range values for request initialization.")),
+          CommentStatement.withComment(
+              LineComment.withComment(
+                  "- It may require specifying regional endpoints when creating the service client as shown in")),
           CommentStatement.withComment(
               LineComment.withComment(
-                  "It may require modifications to work in your environment.")));
+                  "https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library")));
 }
diff --git a/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden b/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/BookshopClient.golden
@@ -16,8 +16,11 @@ import javax.annotation.Generated;
  * that map to API methods. Sample code to get started:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * try (BookshopClient bookshopClient = BookshopClient.create()) {
  *   int booksCount = 1618425911;
  *   List<Book> books = new ArrayList<>();
@@ -54,8 +57,11 @@ import javax.annotation.Generated;
  * <p>To customize credentials:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * BookshopSettings bookshopSettings =
  *     BookshopSettings.newBuilder()
  *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
@@ -66,8 +72,11 @@ import javax.annotation.Generated;
  * <p>To customize the endpoint:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * BookshopSettings bookshopSettings =
  *     BookshopSettings.newBuilder().setEndpoint(myEndpoint).build();
  * BookshopClient bookshopClient = BookshopClient.create(bookshopSettings);
@@ -129,8 +138,11 @@ public class BookshopClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (BookshopClient bookshopClient = BookshopClient.create()) {
    *   int booksCount = 1618425911;
    *   List<Book> books = new ArrayList<>();
@@ -153,8 +165,11 @@ public class BookshopClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (BookshopClient bookshopClient = BookshopClient.create()) {
    *   String booksList = "booksList2-1119589686";
    *   List<Book> books = new ArrayList<>();
@@ -177,8 +192,11 @@ public class BookshopClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (BookshopClient bookshopClient = BookshopClient.create()) {
    *   GetBookRequest request =
    *       GetBookRequest.newBuilder()
@@ -202,8 +220,11 @@ public class BookshopClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (BookshopClient bookshopClient = BookshopClient.create()) {
    *   GetBookRequest request =
    *       GetBookRequest.newBuilder()

diff --git a/.../java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceClient.golden b/.../java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceClient.golden
@@ -15,8 +15,11 @@ import javax.annotation.Generated;
  * that map to API methods. Sample code to get started:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * try (DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create()) {
  *   FibonacciRequest request = FibonacciRequest.newBuilder().setValue(111972721).build();
  *   deprecatedServiceClient.fastFibonacci(request);
@@ -53,8 +56,11 @@ import javax.annotation.Generated;
  * <p>To customize credentials:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * DeprecatedServiceSettings deprecatedServiceSettings =
  *     DeprecatedServiceSettings.newBuilder()
  *         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
@@ -66,8 +72,11 @@ import javax.annotation.Generated;
  * <p>To customize the endpoint:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * DeprecatedServiceSettings deprecatedServiceSettings =
  *     DeprecatedServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
  * DeprecatedServiceClient deprecatedServiceClient =
@@ -134,8 +143,11 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create()) {
    *   FibonacciRequest request = FibonacciRequest.newBuilder().setValue(111972721).build();
    *   deprecatedServiceClient.fastFibonacci(request);
@@ -154,8 +166,11 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create()) {
    *   FibonacciRequest request = FibonacciRequest.newBuilder().setValue(111972721).build();
    *   ApiFuture<Empty> future = deprecatedServiceClient.fastFibonacciCallable().futureCall(request);
@@ -173,8 +188,11 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create()) {
    *   FibonacciRequest request = FibonacciRequest.newBuilder().setValue(111972721).build();
    *   deprecatedServiceClient.slowFibonacci(request);
@@ -195,8 +213,11 @@ public class DeprecatedServiceClient implements BackgroundResource {
    * Sample code:
    *
    * <pre>{@code
-   * // This snippet has been automatically generated for illustrative purposes only.
-   * // It may require modifications to work in your environment.
+   * // This snippet has been automatically generated and should be regarded as a code template only.
+   * // It will require modifications to work:
+   * // - It may require correct/in-range values for request initialization.
+   * // - 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
    * try (DeprecatedServiceClient deprecatedServiceClient = DeprecatedServiceClient.create()) {
    *   FibonacciRequest request = FibonacciRequest.newBuilder().setValue(111972721).build();
    *   ApiFuture<Empty> future = deprecatedServiceClient.slowFibonacciCallable().futureCall(request);

diff --git a/...ava/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceSettings.golden b/...ava/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceSettings.golden
@@ -35,8 +35,11 @@ import javax.annotation.Generated;
  * <p>For example, to set the total timeout of fastFibonacci to 30 seconds:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * DeprecatedServiceSettings.Builder deprecatedServiceSettingsBuilder =
  *     DeprecatedServiceSettings.newBuilder();
  * deprecatedServiceSettingsBuilder

diff --git a/...com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceStubSettings.golden b/...com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceStubSettings.golden
@@ -44,8 +44,11 @@ import org.threeten.bp.Duration;
  * <p>For example, to set the total timeout of fastFibonacci to 30 seconds:
  *
  * <pre>{@code
- * // This snippet has been automatically generated for illustrative purposes only.
- * // It may require modifications to work in your environment.
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - 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
  * DeprecatedServiceStubSettings.Builder deprecatedServiceSettingsBuilder =
  *     DeprecatedServiceStubSettings.newBuilder();
  * deprecatedServiceSettingsBuilder