Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit 5758d5d

Browse files
feat: Recommendation Priority / Insight Severity (#709)
- [ ] Regenerate this pull request now. feat: Recommendation xor_group_id feat: Recommendation security projection feat: Configurable recommenders Incorporate above new features, as well as update .bazel files. PiperOrigin-RevId: 424391246 Source-Link: googleapis/googleapis@2060f89 Source-Link: https://github.com/googleapis/googleapis-gen/commit/7bd16df69dbf75915ff8f96698510c90061161af Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiN2JkMTZkZjY5ZGJmNzU5MTVmZjhmOTY2OTg1MTBjOTAwNjExNjFhZiJ9
1 parent 6384369 commit 5758d5d

File tree

85 files changed

+20571
-790
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+20571
-790
lines changed

google-cloud-recommender/src/main/java/com/google/cloud/recommender/v1/RecommenderClient.java

Lines changed: 166 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ public RecommenderStub getStub() {
153153

154154
// AUTO-GENERATED DOCUMENTATION AND METHOD.
155155
/**
156-
* Lists insights for a Cloud project. Requires the recommender.*.list IAM permission for the
157-
* specified insight type.
156+
* Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM
157+
* permission for the specified insight type.
158158
*
159159
* <p>Sample code:
160160
*
@@ -171,10 +171,24 @@ public RecommenderStub getStub() {
171171
*
172172
* @param parent Required. The container resource on which to execute the request. Acceptable
173173
* formats:
174-
* <p>1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",
174+
* <ul>
175+
* <li>`projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
176+
* </ul>
177+
* <ul>
178+
* <li>`projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
179+
* </ul>
180+
* <ul>
181+
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
182+
* </ul>
183+
* <ul>
184+
* <li>`folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
185+
* </ul>
186+
* <ul>
187+
* <li>`organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
188+
* </ul>
175189
* <p>LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/
176190
* INSIGHT_TYPE_ID refers to supported insight types:
177-
* https://cloud.google.com/recommender/docs/insights/insight-types.)
191+
* https://cloud.google.com/recommender/docs/insights/insight-types.
178192
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
179193
*/
180194
public final ListInsightsPagedResponse listInsights(InsightTypeName parent) {
@@ -187,8 +201,8 @@ public final ListInsightsPagedResponse listInsights(InsightTypeName parent) {
187201

188202
// AUTO-GENERATED DOCUMENTATION AND METHOD.
189203
/**
190-
* Lists insights for a Cloud project. Requires the recommender.&#42;.list IAM permission for the
191-
* specified insight type.
204+
* Lists insights for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
205+
* permission for the specified insight type.
192206
*
193207
* <p>Sample code:
194208
*
@@ -206,10 +220,24 @@ public final ListInsightsPagedResponse listInsights(InsightTypeName parent) {
206220
*
207221
* @param parent Required. The container resource on which to execute the request. Acceptable
208222
* formats:
209-
* <p>1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]",
223+
* <ul>
224+
* <li>`projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
225+
* </ul>
226+
* <ul>
227+
* <li>`projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
228+
* </ul>
229+
* <ul>
230+
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
231+
* </ul>
232+
* <ul>
233+
* <li>`folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
234+
* </ul>
235+
* <ul>
236+
* <li>`organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
237+
* </ul>
210238
* <p>LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/
211239
* INSIGHT_TYPE_ID refers to supported insight types:
212-
* https://cloud.google.com/recommender/docs/insights/insight-types.)
240+
* https://cloud.google.com/recommender/docs/insights/insight-types.
213241
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
214242
*/
215243
public final ListInsightsPagedResponse listInsights(String parent) {
@@ -219,8 +247,8 @@ public final ListInsightsPagedResponse listInsights(String parent) {
219247

220248
// AUTO-GENERATED DOCUMENTATION AND METHOD.
221249
/**
222-
* Lists insights for a Cloud project. Requires the recommender.&#42;.list IAM permission for the
223-
* specified insight type.
250+
* Lists insights for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
251+
* permission for the specified insight type.
224252
*
225253
* <p>Sample code:
226254
*
@@ -251,8 +279,8 @@ public final ListInsightsPagedResponse listInsights(ListInsightsRequest request)
251279

252280
// AUTO-GENERATED DOCUMENTATION AND METHOD.
253281
/**
254-
* Lists insights for a Cloud project. Requires the recommender.&#42;.list IAM permission for the
255-
* specified insight type.
282+
* Lists insights for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
283+
* permission for the specified insight type.
256284
*
257285
* <p>Sample code:
258286
*
@@ -283,8 +311,8 @@ public final ListInsightsPagedResponse listInsights(ListInsightsRequest request)
283311

284312
// AUTO-GENERATED DOCUMENTATION AND METHOD.
285313
/**
286-
* Lists insights for a Cloud project. Requires the recommender.&#42;.list IAM permission for the
287-
* specified insight type.
314+
* Lists insights for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
315+
* permission for the specified insight type.
288316
*
289317
* <p>Sample code:
290318
*
@@ -569,8 +597,8 @@ public final UnaryCallable<MarkInsightAcceptedRequest, Insight> markInsightAccep
569597

570598
// AUTO-GENERATED DOCUMENTATION AND METHOD.
571599
/**
572-
* Lists recommendations for a Cloud project. Requires the recommender.&#42;.list IAM permission
573-
* for the specified recommender.
600+
* Lists recommendations for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
601+
* permission for the specified recommender.
574602
*
575603
* <p>Sample code:
576604
*
@@ -587,7 +615,21 @@ public final UnaryCallable<MarkInsightAcceptedRequest, Insight> markInsightAccep
587615
*
588616
* @param parent Required. The container resource on which to execute the request. Acceptable
589617
* formats:
590-
* <p>1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
618+
* <ul>
619+
* <li>`projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
620+
* </ul>
621+
* <ul>
622+
* <li>`projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
623+
* </ul>
624+
* <ul>
625+
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
626+
* </ul>
627+
* <ul>
628+
* <li>`folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
629+
* </ul>
630+
* <ul>
631+
* <li>`organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
632+
* </ul>
591633
* <p>LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/
592634
* RECOMMENDER_ID refers to supported recommenders:
593635
* https://cloud.google.com/recommender/docs/recommenders.
@@ -603,8 +645,8 @@ public final ListRecommendationsPagedResponse listRecommendations(RecommenderNam
603645

604646
// AUTO-GENERATED DOCUMENTATION AND METHOD.
605647
/**
606-
* Lists recommendations for a Cloud project. Requires the recommender.&#42;.list IAM permission
607-
* for the specified recommender.
648+
* Lists recommendations for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
649+
* permission for the specified recommender.
608650
*
609651
* <p>Sample code:
610652
*
@@ -622,7 +664,21 @@ public final ListRecommendationsPagedResponse listRecommendations(RecommenderNam
622664
*
623665
* @param parent Required. The container resource on which to execute the request. Acceptable
624666
* formats:
625-
* <p>1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
667+
* <ul>
668+
* <li>`projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
669+
* </ul>
670+
* <ul>
671+
* <li>`projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
672+
* </ul>
673+
* <ul>
674+
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
675+
* </ul>
676+
* <ul>
677+
* <li>`folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
678+
* </ul>
679+
* <ul>
680+
* <li>`organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
681+
* </ul>
626682
* <p>LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/
627683
* RECOMMENDER_ID refers to supported recommenders:
628684
* https://cloud.google.com/recommender/docs/recommenders.
@@ -636,8 +692,8 @@ public final ListRecommendationsPagedResponse listRecommendations(String parent)
636692

637693
// AUTO-GENERATED DOCUMENTATION AND METHOD.
638694
/**
639-
* Lists recommendations for a Cloud project. Requires the recommender.&#42;.list IAM permission
640-
* for the specified recommender.
695+
* Lists recommendations for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
696+
* permission for the specified recommender.
641697
*
642698
* <p>Sample code:
643699
*
@@ -656,12 +712,50 @@ public final ListRecommendationsPagedResponse listRecommendations(String parent)
656712
*
657713
* @param parent Required. The container resource on which to execute the request. Acceptable
658714
* formats:
659-
* <p>1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
715+
* <ul>
716+
* <li>`projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
717+
* </ul>
718+
* <ul>
719+
* <li>`projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
720+
* </ul>
721+
* <ul>
722+
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
723+
* </ul>
724+
* <ul>
725+
* <li>`folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
726+
* </ul>
727+
* <ul>
728+
* <li>`organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
729+
* </ul>
660730
* <p>LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/
661731
* RECOMMENDER_ID refers to supported recommenders:
662732
* https://cloud.google.com/recommender/docs/recommenders.
663733
* @param filter Filter expression to restrict the recommendations returned. Supported filter
664-
* fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
734+
* fields:
735+
* <ul>
736+
* <li>`state_info.state`
737+
* </ul>
738+
* <ul>
739+
* <li>`recommenderSubtype`
740+
* </ul>
741+
* <ul>
742+
* <li>`priority`
743+
* </ul>
744+
* <p>Examples:
745+
* <ul>
746+
* <li>`stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
747+
* </ul>
748+
* <ul>
749+
* <li>`recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`
750+
* </ul>
751+
* <ul>
752+
* <li>`priority = P1 OR priority = P2`
753+
* </ul>
754+
* <ul>
755+
* <li>`stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)`
756+
* </ul>
757+
* <p>(These expressions are based on the filter language described at
758+
* https://google.aip.dev/160)
665759
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
666760
*/
667761
public final ListRecommendationsPagedResponse listRecommendations(
@@ -676,8 +770,8 @@ public final ListRecommendationsPagedResponse listRecommendations(
676770

677771
// AUTO-GENERATED DOCUMENTATION AND METHOD.
678772
/**
679-
* Lists recommendations for a Cloud project. Requires the recommender.&#42;.list IAM permission
680-
* for the specified recommender.
773+
* Lists recommendations for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
774+
* permission for the specified recommender.
681775
*
682776
* <p>Sample code:
683777
*
@@ -697,12 +791,50 @@ public final ListRecommendationsPagedResponse listRecommendations(
697791
*
698792
* @param parent Required. The container resource on which to execute the request. Acceptable
699793
* formats:
700-
* <p>1. "projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]",
794+
* <ul>
795+
* <li>`projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
796+
* </ul>
797+
* <ul>
798+
* <li>`projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
799+
* </ul>
800+
* <ul>
801+
* <li>`billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
802+
* </ul>
803+
* <ul>
804+
* <li>`folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
805+
* </ul>
806+
* <ul>
807+
* <li>`organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
808+
* </ul>
701809
* <p>LOCATION here refers to GCP Locations: https://cloud.google.com/about/locations/
702810
* RECOMMENDER_ID refers to supported recommenders:
703811
* https://cloud.google.com/recommender/docs/recommenders.
704812
* @param filter Filter expression to restrict the recommendations returned. Supported filter
705-
* fields: state_info.state Eg: `state_info.state:"DISMISSED" or state_info.state:"FAILED"
813+
* fields:
814+
* <ul>
815+
* <li>`state_info.state`
816+
* </ul>
817+
* <ul>
818+
* <li>`recommenderSubtype`
819+
* </ul>
820+
* <ul>
821+
* <li>`priority`
822+
* </ul>
823+
* <p>Examples:
824+
* <ul>
825+
* <li>`stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
826+
* </ul>
827+
* <ul>
828+
* <li>`recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`
829+
* </ul>
830+
* <ul>
831+
* <li>`priority = P1 OR priority = P2`
832+
* </ul>
833+
* <ul>
834+
* <li>`stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)`
835+
* </ul>
836+
* <p>(These expressions are based on the filter language described at
837+
* https://google.aip.dev/160)
706838
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
707839
*/
708840
public final ListRecommendationsPagedResponse listRecommendations(String parent, String filter) {
@@ -713,8 +845,8 @@ public final ListRecommendationsPagedResponse listRecommendations(String parent,
713845

714846
// AUTO-GENERATED DOCUMENTATION AND METHOD.
715847
/**
716-
* Lists recommendations for a Cloud project. Requires the recommender.&#42;.list IAM permission
717-
* for the specified recommender.
848+
* Lists recommendations for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
849+
* permission for the specified recommender.
718850
*
719851
* <p>Sample code:
720852
*
@@ -746,8 +878,8 @@ public final ListRecommendationsPagedResponse listRecommendations(
746878

747879
// AUTO-GENERATED DOCUMENTATION AND METHOD.
748880
/**
749-
* Lists recommendations for a Cloud project. Requires the recommender.&#42;.list IAM permission
750-
* for the specified recommender.
881+
* Lists recommendations for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
882+
* permission for the specified recommender.
751883
*
752884
* <p>Sample code:
753885
*
@@ -779,8 +911,8 @@ public final ListRecommendationsPagedResponse listRecommendations(
779911

780912
// AUTO-GENERATED DOCUMENTATION AND METHOD.
781913
/**
782-
* Lists recommendations for a Cloud project. Requires the recommender.&#42;.list IAM permission
783-
* for the specified recommender.
914+
* Lists recommendations for the specified Cloud Resource. Requires the recommender.&#42;.list IAM
915+
* permission for the specified recommender.
784916
*
785917
* <p>Sample code:
786918
*

google-cloud-recommender/src/main/java/com/google/cloud/recommender/v1/package-info.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@
1515
*/
1616

1717
/**
18-
* The interfaces provided are listed below, along with usage samples.
18+
* A client to Recommender API
19+
*
20+
* <p>The interfaces provided are listed below, along with usage samples.
1921
*
2022
* <p>======================= RecommenderClient =======================
2123
*

0 commit comments

Comments
 (0)