Google Cloud Recommender v1 API - Class Recommender.RecommenderBase (3.3.0)

Version 3.3.0

• 3.7.0 (latest)
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0

[BindServiceMethod(typeof(Recommender), "BindService")]
public abstract class Recommender.RecommenderBase

Reference documentation and code samples for the Google Cloud Recommender v1 API class Recommender.RecommenderBase.

Base class for server-side implementations of Recommender

Inheritance

object > Recommender.RecommenderBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Methods

GetInsight(GetInsightRequest, ServerCallContext)

public virtual Task<Insight> GetInsight(GetInsightRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetInsightRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInsight	The response to send back to the client (wrapped by a task).

GetInsightTypeConfig(GetInsightTypeConfigRequest, ServerCallContext)

public virtual Task<InsightTypeConfig> GetInsightTypeConfig(GetInsightTypeConfigRequest request, ServerCallContext context)

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

Parameters
Name	Description
request	GetInsightTypeConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInsightTypeConfig	The response to send back to the client (wrapped by a task).

GetRecommendation(GetRecommendationRequest, ServerCallContext)

public virtual Task<Recommendation> GetRecommendation(GetRecommendationRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetRecommendationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRecommendation	The response to send back to the client (wrapped by a task).

GetRecommenderConfig(GetRecommenderConfigRequest, ServerCallContext)

public virtual Task<RecommenderConfig> GetRecommenderConfig(GetRecommenderConfigRequest request, ServerCallContext context)

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

Parameters
Name	Description
request	GetRecommenderConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRecommenderConfig	The response to send back to the client (wrapped by a task).

ListInsights(ListInsightsRequest, ServerCallContext)

public virtual Task<ListInsightsResponse> ListInsights(ListInsightsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListInsightsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListInsightsResponse	The response to send back to the client (wrapped by a task).

ListRecommendations(ListRecommendationsRequest, ServerCallContext)

public virtual Task<ListRecommendationsResponse> ListRecommendations(ListRecommendationsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListRecommendationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListRecommendationsResponse	The response to send back to the client (wrapped by a task).

MarkInsightAccepted(MarkInsightAcceptedRequest, ServerCallContext)

public virtual Task<Insight> MarkInsightAccepted(MarkInsightAcceptedRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	MarkInsightAcceptedRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInsight	The response to send back to the client (wrapped by a task).

MarkRecommendationClaimed(MarkRecommendationClaimedRequest, ServerCallContext)

public virtual Task<Recommendation> MarkRecommendationClaimed(MarkRecommendationClaimedRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	MarkRecommendationClaimedRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRecommendation	The response to send back to the client (wrapped by a task).

MarkRecommendationDismissed(MarkRecommendationDismissedRequest, ServerCallContext)

public virtual Task<Recommendation> MarkRecommendationDismissed(MarkRecommendationDismissedRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	MarkRecommendationDismissedRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRecommendation	The response to send back to the client (wrapped by a task).

MarkRecommendationFailed(MarkRecommendationFailedRequest, ServerCallContext)

public virtual Task<Recommendation> MarkRecommendationFailed(MarkRecommendationFailedRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	MarkRecommendationFailedRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRecommendation	The response to send back to the client (wrapped by a task).

MarkRecommendationSucceeded(MarkRecommendationSucceededRequest, ServerCallContext)

public virtual Task<Recommendation> MarkRecommendationSucceeded(MarkRecommendationSucceededRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	MarkRecommendationSucceededRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRecommendation	The response to send back to the client (wrapped by a task).

UpdateInsightTypeConfig(UpdateInsightTypeConfigRequest, ServerCallContext)

public virtual Task<InsightTypeConfig> UpdateInsightTypeConfig(UpdateInsightTypeConfigRequest request, ServerCallContext context)

Updates an InsightTypeConfig change. This will create a new revision of the config.

Parameters
Name	Description
request	UpdateInsightTypeConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInsightTypeConfig	The response to send back to the client (wrapped by a task).

UpdateRecommenderConfig(UpdateRecommenderConfigRequest, ServerCallContext)

public virtual Task<RecommenderConfig> UpdateRecommenderConfig(UpdateRecommenderConfigRequest request, ServerCallContext context)

Updates a Recommender Config. This will create a new revision of the config.

Parameters
Name	Description
request	UpdateRecommenderConfigRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRecommenderConfig	The response to send back to the client (wrapped by a task).