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

Represents a Recommender

Inheritance

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

Package

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	`google.cloud.recommender.v1.IGetInsightRequest` GetInsightRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.IGetInsightRequest` GetInsightRequest message or plain object

Returns

Type	Description
Promise<google.cloud.recommender.v1.Insight>	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	`google.cloud.recommender.v1.IGetRecommendationRequest` GetRecommendationRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.IGetRecommendationRequest` GetRecommendationRequest message or plain object

Returns

Type	Description
Promise<google.cloud.recommender.v1.Recommendation>	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	`google.cloud.recommender.v1.IListInsightsRequest` ListInsightsRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.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	`google.cloud.recommender.v1.IListRecommendationsRequest` ListRecommendationsRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.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	`google.cloud.recommender.v1.IMarkInsightAcceptedRequest` MarkInsightAcceptedRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.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	`google.cloud.recommender.v1.IMarkRecommendationClaimedRequest` MarkRecommendationClaimedRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.IMarkRecommendationClaimedRequest` MarkRecommendationClaimedRequest 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	`google.cloud.recommender.v1.IMarkRecommendationFailedRequest` MarkRecommendationFailedRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.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	`google.cloud.recommender.v1.IMarkRecommendationSucceededRequest` MarkRecommendationSucceededRequest message or plain object
callback	`google.cloud.recommender.v1.Recommender.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	`google.cloud.recommender.v1.IMarkRecommendationSucceededRequest` MarkRecommendationSucceededRequest message or plain object

Returns

Type	Description
Promise<google.cloud.recommender.v1.Recommendation>	Promise