feat: generate sample code in the Java microgenerator (#41)

This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/071a567e-518d-48a6-94b2-66e2f0fa99eb/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 356341083 Source-Link: googleapis/googleapis@8d8c008
googleapis · Feb 12, 2021 · 45ecc842a347a5078a86aa2e4a5de7c8ca2e014e · 45ecc84
1 parent e04c6da
commit 45ecc842a347a5078a86aa2e4a5de7c8ca2e014e
diff --git a/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CatalogServiceClient.java b/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CatalogServiceClient.java
@@ -42,6 +42,14 @@
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:
  *
+ * <pre>{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ *   Catalog catalog = Catalog.newBuilder().build();
+ *   FieldMask updateMask = FieldMask.newBuilder().build();
+ *   Catalog response = catalogServiceClient.updateCatalog(catalog, updateMask);
+ * }
+ * }</pre>
+ *
  * <p>Note: close() needs to be called on the CatalogServiceClient object to clean up resources such
  * as threads. In the example above, try-with-resources is used, which automatically calls close().
  *
@@ -145,6 +153,17 @@ public CatalogServiceStub getStub() {
   /**
    * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
    *
+   * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
+   *   for (Catalog element : catalogServiceClient.listCatalogs(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }</pre>
+   *
    * @param parent Required. The account resource name with an associated location.
    *     <p>If the caller does not have permission to list
    *     [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or
@@ -163,6 +182,17 @@ public final ListCatalogsPagedResponse listCatalogs(LocationName parent) {
   /**
    * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
    *
+   * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
+   *   for (Catalog element : catalogServiceClient.listCatalogs(parent).iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }</pre>
+   *
    * @param parent Required. The account resource name with an associated location.
    *     <p>If the caller does not have permission to list
    *     [Catalog][google.cloud.retail.v2.Catalog]s under this location, regardless of whether or
@@ -178,6 +208,22 @@ public final ListCatalogsPagedResponse listCatalogs(String parent) {
   /**
    * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
    *
+   * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   ListCatalogsRequest request =
+   *       ListCatalogsRequest.newBuilder()
+   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   for (Catalog element : catalogServiceClient.listCatalogs(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
    */
@@ -190,6 +236,23 @@ public final ListCatalogsPagedResponse listCatalogs(ListCatalogsRequest request)
    * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
    *
    * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   ListCatalogsRequest request =
+   *       ListCatalogsRequest.newBuilder()
+   *           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .build();
+   *   ApiFuture<Catalog> future =
+   *       catalogServiceClient.listCatalogsPagedCallable().futureCall(request);
+   *   // Do something.
+   *   for (Catalog element : future.get().iterateAll()) {
+   *     // doThingsWith(element);
+   *   }
+   * }
+   * }</pre>
    */
   public final UnaryCallable<ListCatalogsRequest, ListCatalogsPagedResponse>
       listCatalogsPagedCallable() {
@@ -201,6 +264,23 @@ public final ListCatalogsPagedResponse listCatalogs(ListCatalogsRequest request)
    * Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project.
    *
    * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   while (true) {
+   *     ListCatalogsResponse response = catalogServiceClient.listCatalogsCallable().call(request);
+   *     for (Catalog element : response.getResponsesList()) {
+   *       // doThingsWith(element);
+   *     }
+   *     String nextPageToken = response.getNextPageToken();
+   *     if (!Strings.isNullOrEmpty(nextPageToken)) {
+   *       request = request.toBuilder().setPageToken(nextPageToken).build();
+   *     } else {
+   *       break;
+   *     }
+   *   }
+   * }
+   * }</pre>
    */
   public final UnaryCallable<ListCatalogsRequest, ListCatalogsResponse> listCatalogsCallable() {
     return stub.listCatalogsCallable();
@@ -210,6 +290,16 @@ public final UnaryCallable<ListCatalogsRequest, ListCatalogsResponse> listCatalo
   /**
    * Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
    *
+   * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   Catalog catalog = Catalog.newBuilder().build();
+   *   FieldMask updateMask = FieldMask.newBuilder().build();
+   *   Catalog response = catalogServiceClient.updateCatalog(catalog, updateMask);
+   * }
+   * }</pre>
+   *
    * @param catalog Required. The [Catalog][google.cloud.retail.v2.Catalog] to update.
    *     <p>If the caller does not have permission to update the
    *     [Catalog][google.cloud.retail.v2.Catalog], regardless of whether or not it exists, a
@@ -233,6 +323,19 @@ public final Catalog updateCatalog(Catalog catalog, FieldMask updateMask) {
   /**
    * Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
    *
+   * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   UpdateCatalogRequest request =
+   *       UpdateCatalogRequest.newBuilder()
+   *           .setCatalog(Catalog.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   Catalog response = catalogServiceClient.updateCatalog(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
    */
@@ -245,6 +348,19 @@ public final Catalog updateCatalog(UpdateCatalogRequest request) {
    * Updates the [Catalog][google.cloud.retail.v2.Catalog]s.
    *
    * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+   *   UpdateCatalogRequest request =
+   *       UpdateCatalogRequest.newBuilder()
+   *           .setCatalog(Catalog.newBuilder().build())
+   *           .setUpdateMask(FieldMask.newBuilder().build())
+   *           .build();
+   *   ApiFuture<Catalog> future = catalogServiceClient.updateCatalogCallable().futureCall(request);
+   *   // Do something.
+   *   Catalog response = future.get();
+   * }
+   * }</pre>
    */
   public final UnaryCallable<UpdateCatalogRequest, Catalog> updateCatalogCallable() {
     return stub.updateCatalogCallable();

diff --git a/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java b/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java
@@ -32,6 +32,23 @@
  * <p>This class provides the ability to make remote calls to the backing service through method
  * calls that map to API methods. Sample code to get started:
  *
+ * <pre>{@code
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ *   PredictRequest request =
+ *       PredictRequest.newBuilder()
+ *           .setPlacement("placement1792938725")
+ *           .setUserEvent(UserEvent.newBuilder().build())
+ *           .setPageSize(883849137)
+ *           .setPageToken("pageToken873572522")
+ *           .setFilter("filter-1274492040")
+ *           .setValidateOnly(true)
+ *           .putAllParams(new HashMap<String, Value>())
+ *           .putAllLabels(new HashMap<String, String>())
+ *           .build();
+ *   PredictResponse response = predictionServiceClient.predict(request);
+ * }
+ * }</pre>
+ *
  * <p>Note: close() needs to be called on the PredictionServiceClient object to clean up resources
  * such as threads. In the example above, try-with-resources is used, which automatically calls
  * close().
