Show / Hide Table of Contents

Class OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource

The "recommendations" collection of methods.

Inheritance
object
OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Recommender.v1beta1
Assembly: Google.Apis.Recommender.v1beta1.dll
Syntax
public class OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource

Constructors

RecommendationsResource(IClientService)

Constructs a new resource.

Declaration
public RecommendationsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Methods

Get(string)

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

Declaration
public virtual OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. Name of the recommendation.

Returns
Type Description
OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.GetRequest

List(string)

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

Declaration
public virtual OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

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

Returns
Type Description
OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.ListRequest

MarkClaimed(GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest, string)

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 or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Declaration
public virtual OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkClaimedRequest MarkClaimed(GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest body, string name)
Parameters
Type Name Description
GoogleCloudRecommenderV1beta1MarkRecommendationClaimedRequest body

The body of the request.

string name

Required. Name of the recommendation.

Returns
Type Description
OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkClaimedRequest

MarkDismissed(GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest, string)

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.

Declaration
public virtual OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkDismissedRequest MarkDismissed(GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest body, string name)
Parameters
Type Name Description
GoogleCloudRecommenderV1beta1MarkRecommendationDismissedRequest body

The body of the request.

string name

Required. Name of the recommendation.

Returns
Type Description
OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkDismissedRequest

MarkFailed(GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest, string)

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.

Declaration
public virtual OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkFailedRequest MarkFailed(GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest body, string name)
Parameters
Type Name Description
GoogleCloudRecommenderV1beta1MarkRecommendationFailedRequest body

The body of the request.

string name

Required. Name of the recommendation.

Returns
Type Description
OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkFailedRequest

MarkSucceeded(GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest, string)

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.

Declaration
public virtual OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkSucceededRequest MarkSucceeded(GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest body, string name)
Parameters
Type Name Description
GoogleCloudRecommenderV1beta1MarkRecommendationSucceededRequest body

The body of the request.

string name

Required. Name of the recommendation.

Returns
Type Description
OrganizationsResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkSucceededRequest
In this article
Back to top Generated by DocFX