Class RecommenderClientImpl (2.5.0)

public sealed class RecommenderClientImpl : RecommenderClient

Recommender client wrapper implementation, for convenient use.

Inheritance

Object > RecommenderClient > RecommenderClientImpl

Inherited Members

RecommenderClient.DefaultEndpoint

RecommenderClient.DefaultScopes

RecommenderClient.CreateAsync(CancellationToken)

RecommenderClient.Create()

RecommenderClient.ShutdownDefaultChannelsAsync()

RecommenderClient.ListInsights(String, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListInsightsAsync(String, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListInsights(InsightTypeName, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListInsightsAsync(InsightTypeName, String, Nullable<Int32>, CallSettings)

RecommenderClient.GetInsightAsync(GetInsightRequest, CancellationToken)

RecommenderClient.GetInsight(String, CallSettings)

RecommenderClient.GetInsightAsync(String, CallSettings)

RecommenderClient.GetInsightAsync(String, CancellationToken)

RecommenderClient.GetInsight(InsightName, CallSettings)

RecommenderClient.GetInsightAsync(InsightName, CallSettings)

RecommenderClient.GetInsightAsync(InsightName, CancellationToken)

RecommenderClient.MarkInsightAcceptedAsync(MarkInsightAcceptedRequest, CancellationToken)

RecommenderClient.MarkInsightAccepted(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkInsightAcceptedAsync(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkInsightAcceptedAsync(String, IDictionary<String, String>, String, CancellationToken)

RecommenderClient.MarkInsightAccepted(InsightName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkInsightAcceptedAsync(InsightName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkInsightAcceptedAsync(InsightName, IDictionary<String, String>, String, CancellationToken)

RecommenderClient.ListRecommendations(String, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListRecommendationsAsync(String, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListRecommendations(RecommenderName, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListRecommendationsAsync(RecommenderName, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListRecommendations(String, String, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListRecommendationsAsync(String, String, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListRecommendations(RecommenderName, String, String, Nullable<Int32>, CallSettings)

RecommenderClient.ListRecommendationsAsync(RecommenderName, String, String, Nullable<Int32>, CallSettings)

RecommenderClient.GetRecommendationAsync(GetRecommendationRequest, CancellationToken)

RecommenderClient.GetRecommendation(String, CallSettings)

RecommenderClient.GetRecommendationAsync(String, CallSettings)

RecommenderClient.GetRecommendationAsync(String, CancellationToken)

RecommenderClient.GetRecommendation(RecommendationName, CallSettings)

RecommenderClient.GetRecommendationAsync(RecommendationName, CallSettings)

RecommenderClient.GetRecommendationAsync(RecommendationName, CancellationToken)

RecommenderClient.MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest, CancellationToken)

RecommenderClient.MarkRecommendationClaimed(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationClaimedAsync(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationClaimedAsync(String, IDictionary<String, String>, String, CancellationToken)

RecommenderClient.MarkRecommendationClaimed(RecommendationName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationClaimedAsync(RecommendationName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationClaimedAsync(RecommendationName, IDictionary<String, String>, String, CancellationToken)

RecommenderClient.MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest, CancellationToken)

RecommenderClient.MarkRecommendationSucceeded(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationSucceededAsync(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationSucceededAsync(String, IDictionary<String, String>, String, CancellationToken)

RecommenderClient.MarkRecommendationSucceeded(RecommendationName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationSucceededAsync(RecommendationName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationSucceededAsync(RecommendationName, IDictionary<String, String>, String, CancellationToken)

RecommenderClient.MarkRecommendationFailedAsync(MarkRecommendationFailedRequest, CancellationToken)

RecommenderClient.MarkRecommendationFailed(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationFailedAsync(String, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationFailedAsync(String, IDictionary<String, String>, String, CancellationToken)

RecommenderClient.MarkRecommendationFailed(RecommendationName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationFailedAsync(RecommendationName, IDictionary<String, String>, String, CallSettings)

RecommenderClient.MarkRecommendationFailedAsync(RecommendationName, IDictionary<String, String>, String, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Recommender.V1

Assembly

Google.Cloud.Recommender.V1.dll

Remarks

Provides insights and recommendations for cloud customers for various categories like performance optimization, cost savings, reliability, feature discovery, etc. Insights and recommendations are generated automatically based on analysis of user resources, configuration and monitoring metrics.

Constructors

RecommenderClientImpl(Recommender.RecommenderClient, RecommenderSettings)

public RecommenderClientImpl(Recommender.RecommenderClient grpcClient, RecommenderSettings settings)

Constructs a client wrapper for the Recommender service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`Recommender.RecommenderClient` The underlying gRPC client.
`settings`	`RecommenderSettings` The base RecommenderSettings used within this client.

Properties

GrpcClient

public override Recommender.RecommenderClient GrpcClient { get; }

The underlying gRPC Recommender client

Property Value
Type	Description
`Recommender.RecommenderClient`

Overrides

RecommenderClient.GrpcClient

Methods

GetInsight(GetInsightRequest, CallSettings)

public override Insight GetInsight(GetInsightRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetInsightRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Insight`	The RPC response.

Overrides

RecommenderClient.GetInsight(GetInsightRequest, CallSettings)

GetInsightAsync(GetInsightRequest, CallSettings)

public override Task<Insight> GetInsightAsync(GetInsightRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetInsightRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Insight>`	A Task containing the RPC response.

Overrides

RecommenderClient.GetInsightAsync(GetInsightRequest, CallSettings)

GetRecommendation(GetRecommendationRequest, CallSettings)

public override Recommendation GetRecommendation(GetRecommendationRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetRecommendationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Recommendation`	The RPC response.

Overrides

RecommenderClient.GetRecommendation(GetRecommendationRequest, CallSettings)

GetRecommendationAsync(GetRecommendationRequest, CallSettings)

public override Task<Recommendation> GetRecommendationAsync(GetRecommendationRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`GetRecommendationRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Recommendation>`	A Task containing the RPC response.

Overrides

RecommenderClient.GetRecommendationAsync(GetRecommendationRequest, CallSettings)

ListInsights(ListInsightsRequest, CallSettings)

public override PagedEnumerable<ListInsightsResponse, Insight> ListInsights(ListInsightsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListInsightsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListInsightsResponse, Insight>`	A pageable sequence of Insight resources.

Overrides

RecommenderClient.ListInsights(ListInsightsRequest, CallSettings)

ListInsightsAsync(ListInsightsRequest, CallSettings)

public override PagedAsyncEnumerable<ListInsightsResponse, Insight> ListInsightsAsync(ListInsightsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListInsightsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListInsightsResponse, Insight>`	A pageable asynchronous sequence of Insight resources.

Overrides

RecommenderClient.ListInsightsAsync(ListInsightsRequest, CallSettings)

ListRecommendations(ListRecommendationsRequest, CallSettings)

public override PagedEnumerable<ListRecommendationsResponse, Recommendation> ListRecommendations(ListRecommendationsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListRecommendationsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListRecommendationsResponse, Recommendation>`	A pageable sequence of Recommendation resources.

Overrides

RecommenderClient.ListRecommendations(ListRecommendationsRequest, CallSettings)

ListRecommendationsAsync(ListRecommendationsRequest, CallSettings)

public override PagedAsyncEnumerable<ListRecommendationsResponse, Recommendation> ListRecommendationsAsync(ListRecommendationsRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`ListRecommendationsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListRecommendationsResponse, Recommendation>`	A pageable asynchronous sequence of Recommendation resources.

Overrides

RecommenderClient.ListRecommendationsAsync(ListRecommendationsRequest, CallSettings)

MarkInsightAccepted(MarkInsightAcceptedRequest, CallSettings)

public override Insight MarkInsightAccepted(MarkInsightAcceptedRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Insight`	The RPC response.

Overrides

RecommenderClient.MarkInsightAccepted(MarkInsightAcceptedRequest, CallSettings)

MarkInsightAcceptedAsync(MarkInsightAcceptedRequest, CallSettings)

public override Task<Insight> MarkInsightAcceptedAsync(MarkInsightAcceptedRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Insight>`	A Task containing the RPC response.

Overrides

RecommenderClient.MarkInsightAcceptedAsync(MarkInsightAcceptedRequest, CallSettings)

MarkRecommendationClaimed(MarkRecommendationClaimedRequest, CallSettings)

public override Recommendation MarkRecommendationClaimed(MarkRecommendationClaimedRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Recommendation`	The RPC response.

Overrides

RecommenderClient.MarkRecommendationClaimed(MarkRecommendationClaimedRequest, CallSettings)

MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest, CallSettings)

public override Task<Recommendation> MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Recommendation>`	A Task containing the RPC response.

Overrides

RecommenderClient.MarkRecommendationClaimedAsync(MarkRecommendationClaimedRequest, CallSettings)

MarkRecommendationFailed(MarkRecommendationFailedRequest, CallSettings)

public override Recommendation MarkRecommendationFailed(MarkRecommendationFailedRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Recommendation`	The RPC response.

Overrides

RecommenderClient.MarkRecommendationFailed(MarkRecommendationFailedRequest, CallSettings)

MarkRecommendationFailedAsync(MarkRecommendationFailedRequest, CallSettings)

public override Task<Recommendation> MarkRecommendationFailedAsync(MarkRecommendationFailedRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Recommendation>`	A Task containing the RPC response.

Overrides

RecommenderClient.MarkRecommendationFailedAsync(MarkRecommendationFailedRequest, CallSettings)

MarkRecommendationSucceeded(MarkRecommendationSucceededRequest, CallSettings)

public override Recommendation MarkRecommendationSucceeded(MarkRecommendationSucceededRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Recommendation`	The RPC response.

Overrides

RecommenderClient.MarkRecommendationSucceeded(MarkRecommendationSucceededRequest, CallSettings)

MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest, CallSettings)

public override Task<Recommendation> MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Recommendation>`	A Task containing the RPC response.

Overrides

RecommenderClient.MarkRecommendationSucceededAsync(MarkRecommendationSucceededRequest, CallSettings)