Class FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource

The "recommendations" collection of methods.

Inheritance

System.Object

FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Google.Apis.Recommender.v1

Assembly: Google.Apis.Recommender.v1.dll

Syntax

public class RecommendationsResource

Constructors

RecommendationsResource(IClientService)

Constructs a new resource.

Declaration

public RecommendationsResource(IClientService service)

Parameters

Type	Name	Description
Google.Apis.Services.IClientService	service

Methods

Get(String)

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

Declaration

public virtual FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.GetRequest Get(string name)

Parameters

Type	Name	Description
System.String	name	Required. Name of the recommendation.

Returns

Type	Description
FoldersResource.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 FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.ListRequest List(string parent)

Parameters

Type	Name	Description
System.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
FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.ListRequest

MarkClaimed(GoogleCloudRecommenderV1MarkRecommendationClaimedRequest, 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, SUCCEEDED, FAILED, or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Declaration

public virtual FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkClaimedRequest MarkClaimed(GoogleCloudRecommenderV1MarkRecommendationClaimedRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRecommenderV1MarkRecommendationClaimedRequest	body	The body of the request.
System.String	name	Required. Name of the recommendation.

Returns

Type	Description
FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkClaimedRequest

MarkFailed(GoogleCloudRecommenderV1MarkRecommendationFailedRequest, 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 FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkFailedRequest MarkFailed(GoogleCloudRecommenderV1MarkRecommendationFailedRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRecommenderV1MarkRecommendationFailedRequest	body	The body of the request.
System.String	name	Required. Name of the recommendation.

Returns

Type	Description
FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkFailedRequest

MarkSucceeded(GoogleCloudRecommenderV1MarkRecommendationSucceededRequest, 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 FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkSucceededRequest MarkSucceeded(GoogleCloudRecommenderV1MarkRecommendationSucceededRequest body, string name)

Parameters

Type	Name	Description
GoogleCloudRecommenderV1MarkRecommendationSucceededRequest	body	The body of the request.
System.String	name	Required. Name of the recommendation.

Returns

Type	Description
FoldersResource.LocationsResource.RecommendersResource.RecommendationsResource.MarkSucceededRequest