@@ -138,6 +155,25 @@ public PredictionServiceStub getStub() {
   /**
    * Makes a recommendation prediction.
    *
+   * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+   *   PredictRequest request =
+   *       PredictRequest.newBuilder()
+   *           .setPlacement("placement1792938725")
+   *           .setUserEvent(UserEvent.newBuilder().build())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .setFilter("filter-1274492040")
+   *           .setValidateOnly(true)
+   *           .putAllParams(new HashMap<String, Value>())
+   *           .putAllLabels(new HashMap<String, String>())
+   *           .build();
+   *   PredictResponse response = predictionServiceClient.predict(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
    */
@@ -150,6 +186,26 @@ public final PredictResponse predict(PredictRequest request) {
    * Makes a recommendation prediction.
    *
    * <p>Sample code:
+   *
+   * <pre>{@code
+   * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+   *   PredictRequest request =
+   *       PredictRequest.newBuilder()
+   *           .setPlacement("placement1792938725")
+   *           .setUserEvent(UserEvent.newBuilder().build())
+   *           .setPageSize(883849137)
+   *           .setPageToken("pageToken873572522")
+   *           .setFilter("filter-1274492040")
+   *           .setValidateOnly(true)
+   *           .putAllParams(new HashMap<String, Value>())
+   *           .putAllLabels(new HashMap<String, String>())
+   *           .build();
+   *   ApiFuture<PredictResponse> future =
+   *       predictionServiceClient.predictCallable().futureCall(request);
+   *   // Do something.
+   *   PredictResponse response = future.get();
+   * }
+   * }</pre>
    */
   public final UnaryCallable<PredictRequest, PredictResponse> predictCallable() {
     return stub.predictCallable();