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. v1
Package
@google-cloud/recommenderConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of RecommenderClient.
opts
ClientOptions
gaxInstance
typeof gax
| typeof fallback
: loaded instance of google-gax
. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: ``` const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new RecommenderClient({fallback: true}, gax); ```
Properties
apiEndpoint
get
apiEndpoint
()
:
string
;
The DNS address for this API service.
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath.
auth
auth
:
gax
.
GoogleAuth
;
descriptors
descriptors
:
Descriptors
;
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
pathTemplates
pathTemplates
:
{
[
name
:
string
]
:
gax
.
PathTemplate
;
};
port
static
get
port
()
:
number
;
The port for this API service.
recommenderStub
recommenderStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
universeDomain
get
universeDomain
()
:
string
;
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Methods
billingAccountLocationInsightTypeConfigPath(billingAccount, location, insightType)
billingAccountLocationInsightTypeConfigPath
(
billingAccount
:
string
,
location
:
string
,
insightType
:
string
)
:
string
;
Return a fully-qualified billingAccountLocationInsightTypeConfig resource name string.
billingAccount
string
location
string
insightType
string
string
{string} Resource name string.
billingAccountLocationInsightTypeInsightPath(billingAccount, location, insightType, insight)
billingAccountLocationInsightTypeInsightPath
(
billingAccount
:
string
,
location
:
string
,
insightType
:
string
,
insight
:
string
)
:
string
;
Return a fully-qualified billingAccountLocationInsightTypeInsight resource name string.
billingAccount
string
location
string
insightType
string
insight
string
string
{string} Resource name string.
billingAccountLocationInsightTypePath(billingAccount, location, insightType)
billingAccountLocationInsightTypePath
(
billingAccount
:
string
,
location
:
string
,
insightType
:
string
)
:
string
;
Return a fully-qualified billingAccountLocationInsightType resource name string.
billingAccount
string
location
string
insightType
string
string
{string} Resource name string.
billingAccountLocationRecommenderConfigPath(billingAccount, location, recommender)
billingAccountLocationRecommenderConfigPath
(
billingAccount
:
string
,
location
:
string
,
recommender
:
string
)
:
string
;
Return a fully-qualified billingAccountLocationRecommenderConfig resource name string.
billingAccount
string
location
string
recommender
string
string
{string} Resource name string.
billingAccountLocationRecommenderPath(billingAccount, location, recommender)
billingAccountLocationRecommenderPath
(
billingAccount
:
string
,
location
:
string
,
recommender
:
string
)
:
string
;
Return a fully-qualified billingAccountLocationRecommender resource name string.
billingAccount
string
location
string
recommender
string
string
{string} Resource name string.
billingAccountLocationRecommenderRecommendationPath(billingAccount, location, recommender, recommendation)
billingAccountLocationRecommenderRecommendationPath
(
billingAccount
:
string
,
location
:
string
,
recommender
:
string
,
recommendation
:
string
)
:
string
;
Return a fully-qualified billingAccountLocationRecommenderRecommendation resource name string.
billingAccount
string
location
string
recommender
string
recommendation
string
string
{string} Resource name string.
close()
close
()
:
Promise<void>
;
Terminate the gRPC channel and close the client.
The client will no longer be usable and all future behavior is undefined.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
folderLocationInsightTypeInsightPath(folder, location, insightType, insight)
folderLocationInsightTypeInsightPath
(
folder
:
string
,
location
:
string
,
insightType
:
string
,
insight
:
string
)
:
string
;
Return a fully-qualified folderLocationInsightTypeInsight resource name string.
folder
string
location
string
insightType
string
insight
string
string
{string} Resource name string.
folderLocationInsightTypePath(folder, location, insightType)
folderLocationInsightTypePath
(
folder
:
string
,
location
:
string
,
insightType
:
string
)
:
string
;
Return a fully-qualified folderLocationInsightType resource name string.
folder
string
location
string
insightType
string
string
{string} Resource name string.
folderLocationRecommenderPath(folder, location, recommender)
folderLocationRecommenderPath
(
folder
:
string
,
location
:
string
,
recommender
:
string
)
:
string
;
Return a fully-qualified folderLocationRecommender resource name string.
folder
string
location
string
recommender
string
string
{string} Resource name string.
folderLocationRecommenderRecommendationPath(folder, location, recommender, recommendation)
folderLocationRecommenderRecommendationPath
(
folder
:
string
,
location
:
string
,
recommender
:
string
,
recommendation
:
string
)
:
string
;
Return a fully-qualified folderLocationRecommenderRecommendation resource name string.
folder
string
location
string
recommender
string
recommendation
string
string
{string} Resource name string.
getInsight(request, options)
getInsight
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightRequest
|
undefined
,
{}
|
undefined
]>;
Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IInsight
, protos.google.cloud.recommender.v1.IGetInsightRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the insight.
*/
// const name = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callGetInsight
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
recommenderClient
.
getInsight
(
request
);
console
.
log
(
response
);
}
callGetInsight
();
getInsight(request, options, callback)
getInsight
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IInsight
, protos.google.cloud.recommender.v1.IGetInsightRequest
| null | undefined, {} | null | undefined>
void
getInsight(request, callback)
getInsight
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IInsight
, protos.google.cloud.recommender.v1.IGetInsightRequest
| null | undefined, {} | null | undefined>
void
getInsightTypeConfig(request, options)
getInsightTypeConfig
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightTypeConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IInsightTypeConfig
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightTypeConfigRequest
|
undefined
),
{}
|
undefined
]>;
Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IInsightTypeConfig
,
( protos.google.cloud.recommender.v1.IGetInsightTypeConfigRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing InsightTypeConfig . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the InsightTypeConfig to get.
* Acceptable formats:
* * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
* * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
* * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
* * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config`
*/
// const name = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callGetInsightTypeConfig
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
recommenderClient
.
getInsightTypeConfig
(
request
);
console
.
log
(
response
);
}
callGetInsightTypeConfig
();
getInsightTypeConfig(request, options, callback)
getInsightTypeConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightTypeConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsightTypeConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightTypeConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IInsightTypeConfig
, protos.google.cloud.recommender.v1.IGetInsightTypeConfigRequest
| null | undefined, {} | null | undefined>
void
getInsightTypeConfig(request, callback)
getInsightTypeConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightTypeConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsightTypeConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetInsightTypeConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IInsightTypeConfig
, protos.google.cloud.recommender.v1.IGetInsightTypeConfigRequest
| null | undefined, {} | null | undefined>
void
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
getRecommendation(request, options)
getRecommendation
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommendationRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommendationRequest
|
undefined
,
{}
|
undefined
]>;
Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IGetRecommendationRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the recommendation.
*/
// const name = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callGetRecommendation
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
recommenderClient
.
getRecommendation
(
request
);
console
.
log
(
response
);
}
callGetRecommendation
();
getRecommendation(request, options, callback)
getRecommendation
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommendationRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommendationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IGetRecommendationRequest
| null | undefined, {} | null | undefined>
void
getRecommendation(request, callback)
getRecommendation
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommendationRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommendationRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IGetRecommendationRequest
| null | undefined, {} | null | undefined>
void
getRecommenderConfig(request, options)
getRecommenderConfig
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommenderConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommenderConfig
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommenderConfigRequest
|
undefined
),
{}
|
undefined
]>;
Gets the requested Recommender Config. There is only one instance of the config for each Recommender.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommenderConfig
,
( protos.google.cloud.recommender.v1.IGetRecommenderConfigRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing RecommenderConfig . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the Recommendation Config to get.
* Acceptable formats:
* * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
* * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
* * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
* * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config`
*/
// const name = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callGetRecommenderConfig
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
recommenderClient
.
getRecommenderConfig
(
request
);
console
.
log
(
response
);
}
callGetRecommenderConfig
();
getRecommenderConfig(request, options, callback)
getRecommenderConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommenderConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommenderConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommenderConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IRecommenderConfig
, protos.google.cloud.recommender.v1.IGetRecommenderConfigRequest
| null | undefined, {} | null | undefined>
void
getRecommenderConfig(request, callback)
getRecommenderConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommenderConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommenderConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IGetRecommenderConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IRecommenderConfig
, protos.google.cloud.recommender.v1.IGetRecommenderConfigRequest
| null | undefined, {} | null | undefined>
void
initialize()
initialize
()
:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.
You can await on this method if you want to make sure the client is initialized.
Promise
<{
[name: string]: Function
;
}>
{Promise} A promise that resolves to an authenticated service stub.
listInsights(request, options)
listInsights
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
[],
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
|
null
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsResponse
]>;
Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IInsight
[], protos.google.cloud.recommender.v1.IListInsightsRequest
| null, protos.google.cloud.recommender.v1.IListInsightsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listInsightsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listInsights(request, options, callback)
listInsights
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.recommender.v1.IListInsightsRequest
, protos.google.cloud.recommender.v1.IListInsightsResponse
| null | undefined, protos.google.cloud.recommender.v1.IInsight
>
void
listInsights(request, callback)
listInsights
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.recommender.v1.IListInsightsRequest
, protos.google.cloud.recommender.v1.IListInsightsResponse
| null | undefined, protos.google.cloud.recommender.v1.IInsight
>
void
listInsightsAsync(request, options)
listInsightsAsync
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
> ;
Equivalent to listInsights
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.recommender.v1.IInsight
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The container resource on which to execute the request.
* Acceptable formats:
* * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
* * `projects/[PROJECT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
* * `folders/[FOLDER_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
* * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]`
* LOCATION here refers to GCP Locations:
* https://cloud.google.com/about/locations/
* INSIGHT_TYPE_ID refers to supported insight types:
* https://cloud.google.com/recommender/docs/insights/insight-types.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to return from this request.
* Non-positive values are ignored. If not specified, the server will
* determine the number of results to return.
*/
// const pageSize = 1234
/**
* Optional. If present, retrieves the next batch of results from the
* preceding call to this method. `page_token` must be the value of
* `next_page_token` from the previous response. The values of other method
* parameters must be identical to those in the previous call.
*/
// const pageToken = 'abc123'
/**
* Optional. Filter expression to restrict the insights returned. Supported
* filter fields:
* * `stateInfo.state`
* * `insightSubtype`
* * `severity`
* * `targetResources`
* Examples:
* * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
* * `insightSubtype = PERMISSIONS_USAGE`
* * `severity = CRITICAL OR severity = HIGH`
* * `targetResources :
* //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1`
* * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)`
* The max allowed filter length is 500 characters.
* (These expressions are based on the filter language described at
* https://google.aip.dev/160)
*/
// const filter = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callListInsights
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
recommenderClient
.
listInsightsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListInsights
();
listInsightsStream(request, options)
listInsightsStream
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListInsightsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listInsights
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listInsightsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listRecommendations(request, options)
listRecommendations
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
[],
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
|
null
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsResponse
]>;
Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommendation
[], protos.google.cloud.recommender.v1.IListRecommendationsRequest
| null, protos.google.cloud.recommender.v1.IListRecommendationsResponse
]>
{Promise} - The promise which resolves to an array. The first element of the array is Array of . The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listRecommendationsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
listRecommendations(request, options, callback)
listRecommendations
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
> )
:
void
;
request
options
CallOptions
callback
PaginationCallback
< protos.google.cloud.recommender.v1.IListRecommendationsRequest
, protos.google.cloud.recommender.v1.IListRecommendationsResponse
| null | undefined, protos.google.cloud.recommender.v1.IRecommendation
>
void
listRecommendations(request, callback)
listRecommendations
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
> )
:
void
;
request
callback
PaginationCallback
< protos.google.cloud.recommender.v1.IListRecommendationsRequest
, protos.google.cloud.recommender.v1.IListRecommendationsResponse
| null | undefined, protos.google.cloud.recommender.v1.IRecommendation
>
void
listRecommendationsAsync(request, options)
listRecommendationsAsync
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
> ;
Equivalent to listRecommendations
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
request
options
AsyncIterable
< protos.google.cloud.recommender.v1.IRecommendation
>
{Object} An iterable Object that allows async iteration . When you iterate the returned iterable, each element will be an object representing . The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The container resource on which to execute the request.
* Acceptable formats:
* * `projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
* * `projects/[PROJECT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
* * `billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
* * `folders/[FOLDER_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
* * `organizations/[ORGANIZATION_ID]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]`
* LOCATION here refers to GCP Locations:
* https://cloud.google.com/about/locations/
* RECOMMENDER_ID refers to supported recommenders:
* https://cloud.google.com/recommender/docs/recommenders.
*/
// const parent = 'abc123'
/**
* Optional. The maximum number of results to return from this request.
* Non-positive values are ignored. If not specified, the server will
* determine the number of results to return.
*/
// const pageSize = 1234
/**
* Optional. If present, retrieves the next batch of results from the
* preceding call to this method. `page_token` must be the value of
* `next_page_token` from the previous response. The values of other method
* parameters must be identical to those in the previous call.
*/
// const pageToken = 'abc123'
/**
* Filter expression to restrict the recommendations returned. Supported
* filter fields:
* * `state_info.state`
* * `recommenderSubtype`
* * `priority`
* * `targetResources`
* Examples:
* * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
* * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`
* * `priority = P1 OR priority = P2`
* * `targetResources :
* //compute.googleapis.com/projects/1234/zones/us-central1-a/instances/instance-1`
* * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)`
* The max allowed filter length is 500 characters.
* (These expressions are based on the filter language described at
* https://google.aip.dev/160)
*/
// const filter = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callListRecommendations
()
{
// Construct request
const
request
=
{
parent
,
};
// Run request
const
iterable
=
recommenderClient
.
listRecommendationsAsync
(
request
);
for
await
(
const
response
of
iterable
)
{
console
.
log
(
response
);
}
}
callListRecommendations
();
listRecommendationsStream(request, options)
listRecommendationsStream
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IListRecommendationsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to listRecommendations
, but returns a NodeJS Stream object.
request
options
Transform
{Stream} An object stream which emits an object representing on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listRecommendationsAsync()
method described below for async iteration which you can stop as needed. Please see the documentation
for more details and examples.
markInsightAccepted(request, options)
markInsightAccepted
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkInsightAcceptedRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkInsightAcceptedRequest
|
undefined
),
{}
|
undefined
]>;
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.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IInsight
,
( protos.google.cloud.recommender.v1.IMarkInsightAcceptedRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the insight.
*/
// const name = 'abc123'
/**
* Optional. State properties user wish to include with this state. Full
* replace of the current state_metadata.
*/
// const stateMetadata = [1,2,3,4]
/**
* Required. Fingerprint of the Insight. Provides optimistic locking.
*/
// const etag = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callMarkInsightAccepted
()
{
// Construct request
const
request
=
{
name
,
etag
,
};
// Run request
const
response
=
await
recommenderClient
.
markInsightAccepted
(
request
);
console
.
log
(
response
);
}
callMarkInsightAccepted
();
markInsightAccepted(request, options, callback)
markInsightAccepted
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkInsightAcceptedRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkInsightAcceptedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IInsight
, protos.google.cloud.recommender.v1.IMarkInsightAcceptedRequest
| null | undefined, {} | null | undefined>
void
markInsightAccepted(request, callback)
markInsightAccepted
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkInsightAcceptedRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsight
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkInsightAcceptedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IInsight
, protos.google.cloud.recommender.v1.IMarkInsightAcceptedRequest
| null | undefined, {} | null | undefined>
void
markRecommendationClaimed(request, options)
markRecommendationClaimed
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationClaimedRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationClaimedRequest
|
undefined
),
{}
|
undefined
]>;
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, SUCCEEDED, FAILED, or ACTIVE state.
Requires the recommender.*.update IAM permission for the specified recommender.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommendation
,
( protos.google.cloud.recommender.v1.IMarkRecommendationClaimedRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the recommendation.
*/
// const name = 'abc123'
/**
* State properties to include with this state. Overwrites any existing
* `state_metadata`.
* Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`.
* Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.
*/
// const stateMetadata = [1,2,3,4]
/**
* Required. Fingerprint of the Recommendation. Provides optimistic locking.
*/
// const etag = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callMarkRecommendationClaimed
()
{
// Construct request
const
request
=
{
name
,
etag
,
};
// Run request
const
response
=
await
recommenderClient
.
markRecommendationClaimed
(
request
);
console
.
log
(
response
);
}
callMarkRecommendationClaimed
();
markRecommendationClaimed(request, options, callback)
markRecommendationClaimed
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationClaimedRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationClaimedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationClaimedRequest
| null | undefined, {} | null | undefined>
void
markRecommendationClaimed(request, callback)
markRecommendationClaimed
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationClaimedRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationClaimedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationClaimedRequest
| null | undefined, {} | null | undefined>
void
markRecommendationDismissed(request, options)
markRecommendationDismissed
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationDismissedRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationDismissedRequest
|
undefined
),
{}
|
undefined
]>;
Mark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back as DISMISSED.
MarkRecommendationDismissed can be applied to recommendations in ACTIVE state.
Requires the recommender.*.update IAM permission for the specified recommender.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommendation
,
( protos.google.cloud.recommender.v1.IMarkRecommendationDismissedRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the recommendation.
*/
// const name = 'abc123'
/**
* Fingerprint of the Recommendation. Provides optimistic locking.
*/
// const etag = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callMarkRecommendationDismissed
()
{
// Construct request
const
request
=
{
name
,
};
// Run request
const
response
=
await
recommenderClient
.
markRecommendationDismissed
(
request
);
console
.
log
(
response
);
}
callMarkRecommendationDismissed
();
markRecommendationDismissed(request, options, callback)
markRecommendationDismissed
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationDismissedRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationDismissedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationDismissedRequest
| null | undefined, {} | null | undefined>
void
markRecommendationDismissed(request, callback)
markRecommendationDismissed
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationDismissedRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationDismissedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationDismissedRequest
| null | undefined, {} | null | undefined>
void
markRecommendationFailed(request, options)
markRecommendationFailed
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationFailedRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationFailedRequest
|
undefined
),
{}
|
undefined
]>;
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.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommendation
,
( protos.google.cloud.recommender.v1.IMarkRecommendationFailedRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the recommendation.
*/
// const name = 'abc123'
/**
* State properties to include with this state. Overwrites any existing
* `state_metadata`.
* Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`.
* Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.
*/
// const stateMetadata = [1,2,3,4]
/**
* Required. Fingerprint of the Recommendation. Provides optimistic locking.
*/
// const etag = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callMarkRecommendationFailed
()
{
// Construct request
const
request
=
{
name
,
etag
,
};
// Run request
const
response
=
await
recommenderClient
.
markRecommendationFailed
(
request
);
console
.
log
(
response
);
}
callMarkRecommendationFailed
();
markRecommendationFailed(request, options, callback)
markRecommendationFailed
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationFailedRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationFailedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationFailedRequest
| null | undefined, {} | null | undefined>
void
markRecommendationFailed(request, callback)
markRecommendationFailed
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationFailedRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationFailedRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationFailedRequest
| null | undefined, {} | null | undefined>
void
markRecommendationSucceeded(request, options)
markRecommendationSucceeded
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationSucceededRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationSucceededRequest
|
undefined
),
{}
|
undefined
]>;
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.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommendation
,
( protos.google.cloud.recommender.v1.IMarkRecommendationSucceededRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. Name of the recommendation.
*/
// const name = 'abc123'
/**
* State properties to include with this state. Overwrites any existing
* `state_metadata`.
* Keys must match the regex `/^[a-z0-9][a-z0-9_.-]{0,62}$/`.
* Values must match the regex `/^[a-zA-Z0-9_./-]{0,255}$/`.
*/
// const stateMetadata = [1,2,3,4]
/**
* Required. Fingerprint of the Recommendation. Provides optimistic locking.
*/
// const etag = 'abc123'
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callMarkRecommendationSucceeded
()
{
// Construct request
const
request
=
{
name
,
etag
,
};
// Run request
const
response
=
await
recommenderClient
.
markRecommendationSucceeded
(
request
);
console
.
log
(
response
);
}
callMarkRecommendationSucceeded
();
markRecommendationSucceeded(request, options, callback)
markRecommendationSucceeded
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationSucceededRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationSucceededRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationSucceededRequest
| null | undefined, {} | null | undefined>
void
markRecommendationSucceeded(request, callback)
markRecommendationSucceeded
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationSucceededRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommendation
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IMarkRecommendationSucceededRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
callback
Callback
< protos.google.cloud.recommender.v1.IRecommendation
, protos.google.cloud.recommender.v1.IMarkRecommendationSucceededRequest
| null | undefined, {} | null | undefined>
void
matchBillingAccountFromBillingAccountLocationInsightTypeConfigName(billingAccountLocationInsightTypeConfigName)
matchBillingAccountFromBillingAccountLocationInsightTypeConfigName
(
billingAccountLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the billing_account from BillingAccountLocationInsightTypeConfig resource.
billingAccountLocationInsightTypeConfigName
string
A fully-qualified path representing billing_account_location_insight_type_config resource.
string | number
{string} A string representing the billing_account.
matchBillingAccountFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)
matchBillingAccountFromBillingAccountLocationInsightTypeInsightName
(
billingAccountLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the billing_account from BillingAccountLocationInsightTypeInsight resource.
billingAccountLocationInsightTypeInsightName
string
A fully-qualified path representing billing_account_location_insight_type_insight resource.
string | number
{string} A string representing the billing_account.
matchBillingAccountFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName)
matchBillingAccountFromBillingAccountLocationInsightTypeName
(
billingAccountLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the billing_account from BillingAccountLocationInsightType resource.
billingAccountLocationInsightTypeName
string
A fully-qualified path representing billing_account_location_insight_type resource.
string | number
{string} A string representing the billing_account.
matchBillingAccountFromBillingAccountLocationRecommenderConfigName(billingAccountLocationRecommenderConfigName)
matchBillingAccountFromBillingAccountLocationRecommenderConfigName
(
billingAccountLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the billing_account from BillingAccountLocationRecommenderConfig resource.
billingAccountLocationRecommenderConfigName
string
A fully-qualified path representing billing_account_location_recommender_config resource.
string | number
{string} A string representing the billing_account.
matchBillingAccountFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName)
matchBillingAccountFromBillingAccountLocationRecommenderName
(
billingAccountLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the billing_account from BillingAccountLocationRecommender resource.
billingAccountLocationRecommenderName
string
A fully-qualified path representing billing_account_location_recommender resource.
string | number
{string} A string representing the billing_account.
matchBillingAccountFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)
matchBillingAccountFromBillingAccountLocationRecommenderRecommendationName
(
billingAccountLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the billing_account from BillingAccountLocationRecommenderRecommendation resource.
billingAccountLocationRecommenderRecommendationName
string
A fully-qualified path representing billing_account_location_recommender_recommendation resource.
string | number
{string} A string representing the billing_account.
matchFolderFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)
matchFolderFromFolderLocationInsightTypeInsightName
(
folderLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the folder from FolderLocationInsightTypeInsight resource.
folderLocationInsightTypeInsightName
string
A fully-qualified path representing folder_location_insight_type_insight resource.
string | number
{string} A string representing the folder.
matchFolderFromFolderLocationInsightTypeName(folderLocationInsightTypeName)
matchFolderFromFolderLocationInsightTypeName
(
folderLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the folder from FolderLocationInsightType resource.
folderLocationInsightTypeName
string
A fully-qualified path representing folder_location_insight_type resource.
string | number
{string} A string representing the folder.
matchFolderFromFolderLocationRecommenderName(folderLocationRecommenderName)
matchFolderFromFolderLocationRecommenderName
(
folderLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the folder from FolderLocationRecommender resource.
folderLocationRecommenderName
string
A fully-qualified path representing folder_location_recommender resource.
string | number
{string} A string representing the folder.
matchFolderFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)
matchFolderFromFolderLocationRecommenderRecommendationName
(
folderLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the folder from FolderLocationRecommenderRecommendation resource.
folderLocationRecommenderRecommendationName
string
A fully-qualified path representing folder_location_recommender_recommendation resource.
string | number
{string} A string representing the folder.
matchInsightFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)
matchInsightFromBillingAccountLocationInsightTypeInsightName
(
billingAccountLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight from BillingAccountLocationInsightTypeInsight resource.
billingAccountLocationInsightTypeInsightName
string
A fully-qualified path representing billing_account_location_insight_type_insight resource.
string | number
{string} A string representing the insight.
matchInsightFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)
matchInsightFromFolderLocationInsightTypeInsightName
(
folderLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight from FolderLocationInsightTypeInsight resource.
folderLocationInsightTypeInsightName
string
A fully-qualified path representing folder_location_insight_type_insight resource.
string | number
{string} A string representing the insight.
matchInsightFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)
matchInsightFromOrganizationLocationInsightTypeInsightName
(
organizationLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight from OrganizationLocationInsightTypeInsight resource.
organizationLocationInsightTypeInsightName
string
A fully-qualified path representing organization_location_insight_type_insight resource.
string | number
{string} A string representing the insight.
matchInsightFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)
matchInsightFromProjectLocationInsightTypeInsightName
(
projectLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight from ProjectLocationInsightTypeInsight resource.
projectLocationInsightTypeInsightName
string
A fully-qualified path representing project_location_insight_type_insight resource.
string | number
{string} A string representing the insight.
matchInsightTypeFromBillingAccountLocationInsightTypeConfigName(billingAccountLocationInsightTypeConfigName)
matchInsightTypeFromBillingAccountLocationInsightTypeConfigName
(
billingAccountLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the insight_type from BillingAccountLocationInsightTypeConfig resource.
billingAccountLocationInsightTypeConfigName
string
A fully-qualified path representing billing_account_location_insight_type_config resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)
matchInsightTypeFromBillingAccountLocationInsightTypeInsightName
(
billingAccountLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight_type from BillingAccountLocationInsightTypeInsight resource.
billingAccountLocationInsightTypeInsightName
string
A fully-qualified path representing billing_account_location_insight_type_insight resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName)
matchInsightTypeFromBillingAccountLocationInsightTypeName
(
billingAccountLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the insight_type from BillingAccountLocationInsightType resource.
billingAccountLocationInsightTypeName
string
A fully-qualified path representing billing_account_location_insight_type resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)
matchInsightTypeFromFolderLocationInsightTypeInsightName
(
folderLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight_type from FolderLocationInsightTypeInsight resource.
folderLocationInsightTypeInsightName
string
A fully-qualified path representing folder_location_insight_type_insight resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromFolderLocationInsightTypeName(folderLocationInsightTypeName)
matchInsightTypeFromFolderLocationInsightTypeName
(
folderLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the insight_type from FolderLocationInsightType resource.
folderLocationInsightTypeName
string
A fully-qualified path representing folder_location_insight_type resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName)
matchInsightTypeFromOrganizationLocationInsightTypeConfigName
(
organizationLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the insight_type from OrganizationLocationInsightTypeConfig resource.
organizationLocationInsightTypeConfigName
string
A fully-qualified path representing organization_location_insight_type_config resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)
matchInsightTypeFromOrganizationLocationInsightTypeInsightName
(
organizationLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight_type from OrganizationLocationInsightTypeInsight resource.
organizationLocationInsightTypeInsightName
string
A fully-qualified path representing organization_location_insight_type_insight resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName)
matchInsightTypeFromOrganizationLocationInsightTypeName
(
organizationLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the insight_type from OrganizationLocationInsightType resource.
organizationLocationInsightTypeName
string
A fully-qualified path representing organization_location_insight_type resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName)
matchInsightTypeFromProjectLocationInsightTypeConfigName
(
projectLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the insight_type from ProjectLocationInsightTypeConfig resource.
projectLocationInsightTypeConfigName
string
A fully-qualified path representing project_location_insight_type_config resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)
matchInsightTypeFromProjectLocationInsightTypeInsightName
(
projectLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the insight_type from ProjectLocationInsightTypeInsight resource.
projectLocationInsightTypeInsightName
string
A fully-qualified path representing project_location_insight_type_insight resource.
string | number
{string} A string representing the insight_type.
matchInsightTypeFromProjectLocationInsightTypeName(projectLocationInsightTypeName)
matchInsightTypeFromProjectLocationInsightTypeName
(
projectLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the insight_type from ProjectLocationInsightType resource.
projectLocationInsightTypeName
string
A fully-qualified path representing project_location_insight_type resource.
string | number
{string} A string representing the insight_type.
matchLocationFromBillingAccountLocationInsightTypeConfigName(billingAccountLocationInsightTypeConfigName)
matchLocationFromBillingAccountLocationInsightTypeConfigName
(
billingAccountLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the location from BillingAccountLocationInsightTypeConfig resource.
billingAccountLocationInsightTypeConfigName
string
A fully-qualified path representing billing_account_location_insight_type_config resource.
string | number
{string} A string representing the location.
matchLocationFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)
matchLocationFromBillingAccountLocationInsightTypeInsightName
(
billingAccountLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the location from BillingAccountLocationInsightTypeInsight resource.
billingAccountLocationInsightTypeInsightName
string
A fully-qualified path representing billing_account_location_insight_type_insight resource.
string | number
{string} A string representing the location.
matchLocationFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName)
matchLocationFromBillingAccountLocationInsightTypeName
(
billingAccountLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the location from BillingAccountLocationInsightType resource.
billingAccountLocationInsightTypeName
string
A fully-qualified path representing billing_account_location_insight_type resource.
string | number
{string} A string representing the location.
matchLocationFromBillingAccountLocationRecommenderConfigName(billingAccountLocationRecommenderConfigName)
matchLocationFromBillingAccountLocationRecommenderConfigName
(
billingAccountLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the location from BillingAccountLocationRecommenderConfig resource.
billingAccountLocationRecommenderConfigName
string
A fully-qualified path representing billing_account_location_recommender_config resource.
string | number
{string} A string representing the location.
matchLocationFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName)
matchLocationFromBillingAccountLocationRecommenderName
(
billingAccountLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the location from BillingAccountLocationRecommender resource.
billingAccountLocationRecommenderName
string
A fully-qualified path representing billing_account_location_recommender resource.
string | number
{string} A string representing the location.
matchLocationFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)
matchLocationFromBillingAccountLocationRecommenderRecommendationName
(
billingAccountLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the location from BillingAccountLocationRecommenderRecommendation resource.
billingAccountLocationRecommenderRecommendationName
string
A fully-qualified path representing billing_account_location_recommender_recommendation resource.
string | number
{string} A string representing the location.
matchLocationFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)
matchLocationFromFolderLocationInsightTypeInsightName
(
folderLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the location from FolderLocationInsightTypeInsight resource.
folderLocationInsightTypeInsightName
string
A fully-qualified path representing folder_location_insight_type_insight resource.
string | number
{string} A string representing the location.
matchLocationFromFolderLocationInsightTypeName(folderLocationInsightTypeName)
matchLocationFromFolderLocationInsightTypeName
(
folderLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the location from FolderLocationInsightType resource.
folderLocationInsightTypeName
string
A fully-qualified path representing folder_location_insight_type resource.
string | number
{string} A string representing the location.
matchLocationFromFolderLocationRecommenderName(folderLocationRecommenderName)
matchLocationFromFolderLocationRecommenderName
(
folderLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the location from FolderLocationRecommender resource.
folderLocationRecommenderName
string
A fully-qualified path representing folder_location_recommender resource.
string | number
{string} A string representing the location.
matchLocationFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)
matchLocationFromFolderLocationRecommenderRecommendationName
(
folderLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the location from FolderLocationRecommenderRecommendation resource.
folderLocationRecommenderRecommendationName
string
A fully-qualified path representing folder_location_recommender_recommendation resource.
string | number
{string} A string representing the location.
matchLocationFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName)
matchLocationFromOrganizationLocationInsightTypeConfigName
(
organizationLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the location from OrganizationLocationInsightTypeConfig resource.
organizationLocationInsightTypeConfigName
string
A fully-qualified path representing organization_location_insight_type_config resource.
string | number
{string} A string representing the location.
matchLocationFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)
matchLocationFromOrganizationLocationInsightTypeInsightName
(
organizationLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the location from OrganizationLocationInsightTypeInsight resource.
organizationLocationInsightTypeInsightName
string
A fully-qualified path representing organization_location_insight_type_insight resource.
string | number
{string} A string representing the location.
matchLocationFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName)
matchLocationFromOrganizationLocationInsightTypeName
(
organizationLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the location from OrganizationLocationInsightType resource.
organizationLocationInsightTypeName
string
A fully-qualified path representing organization_location_insight_type resource.
string | number
{string} A string representing the location.
matchLocationFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName)
matchLocationFromOrganizationLocationRecommenderConfigName
(
organizationLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the location from OrganizationLocationRecommenderConfig resource.
organizationLocationRecommenderConfigName
string
A fully-qualified path representing organization_location_recommender_config resource.
string | number
{string} A string representing the location.
matchLocationFromOrganizationLocationRecommenderName(organizationLocationRecommenderName)
matchLocationFromOrganizationLocationRecommenderName
(
organizationLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the location from OrganizationLocationRecommender resource.
organizationLocationRecommenderName
string
A fully-qualified path representing organization_location_recommender resource.
string | number
{string} A string representing the location.
matchLocationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)
matchLocationFromOrganizationLocationRecommenderRecommendationName
(
organizationLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the location from OrganizationLocationRecommenderRecommendation resource.
organizationLocationRecommenderRecommendationName
string
A fully-qualified path representing organization_location_recommender_recommendation resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName)
matchLocationFromProjectLocationInsightTypeConfigName
(
projectLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationInsightTypeConfig resource.
projectLocationInsightTypeConfigName
string
A fully-qualified path representing project_location_insight_type_config resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)
matchLocationFromProjectLocationInsightTypeInsightName
(
projectLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationInsightTypeInsight resource.
projectLocationInsightTypeInsightName
string
A fully-qualified path representing project_location_insight_type_insight resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationInsightTypeName(projectLocationInsightTypeName)
matchLocationFromProjectLocationInsightTypeName
(
projectLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationInsightType resource.
projectLocationInsightTypeName
string
A fully-qualified path representing project_location_insight_type resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName)
matchLocationFromProjectLocationRecommenderConfigName
(
projectLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationRecommenderConfig resource.
projectLocationRecommenderConfigName
string
A fully-qualified path representing project_location_recommender_config resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationRecommenderName(projectLocationRecommenderName)
matchLocationFromProjectLocationRecommenderName
(
projectLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationRecommender resource.
projectLocationRecommenderName
string
A fully-qualified path representing project_location_recommender resource.
string | number
{string} A string representing the location.
matchLocationFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)
matchLocationFromProjectLocationRecommenderRecommendationName
(
projectLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the location from ProjectLocationRecommenderRecommendation resource.
projectLocationRecommenderRecommendationName
string
A fully-qualified path representing project_location_recommender_recommendation resource.
string | number
{string} A string representing the location.
matchOrganizationFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName)
matchOrganizationFromOrganizationLocationInsightTypeConfigName
(
organizationLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the organization from OrganizationLocationInsightTypeConfig resource.
organizationLocationInsightTypeConfigName
string
A fully-qualified path representing organization_location_insight_type_config resource.
string | number
{string} A string representing the organization.
matchOrganizationFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)
matchOrganizationFromOrganizationLocationInsightTypeInsightName
(
organizationLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the organization from OrganizationLocationInsightTypeInsight resource.
organizationLocationInsightTypeInsightName
string
A fully-qualified path representing organization_location_insight_type_insight resource.
string | number
{string} A string representing the organization.
matchOrganizationFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName)
matchOrganizationFromOrganizationLocationInsightTypeName
(
organizationLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the organization from OrganizationLocationInsightType resource.
organizationLocationInsightTypeName
string
A fully-qualified path representing organization_location_insight_type resource.
string | number
{string} A string representing the organization.
matchOrganizationFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName)
matchOrganizationFromOrganizationLocationRecommenderConfigName
(
organizationLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the organization from OrganizationLocationRecommenderConfig resource.
organizationLocationRecommenderConfigName
string
A fully-qualified path representing organization_location_recommender_config resource.
string | number
{string} A string representing the organization.
matchOrganizationFromOrganizationLocationRecommenderName(organizationLocationRecommenderName)
matchOrganizationFromOrganizationLocationRecommenderName
(
organizationLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the organization from OrganizationLocationRecommender resource.
organizationLocationRecommenderName
string
A fully-qualified path representing organization_location_recommender resource.
string | number
{string} A string representing the organization.
matchOrganizationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)
matchOrganizationFromOrganizationLocationRecommenderRecommendationName
(
organizationLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the organization from OrganizationLocationRecommenderRecommendation resource.
organizationLocationRecommenderRecommendationName
string
A fully-qualified path representing organization_location_recommender_recommendation resource.
string | number
{string} A string representing the organization.
matchProjectFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName)
matchProjectFromProjectLocationInsightTypeConfigName
(
projectLocationInsightTypeConfigName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationInsightTypeConfig resource.
projectLocationInsightTypeConfigName
string
A fully-qualified path representing project_location_insight_type_config resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)
matchProjectFromProjectLocationInsightTypeInsightName
(
projectLocationInsightTypeInsightName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationInsightTypeInsight resource.
projectLocationInsightTypeInsightName
string
A fully-qualified path representing project_location_insight_type_insight resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationInsightTypeName(projectLocationInsightTypeName)
matchProjectFromProjectLocationInsightTypeName
(
projectLocationInsightTypeName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationInsightType resource.
projectLocationInsightTypeName
string
A fully-qualified path representing project_location_insight_type resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName)
matchProjectFromProjectLocationRecommenderConfigName
(
projectLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationRecommenderConfig resource.
projectLocationRecommenderConfigName
string
A fully-qualified path representing project_location_recommender_config resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationRecommenderName(projectLocationRecommenderName)
matchProjectFromProjectLocationRecommenderName
(
projectLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationRecommender resource.
projectLocationRecommenderName
string
A fully-qualified path representing project_location_recommender resource.
string | number
{string} A string representing the project.
matchProjectFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)
matchProjectFromProjectLocationRecommenderRecommendationName
(
projectLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the project from ProjectLocationRecommenderRecommendation resource.
projectLocationRecommenderRecommendationName
string
A fully-qualified path representing project_location_recommender_recommendation resource.
string | number
{string} A string representing the project.
matchRecommendationFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)
matchRecommendationFromBillingAccountLocationRecommenderRecommendationName
(
billingAccountLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommendation from BillingAccountLocationRecommenderRecommendation resource.
billingAccountLocationRecommenderRecommendationName
string
A fully-qualified path representing billing_account_location_recommender_recommendation resource.
string | number
{string} A string representing the recommendation.
matchRecommendationFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)
matchRecommendationFromFolderLocationRecommenderRecommendationName
(
folderLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommendation from FolderLocationRecommenderRecommendation resource.
folderLocationRecommenderRecommendationName
string
A fully-qualified path representing folder_location_recommender_recommendation resource.
string | number
{string} A string representing the recommendation.
matchRecommendationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)
matchRecommendationFromOrganizationLocationRecommenderRecommendationName
(
organizationLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommendation from OrganizationLocationRecommenderRecommendation resource.
organizationLocationRecommenderRecommendationName
string
A fully-qualified path representing organization_location_recommender_recommendation resource.
string | number
{string} A string representing the recommendation.
matchRecommendationFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)
matchRecommendationFromProjectLocationRecommenderRecommendationName
(
projectLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommendation from ProjectLocationRecommenderRecommendation resource.
projectLocationRecommenderRecommendationName
string
A fully-qualified path representing project_location_recommender_recommendation resource.
string | number
{string} A string representing the recommendation.
matchRecommenderFromBillingAccountLocationRecommenderConfigName(billingAccountLocationRecommenderConfigName)
matchRecommenderFromBillingAccountLocationRecommenderConfigName
(
billingAccountLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the recommender from BillingAccountLocationRecommenderConfig resource.
billingAccountLocationRecommenderConfigName
string
A fully-qualified path representing billing_account_location_recommender_config resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName)
matchRecommenderFromBillingAccountLocationRecommenderName
(
billingAccountLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the recommender from BillingAccountLocationRecommender resource.
billingAccountLocationRecommenderName
string
A fully-qualified path representing billing_account_location_recommender resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)
matchRecommenderFromBillingAccountLocationRecommenderRecommendationName
(
billingAccountLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommender from BillingAccountLocationRecommenderRecommendation resource.
billingAccountLocationRecommenderRecommendationName
string
A fully-qualified path representing billing_account_location_recommender_recommendation resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromFolderLocationRecommenderName(folderLocationRecommenderName)
matchRecommenderFromFolderLocationRecommenderName
(
folderLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the recommender from FolderLocationRecommender resource.
folderLocationRecommenderName
string
A fully-qualified path representing folder_location_recommender resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)
matchRecommenderFromFolderLocationRecommenderRecommendationName
(
folderLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommender from FolderLocationRecommenderRecommendation resource.
folderLocationRecommenderRecommendationName
string
A fully-qualified path representing folder_location_recommender_recommendation resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName)
matchRecommenderFromOrganizationLocationRecommenderConfigName
(
organizationLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the recommender from OrganizationLocationRecommenderConfig resource.
organizationLocationRecommenderConfigName
string
A fully-qualified path representing organization_location_recommender_config resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromOrganizationLocationRecommenderName(organizationLocationRecommenderName)
matchRecommenderFromOrganizationLocationRecommenderName
(
organizationLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the recommender from OrganizationLocationRecommender resource.
organizationLocationRecommenderName
string
A fully-qualified path representing organization_location_recommender resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)
matchRecommenderFromOrganizationLocationRecommenderRecommendationName
(
organizationLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommender from OrganizationLocationRecommenderRecommendation resource.
organizationLocationRecommenderRecommendationName
string
A fully-qualified path representing organization_location_recommender_recommendation resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName)
matchRecommenderFromProjectLocationRecommenderConfigName
(
projectLocationRecommenderConfigName
:
string
)
:
string
|
number
;
Parse the recommender from ProjectLocationRecommenderConfig resource.
projectLocationRecommenderConfigName
string
A fully-qualified path representing project_location_recommender_config resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromProjectLocationRecommenderName(projectLocationRecommenderName)
matchRecommenderFromProjectLocationRecommenderName
(
projectLocationRecommenderName
:
string
)
:
string
|
number
;
Parse the recommender from ProjectLocationRecommender resource.
projectLocationRecommenderName
string
A fully-qualified path representing project_location_recommender resource.
string | number
{string} A string representing the recommender.
matchRecommenderFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)
matchRecommenderFromProjectLocationRecommenderRecommendationName
(
projectLocationRecommenderRecommendationName
:
string
)
:
string
|
number
;
Parse the recommender from ProjectLocationRecommenderRecommendation resource.
projectLocationRecommenderRecommendationName
string
A fully-qualified path representing project_location_recommender_recommendation resource.
string | number
{string} A string representing the recommender.
organizationLocationInsightTypeConfigPath(organization, location, insightType)
organizationLocationInsightTypeConfigPath
(
organization
:
string
,
location
:
string
,
insightType
:
string
)
:
string
;
Return a fully-qualified organizationLocationInsightTypeConfig resource name string.
organization
string
location
string
insightType
string
string
{string} Resource name string.
organizationLocationInsightTypeInsightPath(organization, location, insightType, insight)
organizationLocationInsightTypeInsightPath
(
organization
:
string
,
location
:
string
,
insightType
:
string
,
insight
:
string
)
:
string
;
Return a fully-qualified organizationLocationInsightTypeInsight resource name string.
organization
string
location
string
insightType
string
insight
string
string
{string} Resource name string.
organizationLocationInsightTypePath(organization, location, insightType)
organizationLocationInsightTypePath
(
organization
:
string
,
location
:
string
,
insightType
:
string
)
:
string
;
Return a fully-qualified organizationLocationInsightType resource name string.
organization
string
location
string
insightType
string
string
{string} Resource name string.
organizationLocationRecommenderConfigPath(organization, location, recommender)
organizationLocationRecommenderConfigPath
(
organization
:
string
,
location
:
string
,
recommender
:
string
)
:
string
;
Return a fully-qualified organizationLocationRecommenderConfig resource name string.
organization
string
location
string
recommender
string
string
{string} Resource name string.
organizationLocationRecommenderPath(organization, location, recommender)
organizationLocationRecommenderPath
(
organization
:
string
,
location
:
string
,
recommender
:
string
)
:
string
;
Return a fully-qualified organizationLocationRecommender resource name string.
organization
string
location
string
recommender
string
string
{string} Resource name string.
organizationLocationRecommenderRecommendationPath(organization, location, recommender, recommendation)
organizationLocationRecommenderRecommendationPath
(
organization
:
string
,
location
:
string
,
recommender
:
string
,
recommendation
:
string
)
:
string
;
Return a fully-qualified organizationLocationRecommenderRecommendation resource name string.
organization
string
location
string
recommender
string
recommendation
string
string
{string} Resource name string.
projectLocationInsightTypeConfigPath(project, location, insightType)
projectLocationInsightTypeConfigPath
(
project
:
string
,
location
:
string
,
insightType
:
string
)
:
string
;
Return a fully-qualified projectLocationInsightTypeConfig resource name string.
project
string
location
string
insightType
string
string
{string} Resource name string.
projectLocationInsightTypeInsightPath(project, location, insightType, insight)
projectLocationInsightTypeInsightPath
(
project
:
string
,
location
:
string
,
insightType
:
string
,
insight
:
string
)
:
string
;
Return a fully-qualified projectLocationInsightTypeInsight resource name string.
project
string
location
string
insightType
string
insight
string
string
{string} Resource name string.
projectLocationInsightTypePath(project, location, insightType)
projectLocationInsightTypePath
(
project
:
string
,
location
:
string
,
insightType
:
string
)
:
string
;
Return a fully-qualified projectLocationInsightType resource name string.
project
string
location
string
insightType
string
string
{string} Resource name string.
projectLocationRecommenderConfigPath(project, location, recommender)
projectLocationRecommenderConfigPath
(
project
:
string
,
location
:
string
,
recommender
:
string
)
:
string
;
Return a fully-qualified projectLocationRecommenderConfig resource name string.
project
string
location
string
recommender
string
string
{string} Resource name string.
projectLocationRecommenderPath(project, location, recommender)
projectLocationRecommenderPath
(
project
:
string
,
location
:
string
,
recommender
:
string
)
:
string
;
Return a fully-qualified projectLocationRecommender resource name string.
project
string
location
string
recommender
string
string
{string} Resource name string.
projectLocationRecommenderRecommendationPath(project, location, recommender, recommendation)
projectLocationRecommenderRecommendationPath
(
project
:
string
,
location
:
string
,
recommender
:
string
,
recommendation
:
string
)
:
string
;
Return a fully-qualified projectLocationRecommenderRecommendation resource name string.
project
string
location
string
recommender
string
recommendation
string
string
{string} Resource name string.
updateInsightTypeConfig(request, options)
updateInsightTypeConfig
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateInsightTypeConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IInsightTypeConfig
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateInsightTypeConfigRequest
|
undefined
),
{}
|
undefined
]>;
Updates an InsightTypeConfig change. This will create a new revision of the config.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IInsightTypeConfig
,
( protos.google.cloud.recommender.v1.IUpdateInsightTypeConfigRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing InsightTypeConfig . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The InsightTypeConfig to update.
*/
// const insightTypeConfig = {}
/**
* The list of fields to be updated.
*/
// const updateMask = {}
/**
* If true, validate the request and preview the change, but do not actually
* update it.
*/
// const validateOnly = true
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callUpdateInsightTypeConfig
()
{
// Construct request
const
request
=
{
insightTypeConfig
,
};
// Run request
const
response
=
await
recommenderClient
.
updateInsightTypeConfig
(
request
);
console
.
log
(
response
);
}
callUpdateInsightTypeConfig
();
updateInsightTypeConfig(request, options, callback)
updateInsightTypeConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateInsightTypeConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsightTypeConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateInsightTypeConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IInsightTypeConfig
, protos.google.cloud.recommender.v1.IUpdateInsightTypeConfigRequest
| null | undefined, {} | null | undefined>
void
updateInsightTypeConfig(request, callback)
updateInsightTypeConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateInsightTypeConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IInsightTypeConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateInsightTypeConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IInsightTypeConfig
, protos.google.cloud.recommender.v1.IUpdateInsightTypeConfigRequest
| null | undefined, {} | null | undefined>
void
updateRecommenderConfig(request, options)
updateRecommenderConfig
(
request
?:
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateRecommenderConfigRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommenderConfig
,
(
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateRecommenderConfigRequest
|
undefined
),
{}
|
undefined
]>;
Updates a Recommender Config. This will create a new revision of the config.
request
options
Promise
<[ protos.google.cloud.recommender.v1.IRecommenderConfig
,
( protos.google.cloud.recommender.v1.IUpdateRecommenderConfigRequest
| undefined),
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing RecommenderConfig . Please see the documentation for more details and examples.
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The RecommenderConfig to update.
*/
// const recommenderConfig = {}
/**
* The list of fields to be updated.
*/
// const updateMask = {}
/**
* If true, validate the request and preview the change, but do not actually
* update it.
*/
// const validateOnly = true
// Imports the Recommender library
const
{
RecommenderClient
}
=
require
(
' @google-cloud/recommender
'
).
v1
;
// Instantiates a client
const
recommenderClient
=
new
RecommenderClient
();
async
function
callUpdateRecommenderConfig
()
{
// Construct request
const
request
=
{
recommenderConfig
,
};
// Run request
const
response
=
await
recommenderClient
.
updateRecommenderConfig
(
request
);
console
.
log
(
response
);
}
callUpdateRecommenderConfig
();
updateRecommenderConfig(request, options, callback)
updateRecommenderConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateRecommenderConfigRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommenderConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateRecommenderConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
options
CallOptions
callback
Callback
< protos.google.cloud.recommender.v1.IRecommenderConfig
, protos.google.cloud.recommender.v1.IUpdateRecommenderConfigRequest
| null | undefined, {} | null | undefined>
void
updateRecommenderConfig(request, callback)
updateRecommenderConfig
(
request
:
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateRecommenderConfigRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
recommender
.
v1
.
IRecommenderConfig
,
protos
.
google
.
cloud
.
recommender
.
v1
.
IUpdateRecommenderConfigRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
callback
Callback
< protos.google.cloud.recommender.v1.IRecommenderConfig
, protos.google.cloud.recommender.v1.IUpdateRecommenderConfigRequest
| null | undefined, {} | null | undefined>
void
