1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Recommender
  7. \
  8. Resource
  9. \
  10. OrganizationsLocationsInsightTypesInsights

OrganizationsLocationsInsightTypesInsights

class OrganizationsLocationsInsightTypesInsights extends Resource (View source)

The "insights" collection of methods.

Typical usage is:

 $recommenderService = new Google\Service\Recommender(...);
 $insights = $recommenderService->organizations_locations_insightTypes_insights;

Methods

GoogleCloudRecommenderV1Insight
get(string $name, array $optParams = [])

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. (insights.get)

GoogleCloudRecommenderV1ListInsightsResponse
listOrganizationsLocationsInsightTypesInsights(string $parent, array $optParams = [])

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

GoogleCloudRecommenderV1Insight
markAccepted(string $name, GoogleCloudRecommenderV1MarkInsightAcceptedRequest $postBody, array $optParams = [])

Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight.

Details

at line 43
GoogleCloudRecommenderV1Insight get(string $name, array $optParams = [])

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. (insights.get)

Parameters

string $name

Required. Name of the insight.
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1Insight

Exceptions

Exception

at line 88
GoogleCloudRecommenderV1ListInsightsResponse listOrganizationsLocationsInsightTypesInsights(string $parent, array $optParams = [])

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

(insights.listOrganizationsLocationsInsightTypesInsights)

Parameters

string $parent

Required. The container resource on which to execute the request. Acceptable formats: projects/[PROJECT_NUMBER]/locations/[LOCA TION]/insightTypes/[INSIGHT_TYPE_ID] projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSI GHT_TYPE_ID] folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID] * organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TY PE_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.
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1ListInsightsResponse

Exceptions

Exception

at line 107
GoogleCloudRecommenderV1Insight markAccepted(string $name, GoogleCloudRecommenderV1MarkInsightAcceptedRequest $postBody, array $optParams = [])

Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight.

This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. (insights.markAccepted)

Parameters

string $name

Required. Name of the insight.
GoogleCloudRecommenderV1MarkInsightAcceptedRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1Insight

Exceptions

Exception