Class protos.google.cloud.recommender.v1.Recommender (7.1.0)

Represents a Recommender

Inheritance

$protobuf.rpc.Service > protos.google.cloud.recommender.v1.Recommender

Package

@google-cloud/recommender

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Recommender service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Recommender;

Creates new Recommender service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
Recommender

RPC service. Useful where requests and/or responses are streamed.

getInsight(request, callback)

public getInsight(request: google.cloud.recommender.v1.IGetInsightRequest, callback: google.cloud.recommender.v1.Recommender.GetInsightCallback): void;

Calls GetInsight.

Parameters
Name Description
request IGetInsightRequest

GetInsightRequest message or plain object
callback GetInsightCallback

Node-style callback called with the error, if any, and Insight
Returns
Type Description
void

getInsight(request)

public getInsight(request: google.cloud.recommender.v1.IGetInsightRequest): Promise<google.cloud.recommender.v1.Insight>;

Calls GetInsight.

Parameter
Name Description
request IGetInsightRequest

GetInsightRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.Insight>

Promise

getInsightTypeConfig(request, callback)

public getInsightTypeConfig(request: google.cloud.recommender.v1.IGetInsightTypeConfigRequest, callback: google.cloud.recommender.v1.Recommender.GetInsightTypeConfigCallback): void;

Calls GetInsightTypeConfig.

Parameters
Name Description
request IGetInsightTypeConfigRequest

GetInsightTypeConfigRequest message or plain object
callback GetInsightTypeConfigCallback

Node-style callback called with the error, if any, and InsightTypeConfig
Returns
Type Description
void

getInsightTypeConfig(request)

public getInsightTypeConfig(request: google.cloud.recommender.v1.IGetInsightTypeConfigRequest): Promise<google.cloud.recommender.v1.InsightTypeConfig>;

Calls GetInsightTypeConfig.

Parameter
Name Description
request IGetInsightTypeConfigRequest

GetInsightTypeConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.InsightTypeConfig>

Promise

getRecommendation(request, callback)

public getRecommendation(request: google.cloud.recommender.v1.IGetRecommendationRequest, callback: google.cloud.recommender.v1.Recommender.GetRecommendationCallback): void;

Calls GetRecommendation.

Parameters
Name Description
request IGetRecommendationRequest

GetRecommendationRequest message or plain object
callback GetRecommendationCallback

Node-style callback called with the error, if any, and Recommendation
Returns
Type Description
void

getRecommendation(request)

public getRecommendation(request: google.cloud.recommender.v1.IGetRecommendationRequest): Promise<google.cloud.recommender.v1.Recommendation>;

Calls GetRecommendation.

Parameter
Name Description
request IGetRecommendationRequest

GetRecommendationRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.Recommendation>

Promise

getRecommenderConfig(request, callback)

public getRecommenderConfig(request: google.cloud.recommender.v1.IGetRecommenderConfigRequest, callback: google.cloud.recommender.v1.Recommender.GetRecommenderConfigCallback): void;

Calls GetRecommenderConfig.

Parameters
Name Description
request IGetRecommenderConfigRequest

GetRecommenderConfigRequest message or plain object
callback GetRecommenderConfigCallback

Node-style callback called with the error, if any, and RecommenderConfig
Returns
Type Description
void

getRecommenderConfig(request)

public getRecommenderConfig(request: google.cloud.recommender.v1.IGetRecommenderConfigRequest): Promise<google.cloud.recommender.v1.RecommenderConfig>;

Calls GetRecommenderConfig.

Parameter
Name Description
request IGetRecommenderConfigRequest

GetRecommenderConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.RecommenderConfig>

Promise

listInsights(request, callback)

public listInsights(request: google.cloud.recommender.v1.IListInsightsRequest, callback: google.cloud.recommender.v1.Recommender.ListInsightsCallback): void;

Calls ListInsights.

Parameters
Name Description
request IListInsightsRequest

