Class v1beta1.RecommenderClient (7.1.0)

Version latest

• 7.1.0 (latest)
• 7.0.1
• 6.1.1
• 5.0.6
• 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. v1beta1

Package

@google-cloud/recommender

Constructors

(constructor)(opts, gaxInstance)

constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);

Construct an instance of RecommenderClient.

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

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.v1beta1.IGetInsightRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IInsight,
        protos.google.cloud.recommender.v1beta1.IGetInsightRequest | undefined,
        {} | undefined
    ]>;

Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type.

Parameters
Name	Description
request	IGetInsightRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IGetInsightRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IGetInsightRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetInsightRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IGetInsightRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getInsight(request, callback)

getInsight(request: protos.google.cloud.recommender.v1beta1.IGetInsightRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IGetInsightRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetInsightRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IGetInsightRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getInsightTypeConfig(request, options)

getInsightTypeConfig(request?: protos.google.cloud.recommender.v1beta1.IGetInsightTypeConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IInsightTypeConfig,
        (protos.google.cloud.recommender.v1beta1.IGetInsightTypeConfigRequest | undefined),
        {} | undefined
    ]>;

Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType.

Parameters
Name	Description
request	IGetInsightTypeConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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/global/recommenders/[INSIGHT_TYPE_ID]/config`
   *  * `projects/[PROJECT_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`
   *  * `organizations/[ORGANIZATION_ID]/locations/global/recommenders/[INSIGHT_TYPE_ID]/config`
   */
  // const name = 'abc123'

  // Imports the Recommender library
  const {RecommenderClient} = require('@google-cloud/recommender').v1beta1;

  // 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.v1beta1.IGetInsightTypeConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IGetInsightTypeConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetInsightTypeConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IGetInsightTypeConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getInsightTypeConfig(request, callback)

getInsightTypeConfig(request: protos.google.cloud.recommender.v1beta1.IGetInsightTypeConfigRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IGetInsightTypeConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetInsightTypeConfigRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IGetInsightTypeConfigRequest | 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.v1beta1.IGetRecommendationRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommendation,
        (protos.google.cloud.recommender.v1beta1.IGetRecommendationRequest | undefined),
        {} | undefined
    ]>;

Gets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender.

Parameters
Name	Description
request	IGetRecommendationRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommendation, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IGetRecommendationRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IGetRecommendationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRecommendationRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IGetRecommendationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRecommendation(request, callback)

getRecommendation(request: protos.google.cloud.recommender.v1beta1.IGetRecommendationRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IGetRecommendationRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRecommendationRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IGetRecommendationRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRecommenderConfig(request, options)

getRecommenderConfig(request?: protos.google.cloud.recommender.v1beta1.IGetRecommenderConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommenderConfig,
        (protos.google.cloud.recommender.v1beta1.IGetRecommenderConfigRequest | undefined),
        {} | undefined
    ]>;

Gets the requested Recommender Config. There is only one instance of the config for each Recommender.

Parameters
Name	Description
request	IGetRecommenderConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommenderConfig, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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`
   */
  // const name = 'abc123'

  // Imports the Recommender library
  const {RecommenderClient} = require('@google-cloud/recommender').v1beta1;

  // 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.v1beta1.IGetRecommenderConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IGetRecommenderConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRecommenderConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IGetRecommenderConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

getRecommenderConfig(request, callback)

getRecommenderConfig(request: protos.google.cloud.recommender.v1beta1.IGetRecommenderConfigRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IGetRecommenderConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IGetRecommenderConfigRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IGetRecommenderConfigRequest | 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.

insightTypePath(insightType)

insightTypePath(insightType: string): string;

Return a fully-qualified insightType resource name string.

Parameter
Name	Description
insightType	string

Returns
Type	Description
string	{string} Resource name string.

listInsights(request, options)

listInsights(request?: protos.google.cloud.recommender.v1beta1.IListInsightsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IInsight[],
        protos.google.cloud.recommender.v1beta1.IListInsightsRequest | null,
        protos.google.cloud.recommender.v1beta1.IListInsightsResponse
    ]>;

Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type.

Parameters
Name	Description
request	IListInsightsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IInsight[], protos.google.cloud.recommender.v1beta1.IListInsightsRequest | null, protos.google.cloud.recommender.v1beta1.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.v1beta1.IListInsightsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightsRequest, protos.google.cloud.recommender.v1beta1.IListInsightsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsight>): void;

Parameters
Name	Description
request	IListInsightsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightsRequest, protos.google.cloud.recommender.v1beta1.IListInsightsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsight>

Returns
Type	Description
void

listInsights(request, callback)

listInsights(request: protos.google.cloud.recommender.v1beta1.IListInsightsRequest, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightsRequest, protos.google.cloud.recommender.v1beta1.IListInsightsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsight>): void;

Parameters
Name	Description
request	IListInsightsRequest
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightsRequest, protos.google.cloud.recommender.v1beta1.IListInsightsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsight>

Returns
Type	Description
void

listInsightsAsync(request, options)

listInsightsAsync(request?: protos.google.cloud.recommender.v1beta1.IListInsightsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recommender.v1beta1.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	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.v1beta1.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.

Example

  /**
   * 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`
   *  Examples:
   *  * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
   *  * `insightSubtype = PERMISSIONS_USAGE`
   *  * `severity = CRITICAL OR severity = HIGH`
   *  * `stateInfo.state = ACTIVE AND (severity = CRITICAL OR severity = HIGH)`
   *  (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').v1beta1;

  // 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.v1beta1.IListInsightsRequest, options?: CallOptions): Transform;

Equivalent to listInsights, but returns a NodeJS Stream object.

Parameters
Name	Description
request	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 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.

listInsightTypes(request, options)

listInsightTypes(request?: protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IInsightType[],
        protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest | null,
        protos.google.cloud.recommender.v1beta1.IListInsightTypesResponse
    ]>;

Lists available InsightTypes. No IAM permissions are required.

Parameters
Name	Description
request	IListInsightTypesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IInsightType[], protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest | null, protos.google.cloud.recommender.v1beta1.IListInsightTypesResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of InsightType. 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 listInsightTypesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listInsightTypes(request, options, callback)

listInsightTypes(request: protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, protos.google.cloud.recommender.v1beta1.IListInsightTypesResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsightType>): void;

Parameters
Name	Description
request	IListInsightTypesRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, protos.google.cloud.recommender.v1beta1.IListInsightTypesResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsightType>

Returns
Type	Description
void

listInsightTypes(request, callback)

listInsightTypes(request: protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, protos.google.cloud.recommender.v1beta1.IListInsightTypesResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsightType>): void;

Parameters
Name	Description
request	IListInsightTypesRequest
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, protos.google.cloud.recommender.v1beta1.IListInsightTypesResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IInsightType>

Returns
Type	Description
void

listInsightTypesAsync(request, options)

listInsightTypesAsync(request?: protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recommender.v1beta1.IInsightType>;

Equivalent to listInsightTypes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListInsightTypesRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.recommender.v1beta1.IInsightType>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing InsightType. 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.

Example

  /**
   * 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.
   */
  /**
   *  The number of InsightTypes to return per page. The service may return
   *  fewer than this value.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListRecommenders` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Recommender library
  const {RecommenderClient} = require('@google-cloud/recommender').v1beta1;

  // Instantiates a client
  const recommenderClient = new RecommenderClient();

  async function callListInsightTypes() {
    // Construct request
    const request = {
    };

    // Run request
    const iterable = recommenderClient.listInsightTypesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListInsightTypes();

listInsightTypesStream(request, options)

listInsightTypesStream(request?: protos.google.cloud.recommender.v1beta1.IListInsightTypesRequest, options?: CallOptions): Transform;

Equivalent to listInsightTypes, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListInsightTypesRequest 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 InsightType 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 listInsightTypesAsync() 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.v1beta1.IListRecommendationsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommendation[],
        protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest | null,
        protos.google.cloud.recommender.v1beta1.IListRecommendationsResponse
    ]>;

Lists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender.

Parameters
Name	Description
request	IListRecommendationsRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommendation[], protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest | null, protos.google.cloud.recommender.v1beta1.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.v1beta1.IListRecommendationsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest, protos.google.cloud.recommender.v1beta1.IListRecommendationsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommendation>): void;

Parameters
Name	Description
request	IListRecommendationsRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest, protos.google.cloud.recommender.v1beta1.IListRecommendationsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommendation>

Returns
Type	Description
void

listRecommendations(request, callback)

listRecommendations(request: protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest, protos.google.cloud.recommender.v1beta1.IListRecommendationsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommendation>): void;

Parameters
Name	Description
request	IListRecommendationsRequest
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest, protos.google.cloud.recommender.v1beta1.IListRecommendationsResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommendation>

Returns
Type	Description
void

listRecommendationsAsync(request, options)

listRecommendationsAsync(request?: protos.google.cloud.recommender.v1beta1.IListRecommendationsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recommender.v1beta1.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	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.v1beta1.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.

Example

  /**
   * 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`
   *  Examples:
   *  * `stateInfo.state = ACTIVE OR stateInfo.state = DISMISSED`
   *  * `recommenderSubtype = REMOVE_ROLE OR recommenderSubtype = REPLACE_ROLE`
   *  * `priority = P1 OR priority = P2`
   *  * `stateInfo.state = ACTIVE AND (priority = P1 OR priority = P2)`
   *  (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').v1beta1;

  // 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.v1beta1.IListRecommendationsRequest, options?: CallOptions): Transform;

Equivalent to listRecommendations, but returns a NodeJS Stream object.

Parameters
Name	Description
request	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 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.

listRecommenders(request, options)

listRecommenders(request?: protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommenderType[],
        protos.google.cloud.recommender.v1beta1.IListRecommendersRequest | null,
        protos.google.cloud.recommender.v1beta1.IListRecommendersResponse
    ]>;

Lists all available Recommenders. No IAM permissions are required.

Parameters
Name	Description
request	IListRecommendersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommenderType[], protos.google.cloud.recommender.v1beta1.IListRecommendersRequest | null, protos.google.cloud.recommender.v1beta1.IListRecommendersResponse ]>	{Promise} - The promise which resolves to an array. The first element of the array is Array of RecommenderType. 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 listRecommendersAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listRecommenders(request, options, callback)

listRecommenders(request: protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, protos.google.cloud.recommender.v1beta1.IListRecommendersResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommenderType>): void;

Parameters
Name	Description
request	IListRecommendersRequest
options	CallOptions
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, protos.google.cloud.recommender.v1beta1.IListRecommendersResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommenderType>

Returns
Type	Description
void

listRecommenders(request, callback)

listRecommenders(request: protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, callback: PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, protos.google.cloud.recommender.v1beta1.IListRecommendersResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommenderType>): void;

Parameters
Name	Description
request	IListRecommendersRequest
callback	PaginationCallback<protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, protos.google.cloud.recommender.v1beta1.IListRecommendersResponse | null | undefined, protos.google.cloud.recommender.v1beta1.IRecommenderType>

Returns
Type	Description
void

listRecommendersAsync(request, options)

listRecommendersAsync(request?: protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.recommender.v1beta1.IRecommenderType>;

Equivalent to listRecommenders, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name	Description
request	IListRecommendersRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
AsyncIterable<protos.google.cloud.recommender.v1beta1.IRecommenderType>	{Object} An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing RecommenderType. 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.

Example

  /**
   * 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.
   */
  /**
   *  The number of RecommenderTypes to return per page. The service may return
   *  fewer than this value.
   */
  // const pageSize = 1234
  /**
   *  A page token, received from a previous `ListRecommenders` call.
   *  Provide this to retrieve the subsequent page.
   */
  // const pageToken = 'abc123'

  // Imports the Recommender library
  const {RecommenderClient} = require('@google-cloud/recommender').v1beta1;

  // Instantiates a client
  const recommenderClient = new RecommenderClient();

  async function callListRecommenders() {
    // Construct request
    const request = {
    };

    // Run request
    const iterable = recommenderClient.listRecommendersAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListRecommenders();

listRecommendersStream(request, options)

listRecommendersStream(request?: protos.google.cloud.recommender.v1beta1.IListRecommendersRequest, options?: CallOptions): Transform;

Equivalent to listRecommenders, but returns a NodeJS Stream object.

Parameters
Name	Description
request	IListRecommendersRequest 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 RecommenderType 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 listRecommendersAsync() 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.v1beta1.IMarkInsightAcceptedRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IInsight,
        (protos.google.cloud.recommender.v1beta1.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.

Parameters
Name	Description
request	IMarkInsightAcceptedRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IInsight, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IMarkInsightAcceptedRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IMarkInsightAcceptedRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkInsightAcceptedRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IMarkInsightAcceptedRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

markInsightAccepted(request, callback)

markInsightAccepted(request: protos.google.cloud.recommender.v1beta1.IMarkInsightAcceptedRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IMarkInsightAcceptedRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkInsightAcceptedRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsight, protos.google.cloud.recommender.v1beta1.IMarkInsightAcceptedRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

markRecommendationClaimed(request, options)

markRecommendationClaimed(request?: protos.google.cloud.recommender.v1beta1.IMarkRecommendationClaimedRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommendation,
        (protos.google.cloud.recommender.v1beta1.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 or ACTIVE state.

Requires the recommender.*.update IAM permission for the specified recommender.

Parameters
Name	Description
request	IMarkRecommendationClaimedRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommendation, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IMarkRecommendationClaimedRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationClaimedRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkRecommendationClaimedRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationClaimedRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

markRecommendationClaimed(request, callback)

markRecommendationClaimed(request: protos.google.cloud.recommender.v1beta1.IMarkRecommendationClaimedRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationClaimedRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkRecommendationClaimedRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationClaimedRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

markRecommendationFailed(request, options)

markRecommendationFailed(request?: protos.google.cloud.recommender.v1beta1.IMarkRecommendationFailedRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommendation,
        (protos.google.cloud.recommender.v1beta1.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.

Parameters
Name	Description
request	IMarkRecommendationFailedRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommendation, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IMarkRecommendationFailedRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationFailedRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkRecommendationFailedRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationFailedRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

markRecommendationFailed(request, callback)

markRecommendationFailed(request: protos.google.cloud.recommender.v1beta1.IMarkRecommendationFailedRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationFailedRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkRecommendationFailedRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationFailedRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

markRecommendationSucceeded(request, options)

markRecommendationSucceeded(request?: protos.google.cloud.recommender.v1beta1.IMarkRecommendationSucceededRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommendation,
        (protos.google.cloud.recommender.v1beta1.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.

Parameters
Name	Description
request	IMarkRecommendationSucceededRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommendation, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IMarkRecommendationSucceededRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationSucceededRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkRecommendationSucceededRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationSucceededRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

markRecommendationSucceeded(request, callback)

markRecommendationSucceeded(request: protos.google.cloud.recommender.v1beta1.IMarkRecommendationSucceededRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.IMarkRecommendationSucceededRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IMarkRecommendationSucceededRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommendation, protos.google.cloud.recommender.v1beta1.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.

matchInsightTypeFromInsightTypeName(insightTypeName)

matchInsightTypeFromInsightTypeName(insightTypeName: string): string | number;

Parse the insight_type from InsightType resource.

Parameter
Name	Description
insightTypeName	string A fully-qualified path representing insight_type resource.

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

matchInsightTypeFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName)

matchInsightTypeFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName: string): string | number;

Parse the insight_type from OrganizationLocationInsightTypeConfig resource.

Parameter
Name	Description
organizationLocationInsightTypeConfigName	string A fully-qualified path representing organization_location_insight_type_config 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.

matchInsightTypeFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName)

matchInsightTypeFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName: string): string | number;

Parse the insight_type from ProjectLocationInsightTypeConfig resource.

Parameter
Name	Description
projectLocationInsightTypeConfigName	string A fully-qualified path representing project_location_insight_type_config 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.

matchLocationFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName)

matchLocationFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName: string): string | number;

Parse the location from OrganizationLocationInsightTypeConfig resource.

Parameter
Name	Description
organizationLocationInsightTypeConfigName	string A fully-qualified path representing organization_location_insight_type_config 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.

matchLocationFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName)

matchLocationFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName: string): string | number;

Parse the location from OrganizationLocationRecommenderConfig resource.

Parameter
Name	Description
organizationLocationRecommenderConfigName	string A fully-qualified path representing organization_location_recommender_config 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.

matchLocationFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName)

matchLocationFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName: string): string | number;

Parse the location from ProjectLocationInsightTypeConfig resource.

Parameter
Name	Description
projectLocationInsightTypeConfigName	string A fully-qualified path representing project_location_insight_type_config 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.

matchLocationFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName)

matchLocationFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName: string): string | number;

Parse the location from ProjectLocationRecommenderConfig resource.

Parameter
Name	Description
projectLocationRecommenderConfigName	string A fully-qualified path representing project_location_recommender_config 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.

matchOrganizationFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName)

matchOrganizationFromOrganizationLocationInsightTypeConfigName(organizationLocationInsightTypeConfigName: string): string | number;

Parse the organization from OrganizationLocationInsightTypeConfig resource.

Parameter
Name	Description
organizationLocationInsightTypeConfigName	string A fully-qualified path representing organization_location_insight_type_config resource.

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

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.

matchOrganizationFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName)

matchOrganizationFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName: string): string | number;

