Class v1.RecommenderClient (4.2.5)

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/recommender

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of RecommenderClient.

Parameter

Name	Description
opts	`ClientOptions`

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

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.

Methods

billingAccountLocationInsightTypeInsightPath(billingAccount, location, insightType, insight)

billingAccountLocationInsightTypeInsightPath(billingAccount: string, location: string, insightType: string, insight: string): string;

Return a fully-qualified billingAccountLocationInsightTypeInsight resource name string.

Parameters

Name	Description
billingAccount	`string`
location	`string`
insightType	`string`
insight	`string`

Returns

Type	Description
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.

Parameters

Name	Description
billingAccount	`string`
location	`string`
insightType	`string`

Returns

Type	Description
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.

Parameters

Name	Description
billingAccount	`string`
location	`string`
recommender	`string`

Returns

Type	Description
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.

Parameters

Name	Description
billingAccount	`string`
location	`string`
recommender	`string`
recommendation	`string`

Returns

Type	Description
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.

Returns

Type	Description
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.

Parameters

Name	Description
folder	`string`
location	`string`
insightType	`string`
insight	`string`

Returns

Type	Description
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.

Parameters

Name	Description
folder	`string`
location	`string`
insightType	`string`

Returns

Type	Description
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.

Parameters

Name	Description
folder	`string`
location	`string`
recommender	`string`

Returns

Type	Description
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.

Parameters

Name	Description
folder	`string`
location	`string`
recommender	`string`
recommendation	`string`

Returns

Type	Description
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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IGetInsightRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IInsight, protos.google.cloud.recommender.v1.IGetInsightRequest \| undefined, {} \| undefined]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	`Callback<string, undefined, undefined>`

Returns

Type	Description
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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IGetRecommendationRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IRecommendation, protos.google.cloud.recommender.v1.IGetRecommendationRequest \| undefined, {} \| undefined]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
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.

Returns

Type	Description
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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IListInsightsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IInsight[], protos.google.cloud.recommender.v1.IListInsightsRequest \| null, protos.google.cloud.recommender.v1.IListInsightsResponse]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
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.

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IListInsightsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.recommender.v1.IInsight>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Insight]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

const iterable = client.listInsightsAsync(request); for await (const response of iterable) { // process response }

listInsightsStream(request, options)

listInsightsStream(request?: protos.google.cloud.recommender.v1.IListInsightsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IListInsightsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Insight] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IListRecommendationsRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IRecommendation[], protos.google.cloud.recommender.v1.IListRecommendationsRequest \| null, protos.google.cloud.recommender.v1.IListRecommendationsResponse]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
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.

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IListRecommendationsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable<protos.google.cloud.recommender.v1.IRecommendation>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Recommendation]. 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

const iterable = client.listRecommendationsAsync(request); for await (const response of iterable) { // process response }

listRecommendationsStream(request, options)

listRecommendationsStream(request?: protos.google.cloud.recommender.v1.IListRecommendationsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IListRecommendationsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Transform

{Stream} An object stream which emits an object representing [Recommendation] 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](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) 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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IMarkInsightAcceptedRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IInsight, (protos.google.cloud.recommender.v1.IMarkInsightAcceptedRequest \| undefined), {} \| undefined]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IMarkRecommendationClaimedRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IRecommendation, (protos.google.cloud.recommender.v1.IMarkRecommendationClaimedRequest \| undefined), {} \| undefined]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IMarkRecommendationFailedRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IRecommendation, (protos.google.cloud.recommender.v1.IMarkRecommendationFailedRequest \| undefined), {} \| undefined]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
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]>;

Parameters

Name	Description
request	`protos.google.cloud.recommender.v1.IMarkRecommendationSucceededRequest`
options	`CallOptions`

Returns

Type	Description
Promise<[protos.google.cloud.recommender.v1.IRecommendation, (protos.google.cloud.recommender.v1.IMarkRecommendationSucceededRequest \| undefined), {} \| undefined]>

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;

Parameters

Name	Description
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>`

Returns

Type	Description
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;

Parameters

Name	Description
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>`

Returns

Type	Description
void

matchBillingAccountFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)

matchBillingAccountFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName: string): string | number;

Parse the billing_account from BillingAccountLocationInsightTypeInsight resource.

Parameter

Name	Description
billingAccountLocationInsightTypeInsightName	`string` A fully-qualified path representing billing_account_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the billing_account.

matchBillingAccountFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName)

matchBillingAccountFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName: string): string | number;

Parse the billing_account from BillingAccountLocationInsightType resource.

Parameter

Name	Description
billingAccountLocationInsightTypeName	`string` A fully-qualified path representing billing_account_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the billing_account.

matchBillingAccountFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName)

matchBillingAccountFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName: string): string | number;

Parse the billing_account from BillingAccountLocationRecommender resource.

Parameter

Name	Description
billingAccountLocationRecommenderName	`string` A fully-qualified path representing billing_account_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the billing_account.

matchBillingAccountFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)

matchBillingAccountFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName: string): string | number;

Parse the billing_account from BillingAccountLocationRecommenderRecommendation resource.

Parameter

Name	Description
billingAccountLocationRecommenderRecommendationName	`string` A fully-qualified path representing billing_account_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the billing_account.

matchFolderFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)

matchFolderFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName: string): string | number;

Parse the folder from FolderLocationInsightTypeInsight resource.

Parameter

Name	Description
folderLocationInsightTypeInsightName	`string` A fully-qualified path representing folder_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the folder.

matchFolderFromFolderLocationInsightTypeName(folderLocationInsightTypeName)

matchFolderFromFolderLocationInsightTypeName(folderLocationInsightTypeName: string): string | number;

Parse the folder from FolderLocationInsightType resource.

Parameter

Name	Description
folderLocationInsightTypeName	`string` A fully-qualified path representing folder_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the folder.

matchFolderFromFolderLocationRecommenderName(folderLocationRecommenderName)

matchFolderFromFolderLocationRecommenderName(folderLocationRecommenderName: string): string | number;

Parse the folder from FolderLocationRecommender resource.

Parameter

Name	Description
folderLocationRecommenderName	`string` A fully-qualified path representing folder_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the folder.

matchFolderFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)

matchFolderFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName: string): string | number;

Parse the folder from FolderLocationRecommenderRecommendation resource.

Parameter

Name	Description
folderLocationRecommenderRecommendationName	`string` A fully-qualified path representing folder_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the folder.

matchInsightFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)

matchInsightFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName: string): string | number;

Parse the insight from BillingAccountLocationInsightTypeInsight resource.

Parameter

Name	Description
billingAccountLocationInsightTypeInsightName	`string` A fully-qualified path representing billing_account_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight.

matchInsightFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)

matchInsightFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName: string): string | number;

Parse the insight from FolderLocationInsightTypeInsight resource.

Parameter

Name	Description
folderLocationInsightTypeInsightName	`string` A fully-qualified path representing folder_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight.

matchInsightFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)

matchInsightFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName: string): string | number;

Parse the insight from OrganizationLocationInsightTypeInsight resource.

Parameter

Name	Description
organizationLocationInsightTypeInsightName	`string` A fully-qualified path representing organization_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight.

matchInsightFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)

matchInsightFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName: string): string | number;

Parse the insight from ProjectLocationInsightTypeInsight resource.

Parameter

Name	Description
projectLocationInsightTypeInsightName	`string` A fully-qualified path representing project_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight.

matchInsightTypeFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)

matchInsightTypeFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName: string): string | number;

Parse the insight_type from BillingAccountLocationInsightTypeInsight resource.

Parameter

Name	Description
billingAccountLocationInsightTypeInsightName	`string` A fully-qualified path representing billing_account_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchInsightTypeFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName)

matchInsightTypeFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName: string): string | number;

Parse the insight_type from BillingAccountLocationInsightType resource.

Parameter

Name	Description
billingAccountLocationInsightTypeName	`string` A fully-qualified path representing billing_account_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchInsightTypeFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)

matchInsightTypeFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName: string): string | number;

Parse the insight_type from FolderLocationInsightTypeInsight resource.

Parameter

Name	Description
folderLocationInsightTypeInsightName	`string` A fully-qualified path representing folder_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchInsightTypeFromFolderLocationInsightTypeName(folderLocationInsightTypeName)

matchInsightTypeFromFolderLocationInsightTypeName(folderLocationInsightTypeName: string): string | number;

Parse the insight_type from FolderLocationInsightType resource.

Parameter

Name	Description
folderLocationInsightTypeName	`string` A fully-qualified path representing folder_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchInsightTypeFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)

matchInsightTypeFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName: string): string | number;

Parse the insight_type from OrganizationLocationInsightTypeInsight resource.

Parameter

