Class v2.ServingConfigServiceClient (2.1.1)

Service for modifying ServingConfig. v2

Package

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of ServingConfigServiceClient.

Parameters

Name	Description
opts	`ClientOptions`
gaxInstance	`typeof gax \| typeof gax.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 ServingConfigServiceClient({fallback: 'rest'}, gax); ```

Properties

apiEndpoint

  static 
  
 get 
  
 apiEndpoint 
 () 
 : 
  
 string 
 ;

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

auth

  auth 
 : 
  
 gax 
 . 
 GoogleAuth 
 ;

descriptors

  descriptors 
 : 
  
 Descriptors 
 ;

innerApiCalls

  innerApiCalls 
 : 
  
 { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 };

locationsClient

  locationsClient 
 : 
  
 LocationsClient 
 ;

operationsClient

  operationsClient 
 : 
  
 gax 
 . 
 OperationsClient 
 ;

pathTemplates

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

port

  static 
  
 get 
  
 port 
 () 
 : 
  
 number 
 ;

The port for this API service.

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.

servingConfigServiceStub

  servingConfigServiceStub 
 ?: 
  
 Promise 
< { 
  
 [ 
 name 
 : 
  
 string 
 ] 
 : 
  
 Function 
 ; 
  
 }>;

warn

  warn 
 : 
  
 ( 
 code 
 : 
  
 string 
 , 
  
 message 
 : 
  
 string 
 , 
  
 warnType 
 ?: 
  
 string 
 ) 
  
 = 
>  
 void 
 ;

Methods

addControl(request, options)

  addControl 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IAddControlRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IAddControlRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;

Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control.

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IAddControlRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[ protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IAddControlRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ServingConfig]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 source ServingConfig resource name . Format: 
 *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} 
 */ 
  
 // const servingConfig = 'abc123' 
  
 /** 
 *  Required. The id of the control to apply. Assumed to be in the same catalog 
 *  as the serving config - if id is not found a NOT_FOUND error is returned. 
 */ 
  
 // const controlId = 'abc123' 
  
 // Imports the Retail library 
  
 const 
  
 { 
 ServingConfigServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/retail 
' 
 ). 
 v2 
 ; 
  
 // Instantiates a client 
  
 const 
  
 retailClient 
  
 = 
  
 new 
  
  ServingConfigServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callAddControl 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 servingConfig 
 , 
  
 controlId 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 retailClient 
 . 
 addControl 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callAddControl 
 ();

addControl(request, options, callback)

  addControl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IAddControlRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IAddControlRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IAddControlRequest`
options	`CallOptions`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IAddControlRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

addControl(request, callback)

  addControl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IAddControlRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IAddControlRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IAddControlRequest`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IAddControlRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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.

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	`protos. google.longrunning.CancelOperationRequest` The request object that will be sent.
options	`gax. 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] https://googleapis.github.io/gax-nodejs/global.html#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.

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.

createServingConfig(request, options)

  createServingConfig 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 ICreateServingConfigRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 ICreateServingConfigRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;

Creates a ServingConfig.

A maximum of 100 s are allowed in a , otherwise a FAILED_PRECONDITION error is returned.

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.ICreateServingConfigRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[ protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.ICreateServingConfigRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ServingConfig]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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}/locations/{location_id}/catalogs/{catalog_id}` 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Required. The ServingConfig to create. 
 */ 
  
 // const servingConfig = {} 
  
 /** 
 *  Required. The ID to use for the ServingConfig, which will become the final 
 *  component of the ServingConfig's resource name. 
 *  This value should be 4-63 characters, and valid characters 
 *  are /[a-z][0-9]-_/. 
 */ 
  
 // const servingConfigId = 'abc123' 
  
 // Imports the Retail library 
  
 const 
  
 { 
 ServingConfigServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/retail 
' 
 ). 
 v2 
 ; 
  
 // Instantiates a client 
  
 const 
  
 retailClient 
  
 = 
  
 new 
  
  ServingConfigServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callCreateServingConfig 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 servingConfig 
 , 
  
 servingConfigId 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 retailClient 
 . 
 createServingConfig 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callCreateServingConfig 
 ();

createServingConfig(request, options, callback)

  createServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 ICreateServingConfigRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 ICreateServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.ICreateServingConfigRequest`
options	`CallOptions`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.ICreateServingConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

createServingConfig(request, callback)

  createServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 ICreateServingConfigRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 ICreateServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.ICreateServingConfigRequest`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.ICreateServingConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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	`protos. google.longrunning.DeleteOperationRequest` The request object that will be sent.
