Class RecommenderGrpc.RecommenderStub (2.39.0)

public static final class RecommenderGrpc.RecommenderStub extends AbstractAsyncStub<RecommenderGrpc.RecommenderStub>

A stub to allow clients to do asynchronous rpc calls to service Recommender.

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.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > RecommenderGrpc.RecommenderStub

Methods

build(Channel channel, CallOptions callOptions)

protected RecommenderGrpc.RecommenderStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
RecommenderGrpc.RecommenderStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

getInsight(GetInsightRequest request, StreamObserver<Insight> responseObserver)

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

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

Parameters
NameDescription
requestGetInsightRequest
responseObserverio.grpc.stub.StreamObserver<Insight>

getInsightTypeConfig(GetInsightTypeConfigRequest request, StreamObserver<InsightTypeConfig> responseObserver)

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

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

Parameters
NameDescription
requestGetInsightTypeConfigRequest
responseObserverio.grpc.stub.StreamObserver<InsightTypeConfig>

getRecommendation(GetRecommendationRequest request, StreamObserver<Recommendation> responseObserver)

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

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

Parameters
NameDescription
requestGetRecommendationRequest
responseObserverio.grpc.stub.StreamObserver<Recommendation>

getRecommenderConfig(GetRecommenderConfigRequest request, StreamObserver<RecommenderConfig> responseObserver)

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

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

Parameters
NameDescription
requestGetRecommenderConfigRequest
responseObserverio.grpc.stub.StreamObserver<RecommenderConfig>

listInsightTypes(ListInsightTypesRequest request, StreamObserver<ListInsightTypesResponse> responseObserver)

public void listInsightTypes(ListInsightTypesRequest request, StreamObserver<ListInsightTypesResponse> responseObserver)

Lists available InsightTypes. No IAM permissions are required.

Parameters
NameDescription
requestListInsightTypesRequest
responseObserverio.grpc.stub.StreamObserver<ListInsightTypesResponse>

listInsights(ListInsightsRequest request, StreamObserver<ListInsightsResponse> responseObserver)

public 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
NameDescription
requestListInsightsRequest
responseObserverio.grpc.stub.StreamObserver<ListInsightsResponse>

listRecommendations(ListRecommendationsRequest request, StreamObserver<ListRecommendationsResponse> responseObserver)

public 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
NameDescription
requestListRecommendationsRequest
responseObserverio.grpc.stub.StreamObserver<ListRecommendationsResponse>

listRecommenders(ListRecommendersRequest request, StreamObserver<ListRecommendersResponse> responseObserver)

public void listRecommenders(ListRecommendersRequest request, StreamObserver<ListRecommendersResponse> responseObserver)

Lists all available Recommenders. No IAM permissions are required.

Parameters
NameDescription
requestListRecommendersRequest
responseObserverio.grpc.stub.StreamObserver<ListRecommendersResponse>

markInsightAccepted(MarkInsightAcceptedRequest request, StreamObserver<Insight> responseObserver)

public 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
NameDescription
requestMarkInsightAcceptedRequest
responseObserverio.grpc.stub.StreamObserver<Insight>

markRecommendationClaimed(MarkRecommendationClaimedRequest request, StreamObserver<Recommendation> responseObserver)

public 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 or ACTIVE state. Requires the recommender.*.update IAM permission for the specified recommender.

Parameters
NameDescription
requestMarkRecommendationClaimedRequest
responseObserverio.grpc.stub.StreamObserver<Recommendation>

markRecommendationFailed(MarkRecommendationFailedRequest request, StreamObserver<Recommendation> responseObserver)

public 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
NameDescription
requestMarkRecommendationFailedRequest
responseObserverio.grpc.stub.StreamObserver<Recommendation>

markRecommendationSucceeded(MarkRecommendationSucceededRequest request, StreamObserver<Recommendation> responseObserver)

public 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
NameDescription
requestMarkRecommendationSucceededRequest
responseObserverio.grpc.stub.StreamObserver<Recommendation>

updateInsightTypeConfig(UpdateInsightTypeConfigRequest request, StreamObserver<InsightTypeConfig> responseObserver)

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

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

Parameters
NameDescription
requestUpdateInsightTypeConfigRequest
responseObserverio.grpc.stub.StreamObserver<InsightTypeConfig>

updateRecommenderConfig(UpdateRecommenderConfigRequest request, StreamObserver<RecommenderConfig> responseObserver)

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

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

Parameters
NameDescription
requestUpdateRecommenderConfigRequest
responseObserverio.grpc.stub.StreamObserver<RecommenderConfig>