Name	Description
organizationLocationInsightTypeInsightName	`string` A fully-qualified path representing organization_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchInsightTypeFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName)

matchInsightTypeFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName: string): string | number;

Parse the insight_type from OrganizationLocationInsightType resource.

Parameter

Name	Description
organizationLocationInsightTypeName	`string` A fully-qualified path representing organization_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchInsightTypeFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)

matchInsightTypeFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName: string): string | number;

Parse the insight_type from ProjectLocationInsightTypeInsight resource.

Parameter

Name	Description
projectLocationInsightTypeInsightName	`string` A fully-qualified path representing project_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchInsightTypeFromProjectLocationInsightTypeName(projectLocationInsightTypeName)

matchInsightTypeFromProjectLocationInsightTypeName(projectLocationInsightTypeName: string): string | number;

Parse the insight_type from ProjectLocationInsightType resource.

Parameter

Name	Description
projectLocationInsightTypeName	`string` A fully-qualified path representing project_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the insight_type.

matchLocationFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName)

matchLocationFromBillingAccountLocationInsightTypeInsightName(billingAccountLocationInsightTypeInsightName: string): string | number;

Parse the location from BillingAccountLocationInsightTypeInsight resource.

Parameter

Name	Description
billingAccountLocationInsightTypeInsightName	`string` A fully-qualified path representing billing_account_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName)

matchLocationFromBillingAccountLocationInsightTypeName(billingAccountLocationInsightTypeName: string): string | number;

Parse the location from BillingAccountLocationInsightType resource.

Parameter

Name	Description
billingAccountLocationInsightTypeName	`string` A fully-qualified path representing billing_account_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName)

matchLocationFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName: string): string | number;

Parse the location from BillingAccountLocationRecommender resource.

Parameter

Name	Description
billingAccountLocationRecommenderName	`string` A fully-qualified path representing billing_account_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)

matchLocationFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName: string): string | number;

Parse the location from BillingAccountLocationRecommenderRecommendation resource.

Parameter

Name	Description
billingAccountLocationRecommenderRecommendationName	`string` A fully-qualified path representing billing_account_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName)

matchLocationFromFolderLocationInsightTypeInsightName(folderLocationInsightTypeInsightName: string): string | number;

Parse the location from FolderLocationInsightTypeInsight resource.

Parameter

Name	Description
folderLocationInsightTypeInsightName	`string` A fully-qualified path representing folder_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFolderLocationInsightTypeName(folderLocationInsightTypeName)

matchLocationFromFolderLocationInsightTypeName(folderLocationInsightTypeName: string): string | number;

Parse the location from FolderLocationInsightType resource.

Parameter

Name	Description
folderLocationInsightTypeName	`string` A fully-qualified path representing folder_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFolderLocationRecommenderName(folderLocationRecommenderName)

matchLocationFromFolderLocationRecommenderName(folderLocationRecommenderName: string): string | number;

Parse the location from FolderLocationRecommender resource.

Parameter

Name	Description
folderLocationRecommenderName	`string` A fully-qualified path representing folder_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)

matchLocationFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName: string): string | number;

Parse the location from FolderLocationRecommenderRecommendation resource.

Parameter

Name	Description
folderLocationRecommenderRecommendationName	`string` A fully-qualified path representing folder_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)

matchLocationFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName: string): string | number;

Parse the location from OrganizationLocationInsightTypeInsight resource.

Parameter

Name	Description
organizationLocationInsightTypeInsightName	`string` A fully-qualified path representing organization_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName)

matchLocationFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName: string): string | number;

Parse the location from OrganizationLocationInsightType resource.

Parameter

Name	Description
organizationLocationInsightTypeName	`string` A fully-qualified path representing organization_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromOrganizationLocationRecommenderName(organizationLocationRecommenderName)

matchLocationFromOrganizationLocationRecommenderName(organizationLocationRecommenderName: string): string | number;

Parse the location from OrganizationLocationRecommender resource.

Parameter

Name	Description
organizationLocationRecommenderName	`string` A fully-qualified path representing organization_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)

matchLocationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName: string): string | number;

Parse the location from OrganizationLocationRecommenderRecommendation resource.

Parameter

Name	Description
organizationLocationRecommenderRecommendationName	`string` A fully-qualified path representing organization_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)

matchLocationFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName: string): string | number;

Parse the location from ProjectLocationInsightTypeInsight resource.

Parameter

