com.google.cloud.recommender.v1beta1

Class RecommenderGrpc.RecommenderFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<RecommenderGrpc.RecommenderFutureStub>

com.google.cloud.recommender.v1beta1.RecommenderGrpc.RecommenderFutureStub

Enclosing class:

RecommenderGrpc

public static final class RecommenderGrpc.RecommenderFutureStub
extends io.grpc.stub.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.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected RecommenderGrpc.RecommenderFutureStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
com.google.common.util.concurrent.ListenableFuture<Insight>	getInsight(GetInsightRequest request) Gets the requested insight.
com.google.common.util.concurrent.ListenableFuture<InsightTypeConfig>	getInsightTypeConfig(GetInsightTypeConfigRequest request) Gets the requested InsightTypeConfig.
com.google.common.util.concurrent.ListenableFuture<Recommendation>	getRecommendation(GetRecommendationRequest request) Gets the requested recommendation.
com.google.common.util.concurrent.ListenableFuture<RecommenderConfig>	getRecommenderConfig(GetRecommenderConfigRequest request) Gets the requested Recommender Config.
com.google.common.util.concurrent.ListenableFuture<ListInsightsResponse>	listInsights(ListInsightsRequest request) Lists insights for the specified Cloud Resource.
com.google.common.util.concurrent.ListenableFuture<ListInsightTypesResponse>	listInsightTypes(ListInsightTypesRequest request) Lists available InsightTypes.
com.google.common.util.concurrent.ListenableFuture<ListRecommendationsResponse>	listRecommendations(ListRecommendationsRequest request) Lists recommendations for the specified Cloud Resource.
com.google.common.util.concurrent.ListenableFuture<ListRecommendersResponse>	listRecommenders(ListRecommendersRequest request) Lists all available Recommenders.
com.google.common.util.concurrent.ListenableFuture<Insight>	markInsightAccepted(MarkInsightAcceptedRequest request) Marks the Insight State as Accepted.
com.google.common.util.concurrent.ListenableFuture<Recommendation>	markRecommendationClaimed(MarkRecommendationClaimedRequest request) Marks the Recommendation State as Claimed.
com.google.common.util.concurrent.ListenableFuture<Recommendation>	markRecommendationFailed(MarkRecommendationFailedRequest request) Marks the Recommendation State as Failed.
com.google.common.util.concurrent.ListenableFuture<Recommendation>	markRecommendationSucceeded(MarkRecommendationSucceededRequest request) Marks the Recommendation State as Succeeded.
com.google.common.util.concurrent.ListenableFuture<InsightTypeConfig>	updateInsightTypeConfig(UpdateInsightTypeConfigRequest request) Updates an InsightTypeConfig change.
com.google.common.util.concurrent.ListenableFuture<RecommenderConfig>	updateRecommenderConfig(UpdateRecommenderConfigRequest request) Updates a Recommender Config.

Methods inherited from class io.grpc.stub.AbstractFutureStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected RecommenderGrpc.RecommenderFutureStub build(io.grpc.Channel channel,
                                                      io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<RecommenderGrpc.RecommenderFutureStub>

listInsights

public com.google.common.util.concurrent.ListenableFuture<ListInsightsResponse> listInsights(ListInsightsRequest request)

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

getInsight

public com.google.common.util.concurrent.ListenableFuture<Insight> getInsight(GetInsightRequest request)

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

markInsightAccepted

public com.google.common.util.concurrent.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.
 

listRecommendations

public com.google.common.util.concurrent.ListenableFuture<ListRecommendationsResponse> listRecommendations(ListRecommendationsRequest request)

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

getRecommendation

public com.google.common.util.concurrent.ListenableFuture<Recommendation> getRecommendation(GetRecommendationRequest request)

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

markRecommendationClaimed

public com.google.common.util.concurrent.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.
 

markRecommendationSucceeded

public com.google.common.util.concurrent.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.
 

markRecommendationFailed

public com.google.common.util.concurrent.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.
 

getRecommenderConfig

public com.google.common.util.concurrent.ListenableFuture<RecommenderConfig> getRecommenderConfig(GetRecommenderConfigRequest request)

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

updateRecommenderConfig

public com.google.common.util.concurrent.ListenableFuture<RecommenderConfig> updateRecommenderConfig(UpdateRecommenderConfigRequest request)

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

getInsightTypeConfig

public com.google.common.util.concurrent.ListenableFuture<InsightTypeConfig> getInsightTypeConfig(GetInsightTypeConfigRequest request)

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

updateInsightTypeConfig

public com.google.common.util.concurrent.ListenableFuture<InsightTypeConfig> updateInsightTypeConfig(UpdateInsightTypeConfigRequest request)

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

listRecommenders

public com.google.common.util.concurrent.ListenableFuture<ListRecommendersResponse> listRecommenders(ListRecommendersRequest request)

 Lists all available Recommenders.
 No IAM permissions are required.
 

listInsightTypes

public com.google.common.util.concurrent.ListenableFuture<ListInsightTypesResponse> listInsightTypes(ListInsightTypesRequest request)

 Lists available InsightTypes.
 No IAM permissions are required.