Skip to content

Commit 4b261d9

Browse files
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)
1 parent 5eb4aea commit 4b261d9

18 files changed

+472
-34
lines changed

docs/dyn/recommender_v1.billingAccounts.locations.insightTypes.insights.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h3>Method Details</h3>
144144

145145
Args:
146146
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)
147-
filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:&quot;DISMISSED&quot; or state:&quot;ACTIVE&quot;
147+
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)
148148
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.
149149
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.
150150
x__xgafv: string, V1 error format.

docs/dyn/recommender_v1.billingAccounts.locations.recommenders.recommendations.html

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ <h3>Method Details</h3>
127127
},
128128
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
129129
},
130+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
131+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
132+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
133+
},
134+
},
130135
},
131136
],
132137
&quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -176,6 +181,11 @@ <h3>Method Details</h3>
176181
},
177182
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
178183
},
184+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
185+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
186+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
187+
},
188+
},
179189
},
180190
&quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
181191
&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>
194204

195205
Args:
196206
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)
197-
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;
207+
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)
198208
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.
199209
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.
200210
x__xgafv: string, V1 error format.
@@ -220,6 +230,11 @@ <h3>Method Details</h3>
220230
},
221231
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
222232
},
233+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
234+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
235+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
236+
},
237+
},
223238
},
224239
],
225240
&quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -269,6 +284,11 @@ <h3>Method Details</h3>
269284
},
270285
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
271286
},
287+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
288+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
289+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
290+
},
291+
},
272292
},
273293
&quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
274294
&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>
333353
},
334354
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
335355
},
356+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
357+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
358+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
359+
},
360+
},
336361
},
337362
],
338363
&quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -382,6 +407,11 @@ <h3>Method Details</h3>
382407
},
383408
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
384409
},
410+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
411+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
412+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
413+
},
414+
},
385415
},
386416
&quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
387417
&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>
430460
},
431461
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
432462
},
463+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
464+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
465+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
466+
},
467+
},
433468
},
434469
],
435470
&quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -479,6 +514,11 @@ <h3>Method Details</h3>
479514
},
480515
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
481516
},
517+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
518+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
519+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
520+
},
521+
},
482522
},
483523
&quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
484524
&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>
527567
},
528568
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
529569
},
570+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
571+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
572+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
573+
},
574+
},
530575
},
531576
],
532577
&quot;associatedInsights&quot;: [ # Insights that led to this recommendation.
@@ -576,6 +621,11 @@ <h3>Method Details</h3>
576621
},
577622
&quot;duration&quot;: &quot;A String&quot;, # Duration for which this cost applies.
578623
},
624+
&quot;securityProjection&quot;: { # Contains various ways of describing the impact on Security. # Use with CategoryType.SECURITY
625+
&quot;details&quot;: { # Additional security impact details that is provided by the recommender.
626+
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
627+
},
628+
},
579629
},
580630
&quot;priority&quot;: &quot;A String&quot;, # Recommendation&#x27;s priority.
581631
&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;

docs/dyn/recommender_v1.folders.locations.insightTypes.insights.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ <h3>Method Details</h3>
144144

145145
Args:
146146
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)
147-
filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: state Eg: `state:&quot;DISMISSED&quot; or state:&quot;ACTIVE&quot;
147+
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)
148148
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.
149149
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.
150150
x__xgafv: string, V1 error format.

0 commit comments

Comments
 (0)