feat(recommender): update the api

#### recommender:v1 The following keys were added: - schemas.GoogleCloudRecommenderV1Impact.properties.securityProjection.$ref (Total Keys: 1) - schemas.GoogleCloudRecommenderV1SecurityProjection (Total Keys: 4) #### recommender:v1beta1 The following keys were added: - schemas.GoogleCloudRecommenderV1beta1Impact.properties.securityProjection.$ref (Total Keys: 1) - schemas.GoogleCloudRecommenderV1beta1SecurityProjection (Total Keys: 4)
googleapis · May 15, 2021 · 4b261d9 · 4b261d9
1 parent 5eb4aea
commit 4b261d9
Show file tree

Hide file tree

Showing 18 changed files with 472 additions and 34 deletions.
diff --git a/docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.insights.html b/docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.insights.html
@@ -144,7 +144,7 @@ <h3>Method Details</h3>
 
 Args:
   parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. (required)
-  filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:&quot;DISMISSED&quot; or state:&quot;ACTIVE&quot;
+  filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
   pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
   x__xgafv: string, V1 error format.

diff --git a/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html b/docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html
@@ -127,6 +127,11 @@ <h3>Method Details</h3>
         },
         &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
       },
+      &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+        &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+        },
+      },
     },
   ],
   &quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -176,6 +181,11 @@ <h3>Method Details</h3>
       },
       &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
     },
+    &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+      &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+      },
+    },
   },
   &quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
   &quot;recommenderSubtype&quot;: &quot;A String&quot;, # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = &quot;google.iam.policy.Recommender&quot;, recommender_subtype can be one of &quot;REMOVE_ROLE&quot;/&quot;REPLACE_ROLE&quot;
@@ -194,7 +204,7 @@ <h3>Method Details</h3>
 
 Args:
   parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ RECOMMENDER_ID refers to supported recommenders: https://cloud.google.com/recommender/docs/recommenders. (required)
-  filter: string, Filter expression to restrict the recommendations returned. Supported filter fields: state_info.state Eg: `state_info.state:&quot;DISMISSED&quot; or state_info.state:&quot;FAILED&quot;
+  filter: string, Filter expression to restrict the recommendations returned. Supported filter fields: * `state_info.state` * `recommenderSubtype` * `priority` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE` * `priority = P1 OR priority = P2` * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)` (These expressions are based on the filter language described at https://google.aip.dev/160)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
   pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
   x__xgafv: string, V1 error format.
@@ -220,6 +230,11 @@ <h3>Method Details</h3>
             },
             &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
           },
+          &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+            &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+              &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+            },
+          },
         },
       ],
       &quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -269,6 +284,11 @@ <h3>Method Details</h3>
           },
           &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
         },
+        &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+          &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+            &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+          },
+        },
       },
       &quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
       &quot;recommenderSubtype&quot;: &quot;A String&quot;, # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = &quot;google.iam.policy.Recommender&quot;, recommender_subtype can be one of &quot;REMOVE_ROLE&quot;/&quot;REPLACE_ROLE&quot;
@@ -333,6 +353,11 @@ <h3>Method Details</h3>
         },
         &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
       },
+      &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+        &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+        },
+      },
     },
   ],
   &quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -382,6 +407,11 @@ <h3>Method Details</h3>
       },
       &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
     },
+    &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+      &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+      },
+    },
   },
   &quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
   &quot;recommenderSubtype&quot;: &quot;A String&quot;, # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = &quot;google.iam.policy.Recommender&quot;, recommender_subtype can be one of &quot;REMOVE_ROLE&quot;/&quot;REPLACE_ROLE&quot;
@@ -430,6 +460,11 @@ <h3>Method Details</h3>
         },
         &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
       },
+      &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+        &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+        },
+      },
     },
   ],
   &quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -479,6 +514,11 @@ <h3>Method Details</h3>
       },
       &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
     },
+    &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+      &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+      },
+    },
   },
   &quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
   &quot;recommenderSubtype&quot;: &quot;A String&quot;, # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = &quot;google.iam.policy.Recommender&quot;, recommender_subtype can be one of &quot;REMOVE_ROLE&quot;/&quot;REPLACE_ROLE&quot;
@@ -527,6 +567,11 @@ <h3>Method Details</h3>
         },
         &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
       },
+      &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+        &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+          &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+        },
+      },
     },
   ],
   &quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -576,6 +621,11 @@ <h3>Method Details</h3>
       },
       &quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
     },
+    &quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
+      &quot;details&quot;: { # Additional security impact details that is provided by the recommender.
+        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
+      },
+    },
   },
   &quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
   &quot;recommenderSubtype&quot;: &quot;A String&quot;, # Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = &quot;google.iam.policy.Recommender&quot;, recommender_subtype can be one of &quot;REMOVE_ROLE&quot;/&quot;REPLACE_ROLE&quot;

diff --git a/docs/dyn/recommender_v1.folders.locations.insightTypes.insights.html b/docs/dyn/recommender_v1.folders.locations.insightTypes.insights.html
@@ -144,7 +144,7 @@ <h3>Method Details</h3>
 
 Args:
   parent: string, Required. The container resource on which to execute the request. Acceptable formats: 1. `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 2. `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 3. `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` 4. `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]` LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/ INSIGHT_TYPE_ID refers to supported insight types: https://cloud.google.com/recommender/docs/insights/insight-types. (required)
-  filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:&quot;DISMISSED&quot; or state:&quot;ACTIVE&quot;
+  filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `stateInfo.state` * `insightSubtype` * `severity` Examples: * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED` * `insightSubtype = PERMISSIONS_USAGE` * `severity = CRITICAL OR severity = HIGH` * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)` (These expressions are based on the filter language described at https://google.aip.dev/160)
   pageSize: integer, Optional. The maximum number of results to return from this request. Non-positive values are ignored. If not specified, the server will determine the number of results to return.
   pageToken: string, Optional. If present, retrieves the next batch of results from the preceding call to this method. `page_token` must be the value of `next_page_token` from the previous response. The values of other method parameters must be identical to those in the previous call.
   x__xgafv: string, V1 error format.