Name	Description
projectLocationInsightTypeInsightName	`string` A fully-qualified path representing project_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationInsightTypeName(projectLocationInsightTypeName)

matchLocationFromProjectLocationInsightTypeName(projectLocationInsightTypeName: string): string | number;

Parse the location from ProjectLocationInsightType resource.

Parameter

Name	Description
projectLocationInsightTypeName	`string` A fully-qualified path representing project_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationRecommenderName(projectLocationRecommenderName)

matchLocationFromProjectLocationRecommenderName(projectLocationRecommenderName: string): string | number;

Parse the location from ProjectLocationRecommender resource.

Parameter

Name	Description
projectLocationRecommenderName	`string` A fully-qualified path representing project_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchLocationFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)

matchLocationFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName: string): string | number;

Parse the location from ProjectLocationRecommenderRecommendation resource.

Parameter

Name	Description
projectLocationRecommenderRecommendationName	`string` A fully-qualified path representing project_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the location.

matchOrganizationFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName)

matchOrganizationFromOrganizationLocationInsightTypeInsightName(organizationLocationInsightTypeInsightName: string): string | number;

Parse the organization from OrganizationLocationInsightTypeInsight resource.

Parameter

Name	Description
organizationLocationInsightTypeInsightName	`string` A fully-qualified path representing organization_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchOrganizationFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName)

matchOrganizationFromOrganizationLocationInsightTypeName(organizationLocationInsightTypeName: string): string | number;

Parse the organization from OrganizationLocationInsightType resource.

Parameter

Name	Description
organizationLocationInsightTypeName	`string` A fully-qualified path representing organization_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchOrganizationFromOrganizationLocationRecommenderName(organizationLocationRecommenderName)

matchOrganizationFromOrganizationLocationRecommenderName(organizationLocationRecommenderName: string): string | number;

Parse the organization from OrganizationLocationRecommender resource.

Parameter

Name	Description
organizationLocationRecommenderName	`string` A fully-qualified path representing organization_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchOrganizationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)

matchOrganizationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName: string): string | number;

Parse the organization from OrganizationLocationRecommenderRecommendation resource.

Parameter

Name	Description
organizationLocationRecommenderRecommendationName	`string` A fully-qualified path representing organization_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the organization.

matchProjectFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName)

matchProjectFromProjectLocationInsightTypeInsightName(projectLocationInsightTypeInsightName: string): string | number;

Parse the project from ProjectLocationInsightTypeInsight resource.

Parameter

Name	Description
projectLocationInsightTypeInsightName	`string` A fully-qualified path representing project_location_insight_type_insight resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationInsightTypeName(projectLocationInsightTypeName)

matchProjectFromProjectLocationInsightTypeName(projectLocationInsightTypeName: string): string | number;

Parse the project from ProjectLocationInsightType resource.

Parameter

Name	Description
projectLocationInsightTypeName	`string` A fully-qualified path representing project_location_insight_type resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationRecommenderName(projectLocationRecommenderName)

matchProjectFromProjectLocationRecommenderName(projectLocationRecommenderName: string): string | number;

Parse the project from ProjectLocationRecommender resource.

Parameter

Name	Description
projectLocationRecommenderName	`string` A fully-qualified path representing project_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchProjectFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)

matchProjectFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName: string): string | number;

Parse the project from ProjectLocationRecommenderRecommendation resource.

Parameter

Name	Description
projectLocationRecommenderRecommendationName	`string` A fully-qualified path representing project_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the project.

matchRecommendationFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)

matchRecommendationFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName: string): string | number;

Parse the recommendation from BillingAccountLocationRecommenderRecommendation resource.

Parameter

Name	Description
billingAccountLocationRecommenderRecommendationName	`string` A fully-qualified path representing billing_account_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommendation.

matchRecommendationFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)

matchRecommendationFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName: string): string | number;

Parse the recommendation from FolderLocationRecommenderRecommendation resource.

Parameter

Name	Description
folderLocationRecommenderRecommendationName	`string` A fully-qualified path representing folder_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommendation.

matchRecommendationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)

matchRecommendationFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName: string): string | number;

Parse the recommendation from OrganizationLocationRecommenderRecommendation resource.

Parameter

Name	Description
organizationLocationRecommenderRecommendationName	`string` A fully-qualified path representing organization_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommendation.

matchRecommendationFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)

matchRecommendationFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName: string): string | number;

