Constructor
new Recommender(rpcImpl, requestDelimitedopt, responseDelimitedopt)
Constructs a new Recommender service.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Extends
- $protobuf.rpc.Service
Methods
getInsight(request, callback) → {undefined}
Calls GetInsight.
Parameters:
Name | Type | 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 |
---|---|
undefined |
getInsight(request) → {Promise.<google.cloud.recommender.v1.Insight>}
Calls GetInsight.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IGetInsightRequest |
GetInsightRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.Insight> |
Promise |
getInsightTypeConfig(request, callback) → {undefined}
Calls GetInsightTypeConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IGetInsightTypeConfigRequest |
GetInsightTypeConfigRequest message or plain object |
callback |
google.cloud.recommender.v1.Recommender.GetInsightTypeConfigCallback |
Node-style callback called with the error, if any, and InsightTypeConfig |
Returns:
Type | Description |
---|---|
undefined |
getInsightTypeConfig(request) → {Promise.<google.cloud.recommender.v1.InsightTypeConfig>}
Calls GetInsightTypeConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IGetInsightTypeConfigRequest |
GetInsightTypeConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.InsightTypeConfig> |
Promise |
getRecommendation(request, callback) → {undefined}
Calls GetRecommendation.
Parameters:
Name | Type | 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 |
---|---|
undefined |
getRecommendation(request) → {Promise.<google.cloud.recommender.v1.Recommendation>}
Calls GetRecommendation.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IGetRecommendationRequest |
GetRecommendationRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.Recommendation> |
Promise |
getRecommenderConfig(request, callback) → {undefined}
Calls GetRecommenderConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IGetRecommenderConfigRequest |
GetRecommenderConfigRequest message or plain object |
callback |
google.cloud.recommender.v1.Recommender.GetRecommenderConfigCallback |
Node-style callback called with the error, if any, and RecommenderConfig |
Returns:
Type | Description |
---|---|
undefined |
getRecommenderConfig(request) → {Promise.<google.cloud.recommender.v1.RecommenderConfig>}
Calls GetRecommenderConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IGetRecommenderConfigRequest |
GetRecommenderConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.RecommenderConfig> |
Promise |
listInsights(request, callback) → {undefined}
Calls ListInsights.
Parameters:
Name | Type | 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 |
---|---|
undefined |
listInsights(request) → {Promise.<google.cloud.recommender.v1.ListInsightsResponse>}
Calls ListInsights.
Parameters:
Name | Type | 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) → {undefined}
Calls ListRecommendations.
Parameters:
Name | Type | 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 |
---|---|
undefined |
listRecommendations(request) → {Promise.<google.cloud.recommender.v1.ListRecommendationsResponse>}
Calls ListRecommendations.
Parameters:
Name | Type | 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) → {undefined}
Calls MarkInsightAccepted.
Parameters:
Name | Type | 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 |
---|---|
undefined |
markInsightAccepted(request) → {Promise.<google.cloud.recommender.v1.Insight>}
Calls MarkInsightAccepted.
Parameters:
Name | Type | 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) → {undefined}
Calls MarkRecommendationClaimed.
Parameters:
Name | Type | 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 |
---|---|
undefined |
markRecommendationClaimed(request) → {Promise.<google.cloud.recommender.v1.Recommendation>}
Calls MarkRecommendationClaimed.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IMarkRecommendationClaimedRequest |
MarkRecommendationClaimedRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.Recommendation> |
Promise |
markRecommendationDismissed(request, callback) → {undefined}
Calls MarkRecommendationDismissed.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IMarkRecommendationDismissedRequest |
MarkRecommendationDismissedRequest message or plain object |
callback |
google.cloud.recommender.v1.Recommender.MarkRecommendationDismissedCallback |
Node-style callback called with the error, if any, and Recommendation |
Returns:
Type | Description |
---|---|
undefined |
markRecommendationDismissed(request) → {Promise.<google.cloud.recommender.v1.Recommendation>}
Calls MarkRecommendationDismissed.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IMarkRecommendationDismissedRequest |
MarkRecommendationDismissedRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.Recommendation> |
Promise |
markRecommendationFailed(request, callback) → {undefined}
Calls MarkRecommendationFailed.
Parameters:
Name | Type | 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 |
---|---|
undefined |
markRecommendationFailed(request) → {Promise.<google.cloud.recommender.v1.Recommendation>}
Calls MarkRecommendationFailed.
Parameters:
Name | Type | 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) → {undefined}
Calls MarkRecommendationSucceeded.
Parameters:
Name | Type | 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 |
---|---|
undefined |
markRecommendationSucceeded(request) → {Promise.<google.cloud.recommender.v1.Recommendation>}
Calls MarkRecommendationSucceeded.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IMarkRecommendationSucceededRequest |
MarkRecommendationSucceededRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.Recommendation> |
Promise |
updateInsightTypeConfig(request, callback) → {undefined}
Calls UpdateInsightTypeConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IUpdateInsightTypeConfigRequest |
UpdateInsightTypeConfigRequest message or plain object |
callback |
google.cloud.recommender.v1.Recommender.UpdateInsightTypeConfigCallback |
Node-style callback called with the error, if any, and InsightTypeConfig |
Returns:
Type | Description |
---|---|
undefined |
updateInsightTypeConfig(request) → {Promise.<google.cloud.recommender.v1.InsightTypeConfig>}
Calls UpdateInsightTypeConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IUpdateInsightTypeConfigRequest |
UpdateInsightTypeConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.InsightTypeConfig> |
Promise |
updateRecommenderConfig(request, callback) → {undefined}
Calls UpdateRecommenderConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IUpdateRecommenderConfigRequest |
UpdateRecommenderConfigRequest message or plain object |
callback |
google.cloud.recommender.v1.Recommender.UpdateRecommenderConfigCallback |
Node-style callback called with the error, if any, and RecommenderConfig |
Returns:
Type | Description |
---|---|
undefined |
updateRecommenderConfig(request) → {Promise.<google.cloud.recommender.v1.RecommenderConfig>}
Calls UpdateRecommenderConfig.
Parameters:
Name | Type | Description |
---|---|---|
request |
google.cloud.recommender.v1.IUpdateRecommenderConfigRequest |
UpdateRecommenderConfigRequest message or plain object |
Returns:
Type | Description |
---|---|
Promise.<google.cloud.recommender.v1.RecommenderConfig> |
Promise |
(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Recommender}
Creates new Recommender service using the specified rpc implementation.
Parameters:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
rpcImpl |
$protobuf.RPCImpl |
RPC implementation |
||
requestDelimited |
boolean |
<optional> |
false |
Whether requests are length-delimited |
responseDelimited |
boolean |
<optional> |
false |
Whether responses are length-delimited |
Returns:
Type | Description |
---|---|
Recommender |
RPC service. Useful where requests and/or responses are streamed. |
Type Definitions
GetInsightCallback(error, responseopt)
Callback as used by getInsight.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.Insight |
<optional> |
Insight |
GetInsightTypeConfigCallback(error, responseopt)
Callback as used by getInsightTypeConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.InsightTypeConfig |
<optional> |
InsightTypeConfig |
GetRecommendationCallback(error, responseopt)
Callback as used by getRecommendation.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.Recommendation |
<optional> |
Recommendation |
GetRecommenderConfigCallback(error, responseopt)
Callback as used by getRecommenderConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.RecommenderConfig |
<optional> |
RecommenderConfig |
ListInsightsCallback(error, responseopt)
Callback as used by listInsights.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.ListInsightsResponse |
<optional> |
ListInsightsResponse |
ListRecommendationsCallback(error, responseopt)
Callback as used by listRecommendations.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.ListRecommendationsResponse |
<optional> |
ListRecommendationsResponse |
MarkInsightAcceptedCallback(error, responseopt)
Callback as used by markInsightAccepted.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.Insight |
<optional> |
Insight |
MarkRecommendationClaimedCallback(error, responseopt)
Callback as used by markRecommendationClaimed.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.Recommendation |
<optional> |
Recommendation |
MarkRecommendationDismissedCallback(error, responseopt)
Callback as used by markRecommendationDismissed.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.Recommendation |
<optional> |
Recommendation |
MarkRecommendationFailedCallback(error, responseopt)
Callback as used by markRecommendationFailed.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.Recommendation |
<optional> |
Recommendation |
MarkRecommendationSucceededCallback(error, responseopt)
Callback as used by markRecommendationSucceeded.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.Recommendation |
<optional> |
Recommendation |
UpdateInsightTypeConfigCallback(error, responseopt)
Callback as used by updateInsightTypeConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.InsightTypeConfig |
<optional> |
InsightTypeConfig |
UpdateRecommenderConfigCallback(error, responseopt)
Callback as used by updateRecommenderConfig.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
error |
Error | null |
Error, if any |
|
response |
google.cloud.recommender.v1.RecommenderConfig |
<optional> |
RecommenderConfig |