Parse the organization from OrganizationLocationRecommenderConfig resource.

Parameter
Name	Description
organizationLocationRecommenderConfigName	string A fully-qualified path representing organization_location_recommender_config 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.

matchProjectFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName)

matchProjectFromProjectLocationInsightTypeConfigName(projectLocationInsightTypeConfigName: string): string | number;

Parse the project from ProjectLocationInsightTypeConfig resource.

Parameter
Name	Description
projectLocationInsightTypeConfigName	string A fully-qualified path representing project_location_insight_type_config resource.

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

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.

matchProjectFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName)

matchProjectFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName: string): string | number;

Parse the project from ProjectLocationRecommenderConfig resource.

Parameter
Name	Description
projectLocationRecommenderConfigName	string A fully-qualified path representing project_location_recommender_config 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.

matchRecommenderFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName)

matchRecommenderFromOrganizationLocationRecommenderConfigName(organizationLocationRecommenderConfigName: string): string | number;

Parse the recommender from OrganizationLocationRecommenderConfig resource.

Parameter
Name	Description
organizationLocationRecommenderConfigName	string A fully-qualified path representing organization_location_recommender_config 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.

matchRecommenderFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName)

matchRecommenderFromProjectLocationRecommenderConfigName(projectLocationRecommenderConfigName: string): string | number;

