Interface RecommenderGrpc.AsyncService (2.37.0)

Version 2.37.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.7
• 2.4.1
• 2.3.0
• 2.2.0
• 2.1.5

public static interface RecommenderGrpc.AsyncService

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.

Methods

getInsight(GetInsightRequest request, StreamObserver<Insight> responseObserver)

public default void getInsight(GetInsightRequest request, StreamObserver<Insight> responseObserver)

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

Parameters
Name	Description
request	GetInsightRequest
responseObserver	io.grpc.stub.StreamObserver<Insight>

getInsightTypeConfig(GetInsightTypeConfigRequest request, StreamObserver<InsightTypeConfig> responseObserver)

public default void getInsightTypeConfig(GetInsightTypeConfigRequest request, StreamObserver<InsightTypeConfig> responseObserver)

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

Parameters
Name	Description
request	GetInsightTypeConfigRequest
responseObserver	io.grpc.stub.StreamObserver<InsightTypeConfig>

getRecommendation(GetRecommendationRequest request, StreamObserver<Recommendation> responseObserver)

public default void getRecommendation(GetRecommendationRequest request, StreamObserver<Recommendation> responseObserver)

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

Parameters
Name	Description
request	GetRecommendationRequest
responseObserver	io.grpc.stub.StreamObserver<Recommendation>

getRecommenderConfig(GetRecommenderConfigRequest request, StreamObserver<RecommenderConfig> responseObserver)

public default void getRecommenderConfig(GetRecommenderConfigRequest request, StreamObserver<RecommenderConfig> responseObserver)

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

Parameters
Name	Description
request	GetRecommenderConfigRequest
responseObserver	io.grpc.stub.StreamObserver<RecommenderConfig>

listInsights(ListInsightsRequest request, StreamObserver<ListInsightsResponse> responseObserver)

public default void listInsights(ListInsightsRequest request, StreamObserver<ListInsightsResponse> responseObserver)

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

Parameters
Name	Description
request	ListInsightsRequest
responseObserver	io.grpc.stub.StreamObserver<ListInsightsResponse>

listRecommendations(ListRecommendationsRequest request, StreamObserver<ListRecommendationsResponse> responseObserver)

public default void listRecommendations(ListRecommendationsRequest request, StreamObserver<ListRecommendationsResponse> responseObserver)

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

Parameters
Name	Description
request	ListRecommendationsRequest
responseObserver	io.grpc.stub.StreamObserver<ListRecommendationsResponse>

markInsightAccepted(MarkInsightAcceptedRequest request, StreamObserver<Insight> responseObserver)

public default void markInsightAccepted(MarkInsightAcceptedRequest request, StreamObserver<Insight> responseObserver)

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
responseObserver	io.grpc.stub.StreamObserver<Insight>

markRecommendationClaimed(MarkRecommendationClaimedRequest request, StreamObserver<Recommendation> responseObserver)

public default void markRecommendationClaimed(MarkRecommendationClaimedRequest request, StreamObserver<Recommendation> responseObserver)

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
responseObserver	io.grpc.stub.StreamObserver<Recommendation>

markRecommendationDismissed(MarkRecommendationDismissedRequest request, StreamObserver<Recommendation> responseObserver)

public default void markRecommendationDismissed(MarkRecommendationDismissedRequest request, StreamObserver<Recommendation> responseObserver)

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
responseObserver	io.grpc.stub.StreamObserver<Recommendation>

markRecommendationFailed(MarkRecommendationFailedRequest request, StreamObserver<Recommendation> responseObserver)

public default void markRecommendationFailed(MarkRecommendationFailedRequest request, StreamObserver<Recommendation> responseObserver)

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
responseObserver	io.grpc.stub.StreamObserver<Recommendation>

markRecommendationSucceeded(MarkRecommendationSucceededRequest request, StreamObserver<Recommendation> responseObserver)

public default void markRecommendationSucceeded(MarkRecommendationSucceededRequest request, StreamObserver<Recommendation> responseObserver)

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
responseObserver	io.grpc.stub.StreamObserver<Recommendation>

updateInsightTypeConfig(UpdateInsightTypeConfigRequest request, StreamObserver<InsightTypeConfig> responseObserver)

public default void updateInsightTypeConfig(UpdateInsightTypeConfigRequest request, StreamObserver<InsightTypeConfig> responseObserver)

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

Parameters
Name	Description
request	UpdateInsightTypeConfigRequest
responseObserver	io.grpc.stub.StreamObserver<InsightTypeConfig>

updateRecommenderConfig(UpdateRecommenderConfigRequest request, StreamObserver<RecommenderConfig> responseObserver)

public default void updateRecommenderConfig(UpdateRecommenderConfigRequest request, StreamObserver<RecommenderConfig> responseObserver)

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

Parameters
Name	Description
request	UpdateRecommenderConfigRequest
responseObserver	io.grpc.stub.StreamObserver<RecommenderConfig>