Class RecommenderGrpc.RecommenderFutureStub (2.48.0)

public static final class RecommenderGrpc.RecommenderFutureStub extends AbstractFutureStub<RecommenderGrpc.RecommenderFutureStub>

A stub to allow clients to do ListenableFuture-style 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.AbstractFutureStub > RecommenderGrpc.RecommenderFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected RecommenderGrpc.RecommenderFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
RecommenderGrpc.RecommenderFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

getInsight(GetInsightRequest request)

public ListenableFuture<Insight> getInsight(GetInsightRequest request)

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

Parameter
Name Description
request GetInsightRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Insight>

getInsightTypeConfig(GetInsightTypeConfigRequest request)

public ListenableFuture<InsightTypeConfig> getInsightTypeConfig(GetInsightTypeConfigRequest request)

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

Parameter
Name Description
request GetInsightTypeConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<InsightTypeConfig>

getRecommendation(GetRecommendationRequest request)

public ListenableFuture<Recommendation> getRecommendation(GetRecommendationRequest request)

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

Parameter
Name Description
request GetRecommendationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Recommendation>

getRecommenderConfig(GetRecommenderConfigRequest request)

public ListenableFuture<RecommenderConfig> getRecommenderConfig(GetRecommenderConfigRequest request)

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

Parameter
Name Description
request GetRecommenderConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<RecommenderConfig>

listInsightTypes(ListInsightTypesRequest request)

public ListenableFuture<ListInsightTypesResponse> listInsightTypes(ListInsightTypesRequest request)

Lists available InsightTypes. No IAM permissions are required.

Parameter
Name Description
request ListInsightTypesRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListInsightTypesResponse>

listInsights(ListInsightsRequest request)

public ListenableFuture<ListInsightsResponse> listInsights(ListInsightsRequest request)

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

Parameter
Name Description
request ListInsightsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListInsightsResponse>

listRecommendations(ListRecommendationsRequest request)

public ListenableFuture<ListRecommendationsResponse> listRecommendations(ListRecommendationsRequest request)

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

Parameter
Name Description
request ListRecommendationsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListRecommendationsResponse>

listRecommenders(ListRecommendersRequest request)

public ListenableFuture<ListRecommendersResponse> listRecommenders(ListRecommendersRequest request)

Lists all available Recommenders. No IAM permissions are required.

Parameter
Name Description
request ListRecommendersRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListRecommendersResponse>

markInsightAccepted(MarkInsightAcceptedRequest request)

public ListenableFuture<Insight> markInsightAccepted(MarkInsightAcceptedRequest request)

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.

Parameter
Name Description
request MarkInsightAcceptedRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Insight>

markRecommendationClaimed(MarkRecommendationClaimedRequest request)

public ListenableFuture<Recommendation> markRecommendationClaimed(MarkRecommendationClaimedRequest request)

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.

Parameter
Name Description
request MarkRecommendationClaimedRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Recommendation>

markRecommendationFailed(MarkRecommendationFailedRequest request)

public ListenableFuture<Recommendation> markRecommendationFailed(MarkRecommendationFailedRequest request)

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.

Parameter
Name Description
request MarkRecommendationFailedRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Recommendation>

markRecommendationSucceeded(MarkRecommendationSucceededRequest request)

public ListenableFuture<Recommendation> markRecommendationSucceeded(MarkRecommendationSucceededRequest request)

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.

Parameter
Name Description
request MarkRecommendationSucceededRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Recommendation>

updateInsightTypeConfig(UpdateInsightTypeConfigRequest request)

public ListenableFuture<InsightTypeConfig> updateInsightTypeConfig(UpdateInsightTypeConfigRequest request)

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

Parameter
Name Description
request UpdateInsightTypeConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<InsightTypeConfig>

updateRecommenderConfig(UpdateRecommenderConfigRequest request)

public ListenableFuture<RecommenderConfig> updateRecommenderConfig(UpdateRecommenderConfigRequest request)

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

Parameter
Name Description
request UpdateRecommenderConfigRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<RecommenderConfig>