options	`gax. 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] https://googleapis.github.io/gax-nodejs/global.html#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 
 : 
  
 '' 
 });

deleteServingConfig(request, options)

  deleteServingConfig 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IDeleteServingConfigRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IDeleteServingConfigRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;

Deletes a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IDeleteServingConfigRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[ protos. google.protobuf.IEmpty , protos. google.cloud.retail.v2.IDeleteServingConfigRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Empty]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 resource name of the ServingConfig to delete. Format: 
 *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} 
 */ 
  
 // const name = 'abc123' 
  
 // Imports the Retail library 
  
 const 
  
 { 
 ServingConfigServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/retail 
' 
 ). 
 v2 
 ; 
  
 // Instantiates a client 
  
 const 
  
 retailClient 
  
 = 
  
 new 
  
  ServingConfigServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callDeleteServingConfig 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 retailClient 
 . 
 deleteServingConfig 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callDeleteServingConfig 
 ();

deleteServingConfig(request, options, callback)

  deleteServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IDeleteServingConfigRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IDeleteServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IDeleteServingConfigRequest`
options	`CallOptions`
callback	`Callback <protos. google.protobuf.IEmpty , protos. google.cloud.retail.v2.IDeleteServingConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

deleteServingConfig(request, callback)

  deleteServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IDeleteServingConfigRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 protobuf 
 . 
 IEmpty 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IDeleteServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IDeleteServingConfigRequest`
callback	`Callback <protos. google.protobuf.IEmpty , protos. google.cloud.retail.v2.IDeleteServingConfigRequest \| 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	`gax. CallOptions \| Callback <LocationProtos. google.cloud.location.ILocation , LocationProtos. google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>` Call options. See CallOptions for more details.
callback	`Callback <LocationProtos. google.cloud.location.ILocation , LocationProtos. google.cloud.location.IGetLocationRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
Promise <LocationProtos. google.cloud.location.ILocation >	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [Location]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.

Example

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

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	`protos. google.longrunning.GetOperationRequest` The request object that will be sent.
options	`gax. 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] https://googleapis.github.io/gax-nodejs/global.html#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 [google.longrunning.Operation]. {Promise} - The promise which resolves to an array. The first element of the array is an object representing [google.longrunning.Operation]. 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)

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

getServingConfig(request, options)

  getServingConfig 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IGetServingConfigRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IGetServingConfigRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;

Gets a ServingConfig.

Returns a NotFound error if the ServingConfig does not exist.

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IGetServingConfigRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[ protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IGetServingConfigRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ServingConfig]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 resource name of the ServingConfig to get. Format: 
 *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} 
 */ 
  
 // const name = 'abc123' 
  
 // Imports the Retail library 
  
 const 
  
 { 
 ServingConfigServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/retail 
' 
 ). 
 v2 
 ; 
  
 // Instantiates a client 
  
 const 
  
 retailClient 
  
 = 
  
 new 
  
  ServingConfigServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callGetServingConfig 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 name 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 retailClient 
 . 
 getServingConfig 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callGetServingConfig 
 ();

getServingConfig(request, options, callback)

  getServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IGetServingConfigRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IGetServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IGetServingConfigRequest`
options	`CallOptions`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IGetServingConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

getServingConfig(request, callback)

  getServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IGetServingConfigRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IGetServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IGetServingConfigRequest`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IGetServingConfigRequest \| 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.

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 <LocationProtos. google.cloud.location.ILocation >

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [Location]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  const 
  
 iterable 
  
 = 
  
 client 
 . 
 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	`protos. google.longrunning.ListOperationsRequest` The request object that will be sent.
options	`gax. CallOptions` Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See [gax.CallOptions] https://googleapis.github.io/gax-nodejs/global.html#CallOptions for the details.

Returns

Type	Description
AsyncIterable <protos. google.longrunning.ListOperationsResponse >	{Object} An iterable Object that conforms to https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.

Example

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

listServingConfigs(request, options)

  listServingConfigs 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 [], 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
  
 | 
  
 null 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsResponse 
  
 ]>;

Lists all ServingConfigs linked to this catalog.

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IListServingConfigsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type Description

Promise <[ protos. google.cloud.retail.v2.IServingConfig [], protos. google.cloud.retail.v2.IListServingConfigsRequest | null, protos. google.cloud.retail.v2.IListServingConfigsResponse ]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [ServingConfig]. 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 listServingConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listServingConfigs(request, options, callback)

  listServingConfigs 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IListServingConfigsRequest`
options	`CallOptions`
callback	`PaginationCallback <protos. google.cloud.retail.v2.IListServingConfigsRequest , protos. google.cloud.retail.v2.IListServingConfigsResponse \| null \| undefined, protos. google.cloud.retail.v2.IServingConfig >`

Returns

Type	Description
void

