fix!: operation value is now a one-of path_value (#41)

* [CHANGE ME] Re-generated to pick up changes in the API or client library generator. * chore: allow breaking proto interface changes * chore: allow breaking changes
googleapis · Dec 4, 2019 · 7a877da · 7a877da
1 parent 7e04234
commit 7a877da
Show file tree

Hide file tree

Showing 21 changed files with 2,526 additions and 463 deletions.
diff --git a/google-cloud-recommender/clirr-ignored-differences.xml b/google-cloud-recommender/clirr-ignored-differences.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- see http://www.mojohaus.org/clirr-maven-plugin/examples/ignored-differences.html -->
+<differences>
+  <!-- TODO(chingor): Remove after 0.2.0 is released -->
+  <difference>
+    <differenceType>7004</differenceType>
+    <className>com/google/cloud/recommender/v1beta1/RecommenderClient</className>
+    <method>com.google.cloud.recommender.v1beta1.RecommenderClient$ListRecommendationsPagedResponse listRecommendations(java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7004</differenceType>
+    <className>com/google/cloud/recommender/v1beta1/RecommenderClient</className>
+    <method>com.google.cloud.recommender.v1beta1.Recommendation markRecommendationClaimed(java.lang.String, java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7004</differenceType>
+    <className>com/google/cloud/recommender/v1beta1/RecommenderClient</className>
+    <method>com.google.cloud.recommender.v1beta1.Recommendation markRecommendationFailed(java.lang.String, java.lang.String)</method>
+  </difference>
+  <difference>
+    <differenceType>7004</differenceType>
+    <className>com/google/cloud/recommender/v1beta1/RecommenderClient</className>
+    <method>com.google.cloud.recommender.v1beta1.Recommendation markRecommendationSucceeded(java.lang.String, java.lang.String)</method>
+  </difference>
+</differences>
diff --git a/...oud-recommender/src/main/java/com/google/cloud/recommender/v1beta1/RecommenderClient.java b/...oud-recommender/src/main/java/com/google/cloud/recommender/v1beta1/RecommenderClient.java
@@ -31,15 +31,16 @@
 import com.google.common.util.concurrent.MoreExecutors;
 import java.io.IOException;
 import java.util.List;
+import java.util.Map;
 import java.util.concurrent.TimeUnit;
 import javax.annotation.Generated;
 
 // AUTO-GENERATED DOCUMENTATION AND SERVICE
 /**
- * Service Description: Provides recommendations for cloud customers for various categories like
- * performance optimization, cost savings, reliability, feature discovery, etc. These
- * recommendations are generated automatically based on analysis of user resources, configuration
- * and monitoring metrics.
+ * Service Description: Provides insights and recommendations for cloud customers for various
+ * categories like performance optimization, cost savings, reliability, feature discovery, etc.
+ * Insights and recommendations are generated automatically based on analysis of user resources,
+ * configuration and monitoring metrics.
  *
  * <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:
@@ -279,7 +280,8 @@ public RecommenderStub getStub() {
    * <pre><code>
    * try (RecommenderClient recommenderClient = RecommenderClient.create()) {
    *   String formattedParent = RecommenderClient.formatRecommenderName("[PROJECT]", "[LOCATION]", "[RECOMMENDER]");
-   *   for (Recommendation element : recommenderClient.listRecommendations(formattedParent).iterateAll()) {
+   *   String filter = "";
+   *   for (Recommendation element : recommenderClient.listRecommendations(formattedParent, filter).iterateAll()) {
    *     // doThingsWith(element);
    *   }
    * }
@@ -289,12 +291,14 @@ public RecommenderStub getStub() {
    *     formats:
    *     <p>1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
    *     <p>LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/
+   * @param filter Filter expression to restrict the recommendations returned. Supported filter
+   *     fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  public final ListRecommendationsPagedResponse listRecommendations(String parent) {
+  public final ListRecommendationsPagedResponse listRecommendations(String parent, String filter) {
     RECOMMENDER_PATH_TEMPLATE.validate(parent, "listRecommendations");
     ListRecommendationsRequest request =
-        ListRecommendationsRequest.newBuilder().setParent(parent).build();
+        ListRecommendationsRequest.newBuilder().setParent(parent).setFilter(filter).build();
     return listRecommendations(request);
   }
 
@@ -456,12 +460,12 @@ public final UnaryCallable<GetRecommendationRequest, Recommendation> getRecommen
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Claimed. Users can use this method to indicate to the
+   * Marks the Recommendation State as Claimed. Users can use this method to indicate to the
    * Recommender API that they are starting to apply the recommendation themselves. This stops the
-   * recommendation content from being updated.
+   * recommendation content from being updated. Associated insights are frozen and placed in the
+   * ACCEPTED state.
    *
-   * <p>MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED,
-   * or ACTIVE state.
+   * <p>MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state.
    *
    * <p>Requires the recommender.&#42;.update IAM permission for the specified recommender.
    *
@@ -470,30 +474,38 @@ public final UnaryCallable<GetRecommendationRequest, Recommendation> getRecommen
    * <pre><code>
    * try (RecommenderClient recommenderClient = RecommenderClient.create()) {
    *   String formattedName = RecommenderClient.formatRecommendationName("[PROJECT]", "[LOCATION]", "[RECOMMENDER]", "[RECOMMENDATION]");
+   *   Map&lt;String, String&gt; stateMetadata = new HashMap&lt;&gt;();
    *   String etag = "";
-   *   Recommendation response = recommenderClient.markRecommendationClaimed(formattedName, etag);
+   *   Recommendation response = recommenderClient.markRecommendationClaimed(formattedName, stateMetadata, etag);
    * }
    * </code></pre>
    *
    * @param name Name of the recommendation.
+   * @param stateMetadata State properties to include with this state. Overwrites any existing
+   *     `state_metadata`.
    * @param etag Fingerprint of the Recommendation. Provides optimistic locking.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  public final Recommendation markRecommendationClaimed(String name, String etag) {
+  public final Recommendation markRecommendationClaimed(
+      String name, Map<String, String> stateMetadata, String etag) {
     RECOMMENDATION_PATH_TEMPLATE.validate(name, "markRecommendationClaimed");
     MarkRecommendationClaimedRequest request =
-        MarkRecommendationClaimedRequest.newBuilder().setName(name).setEtag(etag).build();
+        MarkRecommendationClaimedRequest.newBuilder()
+            .setName(name)
+            .putAllStateMetadata(stateMetadata)
+            .setEtag(etag)
+            .build();
     return markRecommendationClaimed(request);
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Claimed. Users can use this method to indicate to the
+   * Marks the Recommendation State as Claimed. Users can use this method to indicate to the
    * Recommender API that they are starting to apply the recommendation themselves. This stops the
-   * recommendation content from being updated.
+   * recommendation content from being updated. Associated insights are frozen and placed in the
+   * ACCEPTED state.
    *
-   * <p>MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED,
-   * or ACTIVE state.
+   * <p>MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state.
    *
    * <p>Requires the recommender.&#42;.update IAM permission for the specified recommender.
    *
@@ -520,12 +532,12 @@ public final Recommendation markRecommendationClaimed(MarkRecommendationClaimedR
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Claimed. Users can use this method to indicate to the
+   * Marks the Recommendation State as Claimed. Users can use this method to indicate to the
    * Recommender API that they are starting to apply the recommendation themselves. This stops the
-   * recommendation content from being updated.
+   * recommendation content from being updated. Associated insights are frozen and placed in the
+   * ACCEPTED state.
    *
-   * <p>MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED,
-   * or ACTIVE state.
+   * <p>MarkRecommendationClaimed can be applied to recommendations in CLAIMED or ACTIVE state.
    *
    * <p>Requires the recommender.&#42;.update IAM permission for the specified recommender.
    *
@@ -552,9 +564,10 @@ public final Recommendation markRecommendationClaimed(MarkRecommendationClaimedR
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Succeeded. Users can use this method to indicate to the
+   * Marks the Recommendation State as Succeeded. Users can use this method to indicate to the
    * Recommender API that they have applied the recommendation themselves, and the operation was
-   * successful. This stops the recommendation content from being updated.
+   * successful. This stops the recommendation content from being updated. Associated insights are
+   * frozen and placed in the ACCEPTED state.
    *
    * <p>MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED,
    * or FAILED state.
@@ -566,27 +579,36 @@ public final Recommendation markRecommendationClaimed(MarkRecommendationClaimedR
    * <pre><code>
    * try (RecommenderClient recommenderClient = RecommenderClient.create()) {
    *   String formattedName = RecommenderClient.formatRecommendationName("[PROJECT]", "[LOCATION]", "[RECOMMENDER]", "[RECOMMENDATION]");
+   *   Map&lt;String, String&gt; stateMetadata = new HashMap&lt;&gt;();
    *   String etag = "";
-   *   Recommendation response = recommenderClient.markRecommendationSucceeded(formattedName, etag);
+   *   Recommendation response = recommenderClient.markRecommendationSucceeded(formattedName, stateMetadata, etag);
    * }
    * </code></pre>
    *
    * @param name Name of the recommendation.
+   * @param stateMetadata State properties to include with this state. Overwrites any existing
+   *     `state_metadata`.
    * @param etag Fingerprint of the Recommendation. Provides optimistic locking.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  public final Recommendation markRecommendationSucceeded(String name, String etag) {
+  public final Recommendation markRecommendationSucceeded(
+      String name, Map<String, String> stateMetadata, String etag) {
     RECOMMENDATION_PATH_TEMPLATE.validate(name, "markRecommendationSucceeded");
     MarkRecommendationSucceededRequest request =
-        MarkRecommendationSucceededRequest.newBuilder().setName(name).setEtag(etag).build();
+        MarkRecommendationSucceededRequest.newBuilder()
+            .setName(name)
+            .putAllStateMetadata(stateMetadata)
+            .setEtag(etag)
+            .build();
     return markRecommendationSucceeded(request);
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Succeeded. Users can use this method to indicate to the
+   * Marks the Recommendation State as Succeeded. Users can use this method to indicate to the
    * Recommender API that they have applied the recommendation themselves, and the operation was
-   * successful. This stops the recommendation content from being updated.
+   * successful. This stops the recommendation content from being updated. Associated insights are
+   * frozen and placed in the ACCEPTED state.
    *
    * <p>MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED,
    * or FAILED state.
@@ -617,9 +639,10 @@ public final Recommendation markRecommendationSucceeded(
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Succeeded. Users can use this method to indicate to the
+   * Marks the Recommendation State as Succeeded. Users can use this method to indicate to the
    * Recommender API that they have applied the recommendation themselves, and the operation was
-   * successful. This stops the recommendation content from being updated.
+   * successful. This stops the recommendation content from being updated. Associated insights are
+   * frozen and placed in the ACCEPTED state.
    *
    * <p>MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED,
    * or FAILED state.
@@ -649,9 +672,10 @@ public final Recommendation markRecommendationSucceeded(
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Failed. Users can use this method to indicate to the
+   * Marks the Recommendation State as Failed. Users can use this method to indicate to the
    * Recommender API that they have applied the recommendation themselves, and the operation failed.
-   * This stops the recommendation content from being updated.
+   * This stops the recommendation content from being updated. Associated insights are frozen and
+   * placed in the ACCEPTED state.
    *
    * <p>MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or
    * FAILED state.
@@ -663,27 +687,36 @@ public final Recommendation markRecommendationSucceeded(
    * <pre><code>
    * try (RecommenderClient recommenderClient = RecommenderClient.create()) {
    *   String formattedName = RecommenderClient.formatRecommendationName("[PROJECT]", "[LOCATION]", "[RECOMMENDER]", "[RECOMMENDATION]");
+   *   Map&lt;String, String&gt; stateMetadata = new HashMap&lt;&gt;();
    *   String etag = "";
-   *   Recommendation response = recommenderClient.markRecommendationFailed(formattedName, etag);
+   *   Recommendation response = recommenderClient.markRecommendationFailed(formattedName, stateMetadata, etag);
    * }
    * </code></pre>
    *
    * @param name Name of the recommendation.
+   * @param stateMetadata State properties to include with this state. Overwrites any existing
+   *     `state_metadata`.
    * @param etag Fingerprint of the Recommendation. Provides optimistic locking.
    * @throws com.google.api.gax.rpc.ApiException if the remote call fails
    */
-  public final Recommendation markRecommendationFailed(String name, String etag) {
+  public final Recommendation markRecommendationFailed(
+      String name, Map<String, String> stateMetadata, String etag) {
     RECOMMENDATION_PATH_TEMPLATE.validate(name, "markRecommendationFailed");
     MarkRecommendationFailedRequest request =
-        MarkRecommendationFailedRequest.newBuilder().setName(name).setEtag(etag).build();
+        MarkRecommendationFailedRequest.newBuilder()
+            .setName(name)
+            .putAllStateMetadata(stateMetadata)
+            .setEtag(etag)
+            .build();
     return markRecommendationFailed(request);
   }
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Failed. Users can use this method to indicate to the
+   * Marks the Recommendation State as Failed. Users can use this method to indicate to the
    * Recommender API that they have applied the recommendation themselves, and the operation failed.
-   * This stops the recommendation content from being updated.
+   * This stops the recommendation content from being updated. Associated insights are frozen and
+   * placed in the ACCEPTED state.
    *
    * <p>MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or
    * FAILED state.
@@ -713,9 +746,10 @@ public final Recommendation markRecommendationFailed(MarkRecommendationFailedReq
 
   // AUTO-GENERATED DOCUMENTATION AND METHOD
   /**
-   * Mark the Recommendation State as Failed. Users can use this method to indicate to the
+   * Marks the Recommendation State as Failed. Users can use this method to indicate to the
    * Recommender API that they have applied the recommendation themselves, and the operation failed.
-   * This stops the recommendation content from being updated.
+   * This stops the recommendation content from being updated. Associated insights are frozen and
+   * placed in the ACCEPTED state.
    *
    * <p>MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or
    * FAILED state.

diff --git a/...le-cloud-recommender/src/main/java/com/google/cloud/recommender/v1beta1/package-info.java b/...le-cloud-recommender/src/main/java/com/google/cloud/recommender/v1beta1/package-info.java
@@ -21,10 +21,10 @@
  *
  * <p>================= RecommenderClient =================
  *
- * <p>Service Description: Provides recommendations for cloud customers for various categories like
- * performance optimization, cost savings, reliability, feature discovery, etc. These
- * recommendations are generated automatically based on analysis of user resources, configuration
- * and monitoring metrics.
+ * <p>Service Description: Provides insights and recommendations for cloud customers for various
+ * categories like performance optimization, cost savings, reliability, feature discovery, etc.
+ * Insights and recommendations are generated automatically based on analysis of user resources,
+ * configuration and monitoring metrics.
  *
  * <p>Sample for RecommenderClient:
  *