ListInsightsRequest message or plain object
callback ListInsightsCallback

Node-style callback called with the error, if any, and ListInsightsResponse
Returns
Type Description
void

listInsights(request)

public listInsights(request: google.cloud.recommender.v1.IListInsightsRequest): Promise<google.cloud.recommender.v1.ListInsightsResponse>;

Calls ListInsights.

Parameter
Name Description
request IListInsightsRequest

ListInsightsRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.ListInsightsResponse>

Promise

listRecommendations(request, callback)

public listRecommendations(request: google.cloud.recommender.v1.IListRecommendationsRequest, callback: google.cloud.recommender.v1.Recommender.ListRecommendationsCallback): void;

Calls ListRecommendations.

Parameters
Name Description
request IListRecommendationsRequest

ListRecommendationsRequest message or plain object
callback ListRecommendationsCallback

Node-style callback called with the error, if any, and ListRecommendationsResponse
Returns
Type Description
void

listRecommendations(request)

public listRecommendations(request: google.cloud.recommender.v1.IListRecommendationsRequest): Promise<google.cloud.recommender.v1.ListRecommendationsResponse>;

Calls ListRecommendations.

Parameter
Name Description
request IListRecommendationsRequest

ListRecommendationsRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.ListRecommendationsResponse>

Promise

markInsightAccepted(request, callback)

public markInsightAccepted(request: google.cloud.recommender.v1.IMarkInsightAcceptedRequest, callback: google.cloud.recommender.v1.Recommender.MarkInsightAcceptedCallback): void;

Calls MarkInsightAccepted.

Parameters
Name Description
request IMarkInsightAcceptedRequest

MarkInsightAcceptedRequest message or plain object
callback MarkInsightAcceptedCallback

Node-style callback called with the error, if any, and Insight
Returns
Type Description
void

markInsightAccepted(request)

public markInsightAccepted(request: google.cloud.recommender.v1.IMarkInsightAcceptedRequest): Promise<google.cloud.recommender.v1.Insight>;

Calls MarkInsightAccepted.

Parameter
Name Description
request IMarkInsightAcceptedRequest

MarkInsightAcceptedRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.Insight>

Promise

markRecommendationClaimed(request, callback)

public markRecommendationClaimed(request: google.cloud.recommender.v1.IMarkRecommendationClaimedRequest, callback: google.cloud.recommender.v1.Recommender.MarkRecommendationClaimedCallback): void;

Calls MarkRecommendationClaimed.

Parameters
Name Description
request IMarkRecommendationClaimedRequest

MarkRecommendationClaimedRequest message or plain object
callback MarkRecommendationClaimedCallback

Node-style callback called with the error, if any, and Recommendation
Returns
Type Description
void

markRecommendationClaimed(request)

public markRecommendationClaimed(request: google.cloud.recommender.v1.IMarkRecommendationClaimedRequest): Promise<google.cloud.recommender.v1.Recommendation>;

Calls MarkRecommendationClaimed.

Parameter
Name Description
request IMarkRecommendationClaimedRequest

MarkRecommendationClaimedRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.Recommendation>

Promise

markRecommendationDismissed(request, callback)

public markRecommendationDismissed(request: google.cloud.recommender.v1.IMarkRecommendationDismissedRequest, callback: google.cloud.recommender.v1.Recommender.MarkRecommendationDismissedCallback): void;

Calls MarkRecommendationDismissed.

Parameters
Name Description
request IMarkRecommendationDismissedRequest

MarkRecommendationDismissedRequest message or plain object
callback MarkRecommendationDismissedCallback

Node-style callback called with the error, if any, and Recommendation
Returns
Type Description
void

markRecommendationDismissed(request)

public markRecommendationDismissed(request: google.cloud.recommender.v1.IMarkRecommendationDismissedRequest): Promise<google.cloud.recommender.v1.Recommendation>;

Calls MarkRecommendationDismissed.

Parameter
Name Description
request IMarkRecommendationDismissedRequest

MarkRecommendationDismissedRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.Recommendation>

Promise

markRecommendationFailed(request, callback)

public markRecommendationFailed(request: google.cloud.recommender.v1.IMarkRecommendationFailedRequest, callback: google.cloud.recommender.v1.Recommender.MarkRecommendationFailedCallback): void;

Calls MarkRecommendationFailed.

Parameters
Name Description
request IMarkRecommendationFailedRequest

MarkRecommendationFailedRequest message or plain object
callback MarkRecommendationFailedCallback

Node-style callback called with the error, if any, and Recommendation
Returns
Type Description
void

markRecommendationFailed(request)

public markRecommendationFailed(request: google.cloud.recommender.v1.IMarkRecommendationFailedRequest): Promise<google.cloud.recommender.v1.Recommendation>;

Calls MarkRecommendationFailed.

Parameter
Name Description
request IMarkRecommendationFailedRequest

MarkRecommendationFailedRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.Recommendation>

Promise

markRecommendationSucceeded(request, callback)

public markRecommendationSucceeded(request: google.cloud.recommender.v1.IMarkRecommendationSucceededRequest, callback: google.cloud.recommender.v1.Recommender.MarkRecommendationSucceededCallback): void;

Calls MarkRecommendationSucceeded.

Parameters
Name Description
request IMarkRecommendationSucceededRequest

MarkRecommendationSucceededRequest message or plain object
callback MarkRecommendationSucceededCallback

Node-style callback called with the error, if any, and Recommendation
Returns
Type Description
void

markRecommendationSucceeded(request)

public markRecommendationSucceeded(request: google.cloud.recommender.v1.IMarkRecommendationSucceededRequest): Promise<google.cloud.recommender.v1.Recommendation>;

Calls MarkRecommendationSucceeded.

Parameter
Name Description
request IMarkRecommendationSucceededRequest

MarkRecommendationSucceededRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.Recommendation>

Promise

updateInsightTypeConfig(request, callback)

public updateInsightTypeConfig(request: google.cloud.recommender.v1.IUpdateInsightTypeConfigRequest, callback: google.cloud.recommender.v1.Recommender.UpdateInsightTypeConfigCallback): void;

Calls UpdateInsightTypeConfig.

Parameters
Name Description
request IUpdateInsightTypeConfigRequest

UpdateInsightTypeConfigRequest message or plain object
callback UpdateInsightTypeConfigCallback

Node-style callback called with the error, if any, and InsightTypeConfig
Returns
Type Description
void

updateInsightTypeConfig(request)

public updateInsightTypeConfig(request: google.cloud.recommender.v1.IUpdateInsightTypeConfigRequest): Promise<google.cloud.recommender.v1.InsightTypeConfig>;

Calls UpdateInsightTypeConfig.

Parameter
Name Description
request IUpdateInsightTypeConfigRequest

UpdateInsightTypeConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.InsightTypeConfig>

Promise

updateRecommenderConfig(request, callback)

public updateRecommenderConfig(request: google.cloud.recommender.v1.IUpdateRecommenderConfigRequest, callback: google.cloud.recommender.v1.Recommender.UpdateRecommenderConfigCallback): void;

Calls UpdateRecommenderConfig.

Parameters
Name Description
request IUpdateRecommenderConfigRequest

UpdateRecommenderConfigRequest message or plain object
callback UpdateRecommenderConfigCallback

Node-style callback called with the error, if any, and RecommenderConfig
Returns
Type Description
void

updateRecommenderConfig(request)

public updateRecommenderConfig(request: google.cloud.recommender.v1.IUpdateRecommenderConfigRequest): Promise<google.cloud.recommender.v1.RecommenderConfig>;

Calls UpdateRecommenderConfig.

Parameter
Name Description
request IUpdateRecommenderConfigRequest

UpdateRecommenderConfigRequest message or plain object
Returns
Type Description
Promise<google.cloud.recommender.v1.RecommenderConfig>

Promise