listServingConfigs(request, callback)

  listServingConfigs 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
 , 
  
 callback 
 : 
  
 PaginationCallback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsResponse 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IListServingConfigsRequest`
callback	`PaginationCallback <protos. google.cloud.retail.v2.IListServingConfigsRequest , protos. google.cloud.retail.v2.IListServingConfigsResponse \| null \| undefined, protos. google.cloud.retail.v2.IServingConfig >`

Returns

Type	Description
void

listServingConfigsAsync(request, options)

  listServingConfigsAsync 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 AsyncIterable<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
> ;

Equivalent to listServingConfigs , but returns an iterable object.

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

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IListServingConfigsRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type

Description

AsyncIterable <protos. google.cloud.retail.v2.IServingConfig >

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ServingConfig]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

   
 /** 
 * 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 catalog resource name. Format: 
 *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id} 
 */ 
  
 // const parent = 'abc123' 
  
 /** 
 *  Optional. Maximum number of results to return. If unspecified, defaults 
 *  to 100. If a value greater than 100 is provided, at most 100 results are 
 *  returned. 
 */ 
  
 // const pageSize = 1234 
  
 /** 
 *  Optional. A page token, received from a previous `ListServingConfigs` call. 
 *  Provide this to retrieve the subsequent page. 
 */ 
  
 // const pageToken = 'abc123' 
  
 // Imports the Retail library 
  
 const 
  
 { 
 ServingConfigServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/retail 
' 
 ). 
 v2 
 ; 
  
 // Instantiates a client 
  
 const 
  
 retailClient 
  
 = 
  
 new 
  
  ServingConfigServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callListServingConfigs 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 parent 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 iterable 
  
 = 
  
 await 
  
 retailClient 
 . 
 listServingConfigsAsync 
 ( 
 request 
 ); 
  
 for 
  
 await 
  
 ( 
 const 
  
 response 
  
 of 
  
 iterable 
 ) 
  
 { 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 } 
  
 callListServingConfigs 
 ();

listServingConfigsStream(request, options)

  listServingConfigsStream 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IListServingConfigsRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Transform 
 ;

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

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IListServingConfigsRequest` 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 [ServingConfig] 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 listServingConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

removeControl(request, options)

  removeControl 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IRemoveControlRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IRemoveControlRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;

Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig.

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IRemoveControlRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[ protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IRemoveControlRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ServingConfig]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 source ServingConfig resource name . Format: 
 *  projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/servingConfigs/{serving_config_id} 
 */ 
  
 // const servingConfig = 'abc123' 
  
 /** 
 *  Required. The id of the control to apply. Assumed to be in the same catalog 
 *  as the serving config. 
 */ 
  
 // const controlId = 'abc123' 
  
 // Imports the Retail library 
  
 const 
  
 { 
 ServingConfigServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/retail 
' 
 ). 
 v2 
 ; 
  
 // Instantiates a client 
  
 const 
  
 retailClient 
  
 = 
  
 new 
  
  ServingConfigServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callRemoveControl 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 servingConfig 
 , 
  
 controlId 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 retailClient 
 . 
 removeControl 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callRemoveControl 
 ();

removeControl(request, options, callback)

  removeControl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IRemoveControlRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IRemoveControlRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IRemoveControlRequest`
options	`CallOptions`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IRemoveControlRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

removeControl(request, callback)

  removeControl 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IRemoveControlRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IRemoveControlRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IRemoveControlRequest`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IRemoveControlRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

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.

updateServingConfig(request, options)

  updateServingConfig 
 ( 
 request 
 ?: 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IUpdateServingConfigRequest 
 , 
  
 options 
 ?: 
  
 CallOptions 
 ) 
 : 
  
 Promise 
< [ 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IUpdateServingConfigRequest 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 undefined 
  
 ]>;

