Google Cloud Recommender v1 API - Class Recommender.RecommenderClient (3.6.0)

Version 3.6.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

public class Recommender.RecommenderClient : ClientBase<Recommender.RecommenderClient>

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

Client for Recommender

Inheritance

object > ClientBase > ClientBaseRecommenderRecommenderClient > Recommender.RecommenderClient

Inherited Members

ClientBase<Recommender.RecommenderClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Constructors

RecommenderClient()

protected RecommenderClient()

Protected parameterless constructor to allow creation of test doubles.

RecommenderClient(CallInvoker)

public RecommenderClient(CallInvoker callInvoker)

Creates a new client for Recommender that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

RecommenderClient(ChannelBase)

public RecommenderClient(ChannelBase channel)

Creates a new client for Recommender

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

RecommenderClient(ClientBaseConfiguration)

protected RecommenderClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

GetInsight(GetInsightRequest, CallOptions)

public virtual Insight GetInsight(GetInsightRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetInsightRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Insight	The response received from the server.

GetInsight(GetInsightRequest, Metadata, DateTime?, CancellationToken)

public virtual Insight GetInsight(GetInsightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetInsightRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Insight	The response received from the server.

GetInsightAsync(GetInsightRequest, CallOptions)

public virtual AsyncUnaryCall<Insight> GetInsightAsync(GetInsightRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetInsightRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInsight	The call object.

GetInsightAsync(GetInsightRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Insight> GetInsightAsync(GetInsightRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetInsightRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInsight	The call object.

GetInsightTypeConfig(GetInsightTypeConfigRequest, CallOptions)

public virtual InsightTypeConfig GetInsightTypeConfig(GetInsightTypeConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetInsightTypeConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
InsightTypeConfig	The response received from the server.

GetInsightTypeConfig(GetInsightTypeConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual InsightTypeConfig GetInsightTypeConfig(GetInsightTypeConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetInsightTypeConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
InsightTypeConfig	The response received from the server.

GetInsightTypeConfigAsync(GetInsightTypeConfigRequest, CallOptions)

public virtual AsyncUnaryCall<InsightTypeConfig> GetInsightTypeConfigAsync(GetInsightTypeConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetInsightTypeConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInsightTypeConfig	The call object.

GetInsightTypeConfigAsync(GetInsightTypeConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InsightTypeConfig> GetInsightTypeConfigAsync(GetInsightTypeConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetInsightTypeConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInsightTypeConfig	The call object.

GetRecommendation(GetRecommendationRequest, CallOptions)

public virtual Recommendation GetRecommendation(GetRecommendationRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetRecommendationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Recommendation	The response received from the server.

GetRecommendation(GetRecommendationRequest, Metadata, DateTime?, CancellationToken)

public virtual Recommendation GetRecommendation(GetRecommendationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetRecommendationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Recommendation	The response received from the server.

GetRecommendationAsync(GetRecommendationRequest, CallOptions)

public virtual AsyncUnaryCall<Recommendation> GetRecommendationAsync(GetRecommendationRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetRecommendationRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

GetRecommendationAsync(GetRecommendationRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Recommendation> GetRecommendationAsync(GetRecommendationRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetRecommendationRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

GetRecommenderConfig(GetRecommenderConfigRequest, CallOptions)

public virtual RecommenderConfig GetRecommenderConfig(GetRecommenderConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetRecommenderConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RecommenderConfig	The response received from the server.

GetRecommenderConfig(GetRecommenderConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual RecommenderConfig GetRecommenderConfig(GetRecommenderConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetRecommenderConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RecommenderConfig	The response received from the server.

GetRecommenderConfigAsync(GetRecommenderConfigRequest, CallOptions)

public virtual AsyncUnaryCall<RecommenderConfig> GetRecommenderConfigAsync(GetRecommenderConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	GetRecommenderConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRecommenderConfig	The call object.

GetRecommenderConfigAsync(GetRecommenderConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RecommenderConfig> GetRecommenderConfigAsync(GetRecommenderConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	GetRecommenderConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRecommenderConfig	The call object.

ListInsights(ListInsightsRequest, CallOptions)

public virtual ListInsightsResponse ListInsights(ListInsightsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListInsightsResponse	The response received from the server.

ListInsights(ListInsightsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListInsightsResponse ListInsights(ListInsightsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListInsightsResponse	The response received from the server.

ListInsightsAsync(ListInsightsRequest, CallOptions)

public virtual AsyncUnaryCall<ListInsightsResponse> ListInsightsAsync(ListInsightsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListInsightsResponse	The call object.

ListInsightsAsync(ListInsightsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListInsightsResponse> ListInsightsAsync(ListInsightsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListInsightsResponse	The call object.

ListRecommendations(ListRecommendationsRequest, CallOptions)

public virtual ListRecommendationsResponse ListRecommendations(ListRecommendationsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListRecommendationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ListRecommendationsResponse	The response received from the server.

ListRecommendations(ListRecommendationsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRecommendationsResponse ListRecommendations(ListRecommendationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListRecommendationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ListRecommendationsResponse	The response received from the server.

ListRecommendationsAsync(ListRecommendationsRequest, CallOptions)

public virtual AsyncUnaryCall<ListRecommendationsResponse> ListRecommendationsAsync(ListRecommendationsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ListRecommendationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallListRecommendationsResponse	The call object.

ListRecommendationsAsync(ListRecommendationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRecommendationsResponse> ListRecommendationsAsync(ListRecommendationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListRecommendationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallListRecommendationsResponse	The call object.

MarkInsightAccepted(MarkInsightAcceptedRequest, CallOptions)

public virtual Insight MarkInsightAccepted(MarkInsightAcceptedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Insight	The response received from the server.

MarkInsightAccepted(MarkInsightAcceptedRequest, Metadata, DateTime?, CancellationToken)

public virtual Insight MarkInsightAccepted(MarkInsightAcceptedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Insight	The response received from the server.

MarkInsightAcceptedAsync(MarkInsightAcceptedRequest, CallOptions)

public virtual AsyncUnaryCall<Insight> MarkInsightAcceptedAsync(MarkInsightAcceptedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInsight	The call object.

MarkInsightAcceptedAsync(MarkInsightAcceptedRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Insight> MarkInsightAcceptedAsync(MarkInsightAcceptedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInsight	The call object.

MarkRecommendationClaimed(MarkRecommendationClaimedRequest, CallOptions)

public virtual Recommendation MarkRecommendationClaimed(MarkRecommendationClaimedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationClaimed(MarkRecommendationClaimedRequest, Metadata, DateTime?, CancellationToken)

public virtual Recommendation MarkRecommendationClaimed(MarkRecommendationClaimedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest, CallOptions)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

MarkRecommendationDismissed(MarkRecommendationDismissedRequest, CallOptions)

public virtual Recommendation MarkRecommendationDismissed(MarkRecommendationDismissedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationDismissed(MarkRecommendationDismissedRequest, Metadata, DateTime?, CancellationToken)

public virtual Recommendation MarkRecommendationDismissed(MarkRecommendationDismissedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationDismissedAsync(MarkRecommendationDismissedRequest, CallOptions)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationDismissedAsync(MarkRecommendationDismissedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

MarkRecommendationDismissedAsync(MarkRecommendationDismissedRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationDismissedAsync(MarkRecommendationDismissedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

MarkRecommendationFailed(MarkRecommendationFailedRequest, CallOptions)

public virtual Recommendation MarkRecommendationFailed(MarkRecommendationFailedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationFailed(MarkRecommendationFailedRequest, Metadata, DateTime?, CancellationToken)

public virtual Recommendation MarkRecommendationFailed(MarkRecommendationFailedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationFailedAsync(MarkRecommendationFailedRequest, CallOptions)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationFailedAsync(MarkRecommendationFailedRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

MarkRecommendationFailedAsync(MarkRecommendationFailedRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationFailedAsync(MarkRecommendationFailedRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

MarkRecommendationSucceeded(MarkRecommendationSucceededRequest, CallOptions)

public virtual Recommendation MarkRecommendationSucceeded(MarkRecommendationSucceededRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationSucceeded(MarkRecommendationSucceededRequest, Metadata, DateTime?, CancellationToken)

public virtual Recommendation MarkRecommendationSucceeded(MarkRecommendationSucceededRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Recommendation	The response received from the server.

MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest, CallOptions)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Recommendation> MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRecommendation	The call object.

NewInstance(ClientBaseConfiguration)

protected override Recommender.RecommenderClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
RecommenderRecommenderClient

Overrides

ClientBase<Recommender.RecommenderClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateInsightTypeConfig(UpdateInsightTypeConfigRequest, CallOptions)

public virtual InsightTypeConfig UpdateInsightTypeConfig(UpdateInsightTypeConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateInsightTypeConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
InsightTypeConfig	The response received from the server.

UpdateInsightTypeConfig(UpdateInsightTypeConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual InsightTypeConfig UpdateInsightTypeConfig(UpdateInsightTypeConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateInsightTypeConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
InsightTypeConfig	The response received from the server.

UpdateInsightTypeConfigAsync(UpdateInsightTypeConfigRequest, CallOptions)

public virtual AsyncUnaryCall<InsightTypeConfig> UpdateInsightTypeConfigAsync(UpdateInsightTypeConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateInsightTypeConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallInsightTypeConfig	The call object.

UpdateInsightTypeConfigAsync(UpdateInsightTypeConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<InsightTypeConfig> UpdateInsightTypeConfigAsync(UpdateInsightTypeConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateInsightTypeConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallInsightTypeConfig	The call object.

UpdateRecommenderConfig(UpdateRecommenderConfigRequest, CallOptions)

public virtual RecommenderConfig UpdateRecommenderConfig(UpdateRecommenderConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateRecommenderConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
RecommenderConfig	The response received from the server.

UpdateRecommenderConfig(UpdateRecommenderConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual RecommenderConfig UpdateRecommenderConfig(UpdateRecommenderConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateRecommenderConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
RecommenderConfig	The response received from the server.

UpdateRecommenderConfigAsync(UpdateRecommenderConfigRequest, CallOptions)

public virtual AsyncUnaryCall<RecommenderConfig> UpdateRecommenderConfigAsync(UpdateRecommenderConfigRequest request, CallOptions options)

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

Parameters
Name	Description
request	UpdateRecommenderConfigRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallRecommenderConfig	The call object.

UpdateRecommenderConfigAsync(UpdateRecommenderConfigRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RecommenderConfig> UpdateRecommenderConfigAsync(UpdateRecommenderConfigRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	UpdateRecommenderConfigRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallRecommenderConfig	The call object.