Parse the recommender from ProjectLocationRecommenderConfig resource.

Parameter
Name	Description
projectLocationRecommenderConfigName	string A fully-qualified path representing project_location_recommender_config 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.

matchRecommenderFromRecommenderName(recommenderName)

matchRecommenderFromRecommenderName(recommenderName: string): string | number;

Parse the recommender from Recommender resource.

Parameter
Name	Description
recommenderName	string A fully-qualified path representing recommender resource.

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

Parameters
Name	Description
organization	string
location	string
insightType	string

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

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.

organizationLocationRecommenderConfigPath(organization, location, recommender)

organizationLocationRecommenderConfigPath(organization: string, location: string, recommender: string): string;

Return a fully-qualified organizationLocationRecommenderConfig resource name string.

Parameters
Name	Description
organization	string
location	string
recommender	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.

projectLocationInsightTypeConfigPath(project, location, insightType)

projectLocationInsightTypeConfigPath(project: string, location: string, insightType: string): string;

Return a fully-qualified projectLocationInsightTypeConfig resource name string.

Parameters
Name	Description
project	string
location	string
insightType	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.

projectLocationRecommenderConfigPath(project, location, recommender)

projectLocationRecommenderConfigPath(project: string, location: string, recommender: string): string;

Return a fully-qualified projectLocationRecommenderConfig resource name string.