Updates a ServingConfig.

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IUpdateServingConfigRequest` The request object that will be sent.
options	`CallOptions` Call options. See CallOptions for more details.

Returns

Type	Description
Promise <[ protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IUpdateServingConfigRequest \| undefined, {} \| undefined ]>	{Promise} - The promise which resolves to an array. The first element of the array is an object representing [ServingConfig]. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) 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 ServingConfig to update. 
 */ 
  
 // const servingConfig = {} 
  
 /** 
 *  Indicates which fields in the provided 
 *  ServingConfig google.cloud.retail.v2.ServingConfig  to update. The 
 *  following are NOT supported: 
 *  * ServingConfig.name google.cloud.retail.v2.ServingConfig.name 
 *  If not set, all supported fields are updated. 
 */ 
  
 // const updateMask = {} 
  
 // Imports the Retail library 
  
 const 
  
 { 
 ServingConfigServiceClient 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/retail 
' 
 ). 
 v2 
 ; 
  
 // Instantiates a client 
  
 const 
  
 retailClient 
  
 = 
  
 new 
  
  ServingConfigServiceClient 
 
 (); 
  
 async 
  
 function 
  
 callUpdateServingConfig 
 () 
  
 { 
  
 // Construct request 
  
 const 
  
 request 
  
 = 
  
 { 
  
 servingConfig 
 , 
  
 }; 
  
 // Run request 
  
 const 
  
 response 
  
 = 
  
 await 
  
 retailClient 
 . 
 updateServingConfig 
 ( 
 request 
 ); 
  
 console 
 . 
 log 
 ( 
 response 
 ); 
  
 } 
  
 callUpdateServingConfig 
 ();

updateServingConfig(request, options, callback)

  updateServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IUpdateServingConfigRequest 
 , 
  
 options 
 : 
  
 CallOptions 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IUpdateServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IUpdateServingConfigRequest`
options	`CallOptions`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IUpdateServingConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

updateServingConfig(request, callback)

  updateServingConfig 
 ( 
 request 
 : 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IUpdateServingConfigRequest 
 , 
  
 callback 
 : 
  
 Callback<protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IServingConfig 
 , 
  
 protos 
 . 
 google 
 . 
 cloud 
 . 
 retail 
 . 
 v2 
 . 
 IUpdateServingConfigRequest 
  
 | 
  
 null 
  
 | 
  
 undefined 
 , 
  
 {} 
  
 | 
  
 null 
  
 | 
  
 undefined 
> ) 
 : 
  
 void 
 ;

Parameters

Name	Description
request	`protos. google.cloud.retail.v2.IUpdateServingConfigRequest`
callback	`Callback <protos. google.cloud.retail.v2.IServingConfig , protos. google.cloud.retail.v2.IUpdateServingConfigRequest \| null \| undefined, {} \| null \| undefined>`

Returns

Type	Description
void

Class v2.ServingConfigServiceClient (2.1.1) Stay organized with collections Save and categorize content based on your preferences.

Package

Constructors

(constructor)(opts, gaxInstance)

Properties

apiEndpoint

auth

descriptors

innerApiCalls

locationsClient

operationsClient

pathTemplates

port

scopes

servicePath

servingConfigServiceStub

warn

Methods

addControl(request, options)

addControl(request, options, callback)

addControl(request, callback)

attributesConfigPath(project, location, catalog)

cancelOperation(request, options, callback)

catalogPath(project, location, catalog)

close()

completionConfigPath(project, location, catalog)

controlPath(project, location, catalog, control)

createServingConfig(request, options)

createServingConfig(request, options, callback)

createServingConfig(request, callback)

deleteOperation(request, options, callback)

deleteServingConfig(request, options)

deleteServingConfig(request, options, callback)

deleteServingConfig(request, callback)

getLocation(request, options, callback)

getOperation(request, options, callback)

getProjectId()

getProjectId(callback)

getServingConfig(request, options)

getServingConfig(request, options, callback)

getServingConfig(request, callback)

initialize()

listLocationsAsync(request, options)

listOperationsAsync(request, options)

listServingConfigs(request, options)

listServingConfigs(request, options, callback)

listServingConfigs(request, callback)

listServingConfigsAsync(request, options)

listServingConfigsStream(request, options)

matchBranchFromProductName(productName)

matchCatalogFromAttributesConfigName(attributesConfigName)

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCompletionConfigName(completionConfigName)

matchCatalogFromControlName(controlName)

matchCatalogFromProductName(productName)

matchCatalogFromServingConfigName(servingConfigName)

matchControlFromControlName(controlName)

matchLocationFromAttributesConfigName(attributesConfigName)

matchLocationFromCatalogName(catalogName)

matchLocationFromCompletionConfigName(completionConfigName)

matchLocationFromControlName(controlName)

matchLocationFromProductName(productName)

matchLocationFromServingConfigName(servingConfigName)

matchProductFromProductName(productName)

matchProjectFromAttributesConfigName(attributesConfigName)

matchProjectFromCatalogName(catalogName)

matchProjectFromCompletionConfigName(completionConfigName)

matchProjectFromControlName(controlName)

matchProjectFromProductName(productName)

matchProjectFromServingConfigName(servingConfigName)

matchServingConfigFromServingConfigName(servingConfigName)

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

removeControl(request, options)

removeControl(request, options, callback)

removeControl(request, callback)

servingConfigPath(project, location, catalog, servingConfig)

updateServingConfig(request, options)

updateServingConfig(request, options, callback)

updateServingConfig(request, callback)

Class v2.ServingConfigServiceClient (2.1.1)