class OrganizationsLocationsRecommendersRecommendations extends Resource (View source)

The "recommendations" collection of methods.

Typical usage is:

 $recommenderService = new Google\Service\Recommender(...);
 $recommendations = $recommenderService->organizations_locations_recommenders_recommendations;

Methods

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

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. (recommendations.get)

listOrganizationsLocationsRecommendersRecommendations(string $parent, array $optParams = [])

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

markClaimed(string $name, GoogleCloudRecommenderV1MarkRecommendationClaimedRequest $postBody, array $optParams = [])

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. Associated insights are frozen and placed in the ACCEPTED state.

markDismissed(string $name, GoogleCloudRecommenderV1MarkRecommendationDismissedRequest $postBody, array $optParams = [])

Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markDismissed)

markFailed(string $name, GoogleCloudRecommenderV1MarkRecommendationFailedRequest $postBody, array $optParams = [])

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. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markFailed)

markSucceeded(string $name, GoogleCloudRecommenderV1MarkRecommendationSucceededRequest $postBody, array $optParams = [])

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. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

Details

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

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. (recommendations.get)

Parameters

string $name

Required. Name of the recommendation.

array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1Recommendation

Exceptions

Exception

GoogleCloudRecommenderV1ListRecommendationsResponse listOrganizationsLocationsRecommendersRecommendations(string $parent, array $optParams = [])

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

(recommendations.listOrganizationsLocationsRecommendersRecommendations)

Parameters

string $parent

Required. The container resource on which to execute the request. Acceptable formats: projects/[PROJECT_NUMBER]/locations/[LOCA TION]/recommenders/[RECOMMENDER_ID] projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECO MMENDER_ID] folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID] * o rganizations/[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.

array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1ListRecommendationsResponse

Exceptions

Exception

GoogleCloudRecommenderV1Recommendation markClaimed(string $name, GoogleCloudRecommenderV1MarkRecommendationClaimedRequest $postBody, array $optParams = [])

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. Associated insights are frozen and placed in the ACCEPTED state.

MarkRecommendationClaimed can be applied to recommendations in CLAIMED, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markClaimed)

Parameters

string $name

Required. Name of the recommendation.

GoogleCloudRecommenderV1MarkRecommendationClaimedRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1Recommendation

Exceptions

Exception

GoogleCloudRecommenderV1Recommendation markDismissed(string $name, GoogleCloudRecommenderV1MarkRecommendationDismissedRequest $postBody, array $optParams = [])

Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED. MarkRecommendationDismissed can be applied to recommendations in ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markDismissed)

Parameters

string $name

Required. Name of the recommendation.

GoogleCloudRecommenderV1MarkRecommendationDismissedRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1Recommendation

Exceptions

Exception

GoogleCloudRecommenderV1Recommendation markFailed(string $name, GoogleCloudRecommenderV1MarkRecommendationFailedRequest $postBody, array $optParams = [])

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. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationFailed can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender. (recommendations.markFailed)

Parameters

string $name

Required. Name of the recommendation.

GoogleCloudRecommenderV1MarkRecommendationFailedRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1Recommendation

Exceptions

Exception

GoogleCloudRecommenderV1Recommendation markSucceeded(string $name, GoogleCloudRecommenderV1MarkRecommendationSucceededRequest $postBody, array $optParams = [])

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. Associated insights are frozen and placed in the ACCEPTED state. MarkRecommendationSucceeded can be applied to recommendations in ACTIVE, CLAIMED, SUCCEEDED, or FAILED state. Requires the recommender.*.update IAM permission for the specified recommender.

(recommendations.markSucceeded)

Parameters

string $name

Required. Name of the recommendation.

GoogleCloudRecommenderV1MarkRecommendationSucceededRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudRecommenderV1Recommendation

Exceptions

Exception