Parameters
Name	Description
project	string
location	string
recommender	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.

recommenderPath(recommender)

recommenderPath(recommender: string): string;

Return a fully-qualified recommender resource name string.

Parameter
Name	Description
recommender	string

Returns
Type	Description
string	{string} Resource name string.

updateInsightTypeConfig(request, options)

updateInsightTypeConfig(request?: protos.google.cloud.recommender.v1beta1.IUpdateInsightTypeConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IInsightTypeConfig,
        (protos.google.cloud.recommender.v1beta1.IUpdateInsightTypeConfigRequest | undefined),
        {} | undefined
    ]>;

Updates an InsightTypeConfig change. This will create a new revision of the config.

Parameters
Name	Description
request	IUpdateInsightTypeConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IUpdateInsightTypeConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IUpdateInsightTypeConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateInsightTypeConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IUpdateInsightTypeConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateInsightTypeConfig(request, callback)

updateInsightTypeConfig(request: protos.google.cloud.recommender.v1beta1.IUpdateInsightTypeConfigRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IUpdateInsightTypeConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateInsightTypeConfigRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IInsightTypeConfig, protos.google.cloud.recommender.v1beta1.IUpdateInsightTypeConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateRecommenderConfig(request, options)

updateRecommenderConfig(request?: protos.google.cloud.recommender.v1beta1.IUpdateRecommenderConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.recommender.v1beta1.IRecommenderConfig,
        (protos.google.cloud.recommender.v1beta1.IUpdateRecommenderConfigRequest | undefined),
        {} | undefined
    ]>;

Updates a Recommender Config. This will create a new revision of the config.

Parameters
Name	Description
request	IUpdateRecommenderConfigRequest The request object that will be sent.
options	CallOptions Call options. See CallOptions for more details.

Returns
Type	Description
Promise<[ protos.google.cloud.recommender.v1beta1.IRecommenderConfig, (protos.google.cloud.recommender.v1beta1.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.

Example

  /**
   * 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').v1beta1;

  // 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.v1beta1.IUpdateRecommenderConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IUpdateRecommenderConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateRecommenderConfigRequest
options	CallOptions
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IUpdateRecommenderConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void

updateRecommenderConfig(request, callback)

updateRecommenderConfig(request: protos.google.cloud.recommender.v1beta1.IUpdateRecommenderConfigRequest, callback: Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IUpdateRecommenderConfigRequest | null | undefined, {} | null | undefined>): void;

Parameters
Name	Description
request	IUpdateRecommenderConfigRequest
callback	Callback<protos.google.cloud.recommender.v1beta1.IRecommenderConfig, protos.google.cloud.recommender.v1beta1.IUpdateRecommenderConfigRequest | null | undefined, {} | null | undefined>

Returns
Type	Description
void