Parse the recommendation from ProjectLocationRecommenderRecommendation resource.

Parameter

Name	Description
projectLocationRecommenderRecommendationName	`string` A fully-qualified path representing project_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommendation.

matchRecommenderFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName)

matchRecommenderFromBillingAccountLocationRecommenderName(billingAccountLocationRecommenderName: string): string | number;

Parse the recommender from BillingAccountLocationRecommender resource.

Parameter

Name	Description
billingAccountLocationRecommenderName	`string` A fully-qualified path representing billing_account_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

matchRecommenderFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName)

matchRecommenderFromBillingAccountLocationRecommenderRecommendationName(billingAccountLocationRecommenderRecommendationName: string): string | number;

Parse the recommender from BillingAccountLocationRecommenderRecommendation resource.

Parameter

Name	Description
billingAccountLocationRecommenderRecommendationName	`string` A fully-qualified path representing billing_account_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

matchRecommenderFromFolderLocationRecommenderName(folderLocationRecommenderName)

matchRecommenderFromFolderLocationRecommenderName(folderLocationRecommenderName: string): string | number;

Parse the recommender from FolderLocationRecommender resource.

Parameter

Name	Description
folderLocationRecommenderName	`string` A fully-qualified path representing folder_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

matchRecommenderFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName)

matchRecommenderFromFolderLocationRecommenderRecommendationName(folderLocationRecommenderRecommendationName: string): string | number;

Parse the recommender from FolderLocationRecommenderRecommendation resource.

Parameter

Name	Description
folderLocationRecommenderRecommendationName	`string` A fully-qualified path representing folder_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

matchRecommenderFromOrganizationLocationRecommenderName(organizationLocationRecommenderName)

matchRecommenderFromOrganizationLocationRecommenderName(organizationLocationRecommenderName: string): string | number;

Parse the recommender from OrganizationLocationRecommender resource.

Parameter

Name	Description
organizationLocationRecommenderName	`string` A fully-qualified path representing organization_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

matchRecommenderFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName)

matchRecommenderFromOrganizationLocationRecommenderRecommendationName(organizationLocationRecommenderRecommendationName: string): string | number;

Parse the recommender from OrganizationLocationRecommenderRecommendation resource.

Parameter

Name	Description
organizationLocationRecommenderRecommendationName	`string` A fully-qualified path representing organization_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

matchRecommenderFromProjectLocationRecommenderName(projectLocationRecommenderName)

matchRecommenderFromProjectLocationRecommenderName(projectLocationRecommenderName: string): string | number;

Parse the recommender from ProjectLocationRecommender resource.

Parameter

Name	Description
projectLocationRecommenderName	`string` A fully-qualified path representing project_location_recommender resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

matchRecommenderFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName)

matchRecommenderFromProjectLocationRecommenderRecommendationName(projectLocationRecommenderRecommendationName: string): string | number;

Parse the recommender from ProjectLocationRecommenderRecommendation resource.

Parameter

Name	Description
projectLocationRecommenderRecommendationName	`string` A fully-qualified path representing project_location_recommender_recommendation resource.

Returns

Type	Description
string \| number	{string} A string representing the recommender.

organizationLocationInsightTypeInsightPath(organization, location, insightType, insight)

organizationLocationInsightTypeInsightPath(organization: string, location: string, insightType: string, insight: string): string;

Return a fully-qualified organizationLocationInsightTypeInsight resource name string.

Parameters

Name	Description
organization	`string`
location	`string`
insightType	`string`
insight	`string`

Returns

Type	Description
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.

Parameters

Name	Description
organization	`string`
location	`string`
insightType	`string`

Returns

Type	Description
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.

Parameters

Name	Description
organization	`string`
location	`string`
recommender	`string`

Returns

Type	Description
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.

Parameters

Name	Description
organization	`string`
location	`string`
recommender	`string`
recommendation	`string`

Returns

Type	Description
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.

Parameters

Name	Description
project	`string`
location	`string`
insightType	`string`
insight	`string`

Returns

Type	Description
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.

Parameters

Name	Description
project	`string`
location	`string`
insightType	`string`

Returns

Type	Description
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.

Parameters

Name	Description
project	`string`
location	`string`
recommender	`string`

Returns

Type	Description
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.

Parameters

Name	Description
project	`string`
location	`string`
recommender	`string`
recommendation	`string`

Returns

Type	Description
string	{string} Resource name string.