Class Recommender.RecommenderClient (2.7.0) 

public class RecommenderClient : ClientBase<Recommender.RecommenderClient>

Client for Recommender

Inheritance

Object > ClientBase > ClientBase<Recommender.RecommenderClient> > Recommender.RecommenderClient

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(Channel)

[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public RecommenderClient(Channel channel)

Creates a new client using a channel.

Parameter
Name Description
channel Grpc.Core.Channel

The channel 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(ClientBase.ClientBaseConfiguration)

protected RecommenderClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Insight>

The call object.

GetInsightAsync(GetInsightRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Insight>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

The call object.

GetRecommendationAsync(GetRecommendationRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

The call object.

ListInsights(ListInsightsRequest, CallOptions)

public virtual ListInsightsResponse ListInsights(ListInsightsRequest request, CallOptions options)

Lists insights for a Cloud project. 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, Nullable<DateTime>, CancellationToken)

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

Lists insights for a Cloud project. 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 Nullable<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 a Cloud project. 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
AsyncUnaryCall<ListInsightsResponse>

The call object.

ListInsightsAsync(ListInsightsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists insights for a Cloud project. 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 Nullable<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
AsyncUnaryCall<ListInsightsResponse>

The call object.

ListRecommendations(ListRecommendationsRequest, CallOptions)

public virtual ListRecommendationsResponse ListRecommendations(ListRecommendationsRequest request, CallOptions options)

Lists recommendations for a Cloud project. 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, Nullable<DateTime>, CancellationToken)

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

Lists recommendations for a Cloud project. 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 Nullable<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 a Cloud project. 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
AsyncUnaryCall<ListRecommendationsResponse>

The call object.

ListRecommendationsAsync(ListRecommendationsRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

Lists recommendations for a Cloud project. 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 Nullable<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
AsyncUnaryCall<ListRecommendationsResponse>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Insight>

The call object.

MarkInsightAcceptedAsync(MarkInsightAcceptedRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Insight>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

The call object.

MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

The call object.

MarkRecommendationFailedAsync(MarkRecommendationFailedRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

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, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

The call object.

MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest, Metadata, Nullable<DateTime>, CancellationToken)

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

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 Nullable<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
AsyncUnaryCall<Recommendation>

The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBase.ClientBaseConfiguration
Returns
Type Description
Recommender.RecommenderClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Recommender.V1.Recommender.RecommenderClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)