Class v2alpha.ProjectServiceClient (3.6.0)

Service for settings at Project level. v2alpha

Package

@google-cloud/retail

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of ProjectServiceClient.

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 ProjectServiceClient({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;
    };

locationsClient

locationsClient: LocationsClient;

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

port

static get port(): number;

The port for this API service.

projectServiceStub

projectServiceStub?: 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

acceptTerms(request, options)

acceptTerms(request?: protos.google.cloud.retail.v2alpha.IAcceptTermsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.IProject,
        protos.google.cloud.retail.v2alpha.IAcceptTermsRequest | undefined,
        {} | undefined
    ]>;

Accepts service terms for this project. By making requests to this API, you agree to the terms of service linked below. https://cloud.google.com/retail/data-use-terms

Parameters
Name Description
request IAcceptTermsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IAcceptTermsRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Project. 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. Full resource name of the project. Format:
   *  `projects/{project_number_or_id}/retailProject`
   */
  // const project = 'my-project'

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callAcceptTerms() {
    // Construct request
    const request = {
      project,
    };

    // Run request
    const response = await retailClient.acceptTerms(request);
    console.log(response);
  }

  callAcceptTerms();

acceptTerms(request, options, callback)

acceptTerms(request: protos.google.cloud.retail.v2alpha.IAcceptTermsRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IAcceptTermsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IAcceptTermsRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IAcceptTermsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

acceptTerms(request, callback)

acceptTerms(request: protos.google.cloud.retail.v2alpha.IAcceptTermsRequest, callback: Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IAcceptTermsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IAcceptTermsRequest
callback Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IAcceptTermsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

alertConfigPath(project)

alertConfigPath(project: string): string;

Return a fully-qualified alertConfig resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

attributesConfigPath(project, location, catalog)

attributesConfigPath(project: string, location: string, catalog: string): string;

Return a fully-qualified attributesConfig resource name string.

Parameters
Name Description
project string
location string
catalog string
Returns
Type Description
string

{string} Resource name string.

branchPath(project, location, catalog, branch)

branchPath(project: string, location: string, catalog: string, branch: string): string;

Return a fully-qualified branch resource name string.

Parameters
Name Description
project string
location string
catalog string
branch string
Returns
Type Description
string

{string} Resource name string.

cancelOperation(request, options, callback)

cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an value with a of 1, corresponding to Code.CANCELLED.

Parameters
Name Description
request CancelOperationRequest

The request object that will be sent.
options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example 

const client = longrunning.operationsClient();
await client.cancelOperation({name: ''});

catalogPath(project, location, catalog)

catalogPath(project: string, location: string, catalog: string): string;

Return a fully-qualified catalog resource name string.

Parameters
Name Description
project string
location string
catalog string
Returns
Type Description
string

{string} Resource name string.

checkEnrollSolutionProgress(name)

checkEnrollSolutionProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2alpha.EnrollSolutionResponse, protos.google.cloud.retail.v2alpha.EnrollSolutionMetadata>>;

Check the status of the long running operation returned by enrollSolution().

Parameter
Name Description
name string

The operation name that will be passed.
Returns
Type Description
Promise<LROperation<protos.google.cloud.retail.v2alpha.EnrollSolutionResponse, protos.google.cloud.retail.v2alpha.EnrollSolutionMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. 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. Full resource name of parent. Format:
   *  `projects/{project_number_or_id}`
   */
  // const project = 'my-project'
  /**
   *  Required. Solution to enroll.
   */
  // const solution = {}

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callEnrollSolution() {
    // Construct request
    const request = {
      project,
      solution,
    };

    // Run request
    const [operation] = await retailClient.enrollSolution(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callEnrollSolution();

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.

completionConfigPath(project, location, catalog)

completionConfigPath(project: string, location: string, catalog: string): string;

Return a fully-qualified completionConfig resource name string.

Parameters
Name Description
project string
location string
catalog string
Returns
Type Description
string

{string} Resource name string.

controlPath(project, location, catalog, control)

controlPath(project: string, location: string, catalog: string, control: string): string;

Return a fully-qualified control resource name string.

Parameters
Name Description
project string
location string
catalog string
control string
Returns
Type Description
string

{string} Resource name string.

deleteOperation(request, options, callback)

deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters
Name Description
request DeleteOperationRequest

The request object that will be sent.
options CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call. {Promise} - The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<protos.google.protobuf.Empty>
Example 

const client = longrunning.operationsClient();
await client.deleteOperation({name: ''});

enrollSolution(request, options)

enrollSolution(request?: protos.google.cloud.retail.v2alpha.IEnrollSolutionRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2alpha.IEnrollSolutionResponse, protos.google.cloud.retail.v2alpha.IEnrollSolutionMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

The method enrolls a solution of type [Retail Search][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_SEARCH] into a project.

The [Recommendations AI solution type][google.cloud.retail.v2alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION] is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.

Parameters
Name Description
request IEnrollSolutionRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ LROperation<protos.google.cloud.retail.v2alpha.IEnrollSolutionResponse, protos.google.cloud.retail.v2alpha.IEnrollSolutionMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. 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. Full resource name of parent. Format:
   *  `projects/{project_number_or_id}`
   */
  // const project = 'my-project'
  /**
   *  Required. Solution to enroll.
   */
  // const solution = {}

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callEnrollSolution() {
    // Construct request
    const request = {
      project,
      solution,
    };

    // Run request
    const [operation] = await retailClient.enrollSolution(request);
    const [response] = await operation.promise();
    console.log(response);
  }

  callEnrollSolution();

enrollSolution(request, options, callback)

enrollSolution(request: protos.google.cloud.retail.v2alpha.IEnrollSolutionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2alpha.IEnrollSolutionResponse, protos.google.cloud.retail.v2alpha.IEnrollSolutionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IEnrollSolutionRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.retail.v2alpha.IEnrollSolutionResponse, protos.google.cloud.retail.v2alpha.IEnrollSolutionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

enrollSolution(request, callback)

enrollSolution(request: protos.google.cloud.retail.v2alpha.IEnrollSolutionRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2alpha.IEnrollSolutionResponse, protos.google.cloud.retail.v2alpha.IEnrollSolutionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IEnrollSolutionRequest
callback Callback<LROperation<protos.google.cloud.retail.v2alpha.IEnrollSolutionResponse, protos.google.cloud.retail.v2alpha.IEnrollSolutionMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAlertConfig(request, options)

getAlertConfig(request?: protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.IAlertConfig,
        protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest | undefined,
        {} | undefined
    ]>;

Get the of the requested project.

Parameters
Name Description
request IGetAlertConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest | 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. Full AlertConfig resource name. Format:
   *  projects/{project_number}/alertConfig
   */
  // const name = 'abc123'

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callGetAlertConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await retailClient.getAlertConfig(request);
    console.log(response);
  }

  callGetAlertConfig();

getAlertConfig(request, options, callback)

getAlertConfig(request: protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAlertConfigRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getAlertConfig(request, callback)

getAlertConfig(request: protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest, callback: Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetAlertConfigRequest
callback Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IGetAlertConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLocation(request, options, callback)

getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;

Gets information about a location.

Parameters
Name Description
request LocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.
options CallOptions | Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. See CallOptions for more details.
callback Callback<google.cloud.location.ILocation, google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
Type Description
Promise<google.cloud.location.ILocation>

{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 

const [response] = await client.getLocation(request);

getLoggingConfig(request, options)

getLoggingConfig(request?: protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.ILoggingConfig,
        protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest | undefined,
        {} | undefined
    ]>;

Gets the of the requested project.

Parameters
Name Description
request IGetLoggingConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest | 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. Full LoggingConfig resource name. Format:
   *  projects/{project_number}/loggingConfig
   */
  // const name = 'abc123'

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callGetLoggingConfig() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await retailClient.getLoggingConfig(request);
    console.log(response);
  }

  callGetLoggingConfig();

getLoggingConfig(request, options, callback)

getLoggingConfig(request: protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLoggingConfigRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getLoggingConfig(request, callback)

getLoggingConfig(request: protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest, callback: Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetLoggingConfigRequest
callback Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IGetLoggingConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getOperation(request, options, callback)

getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters
Name Description
request GetOperationRequest

The request object that will be sent.
options CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
callback Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Returns
Type Description
Promise<[protos.google.longrunning.Operation]>
Example 

const client = longrunning.operationsClient();
const name = '';
const [response] = await client.getOperation({name});
// doThingsWith(response)

getProject(request, options)

getProject(request?: protos.google.cloud.retail.v2alpha.IGetProjectRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.IProject,
        protos.google.cloud.retail.v2alpha.IGetProjectRequest | undefined,
        {} | undefined
    ]>;

Gets the project.

Throws NOT_FOUND if the project wasn't initialized for the Retail API service.

Parameters
Name Description
request IGetProjectRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IGetProjectRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing Project. 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. Full resource name of the project. Format:
   *  `projects/{project_number_or_id}/retailProject`
   */
  // const name = 'abc123'

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callGetProject() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const response = await retailClient.getProject(request);
    console.log(response);
  }

  callGetProject();

getProject(request, options, callback)

getProject(request: protos.google.cloud.retail.v2alpha.IGetProjectRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IGetProjectRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetProjectRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IGetProjectRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProject(request, callback)

getProject(request: protos.google.cloud.retail.v2alpha.IGetProjectRequest, callback: Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IGetProjectRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IGetProjectRequest
callback Callback<protos.google.cloud.retail.v2alpha.IProject, protos.google.cloud.retail.v2alpha.IGetProjectRequest | 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

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.

listEnrolledSolutions(request, options)

listEnrolledSolutions(request?: protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsResponse,
        (protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest | undefined),
        {} | undefined
    ]>;

Lists all the retail API solutions the project has enrolled.

Parameters
Name Description
request IListEnrolledSolutionsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsResponse, (protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest | undefined), {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing ListEnrolledSolutionsResponse. 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. Full resource name of parent. Format:
   *  `projects/{project_number_or_id}`
   */
  // const parent = 'abc123'

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callListEnrolledSolutions() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const response = await retailClient.listEnrolledSolutions(request);
    console.log(response);
  }

  callListEnrolledSolutions();

listEnrolledSolutions(request, options, callback)

listEnrolledSolutions(request: protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsResponse, protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListEnrolledSolutionsRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsResponse, protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listEnrolledSolutions(request, callback)

listEnrolledSolutions(request: protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest, callback: Callback<protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsResponse, protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IListEnrolledSolutionsRequest
callback Callback<protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsResponse, protos.google.cloud.retail.v2alpha.IListEnrolledSolutionsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

listLocationsAsync(request, options)

listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;

Lists information about the supported locations for this service. Returns an iterable object.

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

Parameters
Name Description
request LocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<google.cloud.location.ILocation>

{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 

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

listOperationsAsync(request, options)

listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. Returns an iterable object.

For-await-of syntax is used with the iterable to recursively get response element on-demand.

Parameters
Name Description
request ListOperationsRequest

The request object that will be sent.
options CallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Returns
Type Description
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms to iteration protocols.
Example 

const client = longrunning.operationsClient();
for await (const response of client.listOperationsAsync(request));
// doThingsWith(response)

loggingConfigPath(project)

loggingConfigPath(project: string): string;

Return a fully-qualified loggingConfig resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

matchBranchFromBranchName(branchName)

matchBranchFromBranchName(branchName: string): string | number;

Parse the branch from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.
Returns
Type Description
string | number

{string} A string representing the branch.

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

Parse the branch from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the branch.

matchCatalogFromAttributesConfigName(attributesConfigName)

matchCatalogFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the catalog from AttributesConfig resource.

Parameter
Name Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromBranchName(branchName)

matchCatalogFromBranchName(branchName: string): string | number;

Parse the catalog from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

Parse the catalog from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromCompletionConfigName(completionConfigName)

matchCatalogFromCompletionConfigName(completionConfigName: string): string | number;

Parse the catalog from CompletionConfig resource.

Parameter
Name Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromControlName(controlName)

matchCatalogFromControlName(controlName: string): string | number;

Parse the catalog from Control resource.

Parameter
Name Description
controlName string

A fully-qualified path representing Control resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchCatalogFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the catalog from MerchantCenterAccountLink resource.

Parameter
Name Description
merchantCenterAccountLinkName string

A fully-qualified path representing MerchantCenterAccountLink resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromModelName(modelName)

matchCatalogFromModelName(modelName: string): string | number;

Parse the catalog from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

Parse the catalog from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchCatalogFromServingConfigName(servingConfigName)

matchCatalogFromServingConfigName(servingConfigName: string): string | number;

Parse the catalog from ServingConfig resource.

Parameter
Name Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns
Type Description
string | number

{string} A string representing the catalog.

matchControlFromControlName(controlName)

matchControlFromControlName(controlName: string): string | number;

Parse the control from Control resource.

Parameter
Name Description
controlName string

A fully-qualified path representing Control resource.
Returns
Type Description
string | number

{string} A string representing the control.

matchLocationFromAttributesConfigName(attributesConfigName)

matchLocationFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the location from AttributesConfig resource.

Parameter
Name Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromBranchName(branchName)

matchLocationFromBranchName(branchName: string): string | number;

Parse the location from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

Parse the location from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromCompletionConfigName(completionConfigName)

matchLocationFromCompletionConfigName(completionConfigName: string): string | number;

Parse the location from CompletionConfig resource.

Parameter
Name Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromControlName(controlName)

matchLocationFromControlName(controlName: string): string | number;

Parse the location from Control resource.

Parameter
Name Description
controlName string

A fully-qualified path representing Control resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchLocationFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the location from MerchantCenterAccountLink resource.

Parameter
Name Description
merchantCenterAccountLinkName string

A fully-qualified path representing MerchantCenterAccountLink resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName: string): string | number;

Parse the location from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

Parse the location from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchLocationFromServingConfigName(servingConfigName)

matchLocationFromServingConfigName(servingConfigName: string): string | number;

Parse the location from ServingConfig resource.

Parameter
Name Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns
Type Description
string | number

{string} A string representing the location.

matchMerchantCenterAccountLinkFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchMerchantCenterAccountLinkFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the merchant_center_account_link from MerchantCenterAccountLink resource.

Parameter
Name Description
merchantCenterAccountLinkName string

A fully-qualified path representing MerchantCenterAccountLink resource.
Returns
Type Description
string | number

{string} A string representing the merchant_center_account_link.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName: string): string | number;

Parse the model from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the model.

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

Parse the product from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the product.

matchProjectFromAlertConfigName(alertConfigName)

matchProjectFromAlertConfigName(alertConfigName: string): string | number;

Parse the project from AlertConfig resource.

Parameter
Name Description
alertConfigName string

A fully-qualified path representing AlertConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromAttributesConfigName(attributesConfigName)

matchProjectFromAttributesConfigName(attributesConfigName: string): string | number;

Parse the project from AttributesConfig resource.

Parameter
Name Description
attributesConfigName string

A fully-qualified path representing AttributesConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromBranchName(branchName)

matchProjectFromBranchName(branchName: string): string | number;

Parse the project from Branch resource.

Parameter
Name Description
branchName string

A fully-qualified path representing Branch resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

Parse the project from Catalog resource.

Parameter
Name Description
catalogName string

A fully-qualified path representing Catalog resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromCompletionConfigName(completionConfigName)

matchProjectFromCompletionConfigName(completionConfigName: string): string | number;

Parse the project from CompletionConfig resource.

Parameter
Name Description
completionConfigName string

A fully-qualified path representing CompletionConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromControlName(controlName)

matchProjectFromControlName(controlName: string): string | number;

Parse the project from Control resource.

Parameter
Name Description
controlName string

A fully-qualified path representing Control resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromLoggingConfigName(loggingConfigName)

matchProjectFromLoggingConfigName(loggingConfigName: string): string | number;

Parse the project from LoggingConfig resource.

Parameter
Name Description
loggingConfigName string

A fully-qualified path representing LoggingConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName)

matchProjectFromMerchantCenterAccountLinkName(merchantCenterAccountLinkName: string): string | number;

Parse the project from MerchantCenterAccountLink resource.

Parameter
Name Description
merchantCenterAccountLinkName string

A fully-qualified path representing MerchantCenterAccountLink resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromModelName(modelName)

matchProjectFromModelName(modelName: string): string | number;

Parse the project from Model resource.

Parameter
Name Description
modelName string

A fully-qualified path representing Model resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

Parse the project from Product resource.

Parameter
Name Description
productName string

A fully-qualified path representing Product resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromRetailProjectName(retailProjectName)

matchProjectFromRetailProjectName(retailProjectName: string): string | number;

Parse the project from RetailProject resource.

Parameter
Name Description
retailProjectName string

A fully-qualified path representing RetailProject resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromServingConfigName(servingConfigName)

matchProjectFromServingConfigName(servingConfigName: string): string | number;

Parse the project from ServingConfig resource.

Parameter
Name Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchServingConfigFromServingConfigName(servingConfigName)

matchServingConfigFromServingConfigName(servingConfigName: string): string | number;

Parse the serving_config from ServingConfig resource.

Parameter
Name Description
servingConfigName string

A fully-qualified path representing ServingConfig resource.
Returns
Type Description
string | number

{string} A string representing the serving_config.

merchantCenterAccountLinkPath(project, location, catalog, merchantCenterAccountLink)

merchantCenterAccountLinkPath(project: string, location: string, catalog: string, merchantCenterAccountLink: string): string;

Return a fully-qualified merchantCenterAccountLink resource name string.

Parameters
Name Description
project string
location string
catalog string
merchantCenterAccountLink string
Returns
Type Description
string

{string} Resource name string.

modelPath(project, location, catalog, model)

modelPath(project: string, location: string, catalog: string, model: string): string;

Return a fully-qualified model resource name string.

Parameters
Name Description
project string
location string
catalog string
model string
Returns
Type Description
string

{string} Resource name string.

productPath(project, location, catalog, branch, product)

productPath(project: string, location: string, catalog: string, branch: string, product: string): string;

Return a fully-qualified product resource name string.

Parameters
Name Description
project string
location string
catalog string
branch string
product string
Returns
Type Description
string

{string} Resource name string.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

retailProjectPath(project)

retailProjectPath(project: string): string;

Return a fully-qualified retailProject resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

servingConfigPath(project, location, catalog, servingConfig)

servingConfigPath(project: string, location: string, catalog: string, servingConfig: string): string;

Return a fully-qualified servingConfig resource name string.

Parameters
Name Description
project string
location string
catalog string
servingConfig string
Returns
Type Description
string

{string} Resource name string.

updateAlertConfig(request, options)

updateAlertConfig(request?: protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.IAlertConfig,
        protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest | undefined,
        {} | undefined
    ]>;

Update the alert config of the requested project.

Parameters
Name Description
request IUpdateAlertConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest | 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. The AlertConfig google.cloud.retail.v2alpha.AlertConfig  to
   *  update.
   *  If the caller does not have permission to update the
   *  AlertConfig google.cloud.retail.v2alpha.AlertConfig, then a
   *  PERMISSION_DENIED error is returned.
   *  If the AlertConfig google.cloud.retail.v2alpha.AlertConfig  to update
   *  does not exist, a NOT_FOUND error is returned.
   */
  // const alertConfig = {}
  /**
   *  Indicates which fields in the provided
   *  AlertConfig google.cloud.retail.v2alpha.AlertConfig  to update. If not
   *  set, all supported fields are updated.
   */
  // const updateMask = {}

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callUpdateAlertConfig() {
    // Construct request
    const request = {
      alertConfig,
    };

    // Run request
    const response = await retailClient.updateAlertConfig(request);
    console.log(response);
  }

  callUpdateAlertConfig();

updateAlertConfig(request, options, callback)

updateAlertConfig(request: protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAlertConfigRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateAlertConfig(request, callback)

updateAlertConfig(request: protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest, callback: Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateAlertConfigRequest
callback Callback<protos.google.cloud.retail.v2alpha.IAlertConfig, protos.google.cloud.retail.v2alpha.IUpdateAlertConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLoggingConfig(request, options)

updateLoggingConfig(request?: protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest, options?: CallOptions): Promise<[
        protos.google.cloud.retail.v2alpha.ILoggingConfig,
        (protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest | undefined),
        {} | undefined
    ]>;

Updates the of the requested project.

Parameters
Name Description
request IUpdateLoggingConfigRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Promise<[ protos.google.cloud.retail.v2alpha.ILoggingConfig, (protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest | 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. The LoggingConfig google.cloud.retail.v2alpha.LoggingConfig  to
   *  update.
   *  If the caller does not have permission to update the
   *  LoggingConfig google.cloud.retail.v2alpha.LoggingConfig, then a
   *  PERMISSION_DENIED error is returned.
   *  If the LoggingConfig google.cloud.retail.v2alpha.LoggingConfig  to update
   *  does not exist, a NOT_FOUND error is returned.
   */
  // const loggingConfig = {}
  /**
   *  Indicates which fields in the provided
   *  LoggingConfig google.cloud.retail.v2alpha.LoggingConfig  to update. The
   *  following are the only supported fields:
   *  * LoggingConfig.default_log_generation_rule google.cloud.retail.v2alpha.LoggingConfig.default_log_generation_rule 
   *  * LoggingConfig.service_log_generation_rules google.cloud.retail.v2alpha.LoggingConfig.service_log_generation_rules 
   *  If not set, all supported fields are updated.
   */
  // const updateMask = {}

  // Imports the Retail library
  const {ProjectServiceClient} = require('@google-cloud/retail').v2alpha;

  // Instantiates a client
  const retailClient = new ProjectServiceClient();

  async function callUpdateLoggingConfig() {
    // Construct request
    const request = {
      loggingConfig,
    };

    // Run request
    const response = await retailClient.updateLoggingConfig(request);
    console.log(response);
  }

  callUpdateLoggingConfig();

updateLoggingConfig(request, options, callback)

updateLoggingConfig(request: protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest, options: CallOptions, callback: Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLoggingConfigRequest
options CallOptions
callback Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateLoggingConfig(request, callback)

updateLoggingConfig(request: protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest, callback: Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request IUpdateLoggingConfigRequest
callback Callback<protos.google.cloud.retail.v2alpha.ILoggingConfig, protos.google.cloud.retail.v2alpha.IUpdateLoggingConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void