Class v2.CompletionServiceClient (3.6.0)

Autocomplete service for retail.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. v2

Package

@google-cloud/retail

Constructors

(constructor)(opts, gaxInstance)

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

Construct an instance of CompletionServiceClient.

Parameters
NameDescription
optsClientOptions
gaxInstancetypeofgax | typeoffallback

: loaded instance ofgoogle-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 CompletionServiceClient({fallback: true}, gax); ```

Properties

apiEndpoint

getapiEndpoint():string;

The DNS address for this API service.

apiEndpoint

staticgetapiEndpoint():string;

The DNS address for this API service - same as servicePath.

auth

auth:gax.GoogleAuth;

completionServiceStub

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

descriptors

descriptors:Descriptors;

innerApiCalls

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

locationsClient

locationsClient:LocationsClient;

operationsClient

operationsClient:gax.OperationsClient;

pathTemplates

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

port

staticgetport():number;

The port for this API service.

scopes

staticgetscopes():string[];

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

staticgetservicePath():string;

The DNS address for this API service.

universeDomain

getuniverseDomain():string;

warn

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

Methods

attributesConfigPath(project, location, catalog)

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

Return a fully-qualified attributesConfig resource name string.

Parameters
NameDescription
projectstring
locationstring
catalogstring
Returns
TypeDescription
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 returnsgoogle.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 toCode.CANCELLED.

Parameters
NameDescription
requestCancelOperationRequest

The request object that will be sent.

optionsCallOptions |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. Seegax.CallOptions for the details.

callbackCallback<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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example
constclient=longrunning.operationsClient();awaitclient.cancelOperation({name:''});

catalogPath(project, location, catalog)

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

Return a fully-qualified catalog resource name string.

Parameters
NameDescription
projectstring
locationstring
catalogstring
Returns
TypeDescription
string

{string} Resource name string.

checkImportCompletionDataProgress(name)

checkImportCompletionDataProgress(name:string):Promise<LROperation<protos.google.cloud.retail.v2.ImportCompletionDataResponse,protos.google.cloud.retail.v2.ImportMetadata>>;

Check the status of the long running operation returned byimportCompletionData().

Parameter
NameDescription
namestring

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.retail.v2.ImportCompletionDataResponse,protos.google.cloud.retail.v2.ImportMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see thedocumentation 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 which the suggestions dataset belongs to.   *  Format: `projects/1234/locations/global/catalogs/default_catalog`.   */// const parent = 'abc123'/**   *  Required. The desired input location of the data.   */// const inputConfig = {}/**   *  Pub/Sub topic for receiving notification. If this field is set,   *  when the import is finished, a notification is sent to   *  specified Pub/Sub topic. The message data is JSON string of a   *  Operation google.longrunning.Operation.   *  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.   */// const notificationPubsubTopic = 'abc123'// Imports the Retail libraryconst{CompletionServiceClient}=require('@google-cloud/retail').v2;// Instantiates a clientconstretailClient=newCompletionServiceClient();asyncfunctioncallImportCompletionData(){// Construct requestconstrequest={parent,inputConfig,};// Run requestconst[operation]=awaitretailClient.importCompletionData(request);const[response]=awaitoperation.promise();console.log(response);}callImportCompletionData();

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
TypeDescription
Promise<void>

{Promise} A promise that resolves when the client is closed.

completeQuery(request, options)

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

Completes the specified prefix with keyword suggestions.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameters
NameDescription
requestICompleteQueryRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.retail.v2.ICompleteQueryResponse,protos.google.cloud.retail.v2.ICompleteQueryRequest | undefined, {} | undefined ]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see thedocumentation 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. Catalog for which the completion is performed.   *  Full resource name of catalog, such as   *  `projects/* /locations/global/catalogs/default_catalog`.   */// const catalog = 'abc123'/**   *  Required. The query used to generate suggestions.   *  The maximum number of allowed characters is 255.   */// const query = 'abc123'/**   *  Required field. A unique identifier for tracking visitors. For example,   *  this could be implemented with an HTTP cookie, which should be able to   *  uniquely identify a visitor on a single device. This unique identifier   *  should not change if the visitor logs in or out of the website.   *  The field must be a UTF-8 encoded string with a length limit of 128   *  characters. Otherwise, an INVALID_ARGUMENT error is returned.   */// const visitorId = 'abc123'/**   *  Note that this field applies for `user-data` dataset only. For requests   *  with `cloud-retail` dataset, setting this field has no effect.   *  The language filters applied to the output suggestions. If set, it should   *  contain the language of the query. If not set, suggestions are returned   *  without considering language restrictions. This is the BCP-47 language   *  code, such as "en-US" or "sr-Latn". For more information, see Tags for   *  Identifying Languages (https://tools.ietf.org/html/bcp47). The maximum   *  number of language codes is 3.   */// const languageCodes = ['abc','def']/**   *  The device type context for completion suggestions. We recommend that you   *  leave this field empty.   *  It can apply different suggestions on different device types, e.g.   *  `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device   *  types.   *  Supported formats:   *  * `UNKNOWN_DEVICE_TYPE`   *  * `DESKTOP`   *  * `MOBILE`   *  * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.   */// const deviceType = 'abc123'/**   *  Determines which dataset to use for fetching completion. "user-data" will   *  use the imported dataset through   *  CompletionService.ImportCompletionData google.cloud.retail.v2.CompletionService.ImportCompletionData.   *  "cloud-retail" will use the dataset generated by cloud retail based on user   *  events. If leave empty, it will use the "user-data".   *  Current supported values:   *  * user-data   *  * cloud-retail:   *    This option requires enabling auto-learning function first. See   *    guidelines (https://cloud.google.com/retail/docs/completion-overview#generated-completion-dataset).   */// const dataset = 'abc123'/**   *  Completion max suggestions. If left unset or set to 0, then will fallback   *  to the configured value   *  CompletionConfig.max_suggestions google.cloud.retail.v2.CompletionConfig.max_suggestions.   *  The maximum allowed max suggestions is 20. If it is set higher, it will be   *  capped by 20.   */// const maxSuggestions = 1234/**   *  If true, attribute suggestions are enabled and provided in the response.   *  This field is only available for the "cloud-retail" dataset.   */// const enableAttributeSuggestions = true/**   *  The entity for customers who run multiple entities, domains, sites, or   *  regions, for example, `Google US`, `Google Ads`, `Waymo`,   *  `google.com`, `youtube.com`, etc.   *  If this is set, it must be an exact match with   *  UserEvent.entity google.cloud.retail.v2.UserEvent.entity  to get   *  per-entity autocomplete results.   */// const entity = 'abc123'// Imports the Retail libraryconst{CompletionServiceClient}=require('@google-cloud/retail').v2;// Instantiates a clientconstretailClient=newCompletionServiceClient();asyncfunctioncallCompleteQuery(){// Construct requestconstrequest={catalog,query,};// Run requestconstresponse=awaitretailClient.completeQuery(request);console.log(response);}callCompleteQuery();

completeQuery(request, options, callback)

completeQuery(request:protos.google.cloud.retail.v2.ICompleteQueryRequest,options:CallOptions,callback:Callback<protos.google.cloud.retail.v2.ICompleteQueryResponse,protos.google.cloud.retail.v2.ICompleteQueryRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICompleteQueryRequest
optionsCallOptions
callbackCallback<protos.google.cloud.retail.v2.ICompleteQueryResponse,protos.google.cloud.retail.v2.ICompleteQueryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

completeQuery(request, callback)

completeQuery(request:protos.google.cloud.retail.v2.ICompleteQueryRequest,callback:Callback<protos.google.cloud.retail.v2.ICompleteQueryResponse,protos.google.cloud.retail.v2.ICompleteQueryRequest|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestICompleteQueryRequest
callbackCallback<protos.google.cloud.retail.v2.ICompleteQueryResponse,protos.google.cloud.retail.v2.ICompleteQueryRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

completionConfigPath(project, location, catalog)

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

Return a fully-qualified completionConfig resource name string.

Parameters
NameDescription
projectstring
locationstring
catalogstring
Returns
TypeDescription
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
NameDescription
projectstring
locationstring
catalogstring
controlstring
Returns
TypeDescription
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 returnsgoogle.rpc.Code.UNIMPLEMENTED.

Parameters
NameDescription
requestDeleteOperationRequest

The request object that will be sent.

optionsCallOptions |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. Seegax.CallOptions for the details.

callbackCallback<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
TypeDescription
Promise<protos.google.protobuf.Empty>
Example
constclient=longrunning.operationsClient();awaitclient.deleteOperation({name:''});

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
NameDescription
requestLocationProtos.google.cloud.location.IGetLocationRequest

The request object that will be sent.

optionsCallOptions |Callback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>

Call options. SeeCallOptions for more details.

callbackCallback<google.cloud.location.ILocation,google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
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 thedocumentation for more details and examples.

Example
const[response]=awaitclient.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
NameDescription
requestGetOperationRequest

The request object that will be sent.

optionsCallOptions |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. Seegax.CallOptions for the details.

callbackCallback<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
TypeDescription
Promise<[protos.google.longrunning.Operation]>
Example
constclient=longrunning.operationsClient();constname='';const[response]=awaitclient.getOperation({name});// doThingsWith(response)

getProjectId()

getProjectId():Promise<string>;
Returns
TypeDescription
Promise<string>

getProjectId(callback)

getProjectId(callback:Callback<string,undefined,undefined>):void;
Parameter
NameDescription
callbackCallback<string, undefined, undefined>
Returns
TypeDescription
void

importCompletionData(request, options)

importCompletionData(request?:protos.google.cloud.retail.v2.IImportCompletionDataRequest,options?:CallOptions):Promise<[LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse,protos.google.cloud.retail.v2.IImportMetadata>,protos.google.longrunning.IOperation|undefined,{}|undefined]>;

Bulk import of processed completion dataset.

Request processing is asynchronous. Partial updating is not supported.

The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours.

This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameters
NameDescription
requestIImportCompletionDataRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse,protos.google.cloud.retail.v2.IImportMetadata>,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. Itspromise() method returns a promise you canawait for. Please see thedocumentation 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 which the suggestions dataset belongs to.   *  Format: `projects/1234/locations/global/catalogs/default_catalog`.   */// const parent = 'abc123'/**   *  Required. The desired input location of the data.   */// const inputConfig = {}/**   *  Pub/Sub topic for receiving notification. If this field is set,   *  when the import is finished, a notification is sent to   *  specified Pub/Sub topic. The message data is JSON string of a   *  Operation google.longrunning.Operation.   *  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.   */// const notificationPubsubTopic = 'abc123'// Imports the Retail libraryconst{CompletionServiceClient}=require('@google-cloud/retail').v2;// Instantiates a clientconstretailClient=newCompletionServiceClient();asyncfunctioncallImportCompletionData(){// Construct requestconstrequest={parent,inputConfig,};// Run requestconst[operation]=awaitretailClient.importCompletionData(request);const[response]=awaitoperation.promise();console.log(response);}callImportCompletionData();

importCompletionData(request, options, callback)

importCompletionData(request:protos.google.cloud.retail.v2.IImportCompletionDataRequest,options:CallOptions,callback:Callback<LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse,protos.google.cloud.retail.v2.IImportMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIImportCompletionDataRequest
optionsCallOptions
callbackCallback<LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse,protos.google.cloud.retail.v2.IImportMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

importCompletionData(request, callback)

importCompletionData(request:protos.google.cloud.retail.v2.IImportCompletionDataRequest,callback:Callback<LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse,protos.google.cloud.retail.v2.IImportMetadata>,protos.google.longrunning.IOperation|null|undefined,{}|null|undefined>):void;
Parameters
NameDescription
requestIImportCompletionDataRequest
callbackCallback<LROperation<protos.google.cloud.retail.v2.IImportCompletionDataResponse,protos.google.cloud.retail.v2.IImportMetadata>,protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
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
TypeDescription
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
NameDescription
requestLocationProtos.google.cloud.location.IListLocationsRequest

The request object that will be sent.

optionsCallOptions

Call options. SeeCallOptions for more details.

Returns
TypeDescription
AsyncIterable<google.cloud.location.ILocation>

{Object} An iterable Object that allowsasync 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 thedocumentation for more details and examples.

Example
constiterable=client.listLocationsAsync(request);forawait(constresponseofiterable){// 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 returnsUNIMPLEMENTED. Returns an iterable object.

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

Parameters
NameDescription
requestListOperationsRequest

The request object that will be sent.

optionsCallOptions

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. Seegax.CallOptions for the details.

Returns
TypeDescription
AsyncIterable<protos.google.longrunning.ListOperationsResponse>

{Object} An iterable Object that conforms toiteration protocols.

Example
constclient=longrunning.operationsClient();forawait(constresponseofclient.listOperationsAsync(request));// doThingsWith(response)

matchBranchFromProductName(productName)

matchBranchFromProductName(productName:string):string|number;

Parse the branch from Product resource.

Parameter
NameDescription
productNamestring

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the branch.

matchCatalogFromAttributesConfigName(attributesConfigName)

matchCatalogFromAttributesConfigName(attributesConfigName:string):string|number;

Parse the catalog from AttributesConfig resource.

Parameter
NameDescription
attributesConfigNamestring

A fully-qualified path representing AttributesConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName:string):string|number;

Parse the catalog from Catalog resource.

Parameter
NameDescription
catalogNamestring

A fully-qualified path representing Catalog resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromCompletionConfigName(completionConfigName)

matchCatalogFromCompletionConfigName(completionConfigName:string):string|number;

Parse the catalog from CompletionConfig resource.

Parameter
NameDescription
completionConfigNamestring

A fully-qualified path representing CompletionConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromControlName(controlName)

matchCatalogFromControlName(controlName:string):string|number;

Parse the catalog from Control resource.

Parameter
NameDescription
controlNamestring

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromModelName(modelName)

matchCatalogFromModelName(modelName:string):string|number;

Parse the catalog from Model resource.

Parameter
NameDescription
modelNamestring

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName:string):string|number;

Parse the catalog from Product resource.

Parameter
NameDescription
productNamestring

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchCatalogFromServingConfigName(servingConfigName)

matchCatalogFromServingConfigName(servingConfigName:string):string|number;

Parse the catalog from ServingConfig resource.

Parameter
NameDescription
servingConfigNamestring

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the catalog.

matchControlFromControlName(controlName)

matchControlFromControlName(controlName:string):string|number;

Parse the control from Control resource.

Parameter
NameDescription
controlNamestring

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the control.

matchLocationFromAttributesConfigName(attributesConfigName)

matchLocationFromAttributesConfigName(attributesConfigName:string):string|number;

Parse the location from AttributesConfig resource.

Parameter
NameDescription
attributesConfigNamestring

A fully-qualified path representing AttributesConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName:string):string|number;

Parse the location from Catalog resource.

Parameter
NameDescription
catalogNamestring

A fully-qualified path representing Catalog resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromCompletionConfigName(completionConfigName)

matchLocationFromCompletionConfigName(completionConfigName:string):string|number;

Parse the location from CompletionConfig resource.

Parameter
NameDescription
completionConfigNamestring

A fully-qualified path representing CompletionConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromControlName(controlName)

matchLocationFromControlName(controlName:string):string|number;

Parse the location from Control resource.

Parameter
NameDescription
controlNamestring

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromModelName(modelName)

matchLocationFromModelName(modelName:string):string|number;

Parse the location from Model resource.

Parameter
NameDescription
modelNamestring

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProductName(productName)

matchLocationFromProductName(productName:string):string|number;

Parse the location from Product resource.

Parameter
NameDescription
productNamestring

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromServingConfigName(servingConfigName)

matchLocationFromServingConfigName(servingConfigName:string):string|number;

Parse the location from ServingConfig resource.

Parameter
NameDescription
servingConfigNamestring

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchModelFromModelName(modelName)

matchModelFromModelName(modelName:string):string|number;

Parse the model from Model resource.

Parameter
NameDescription
modelNamestring

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the model.

matchProductFromProductName(productName)

matchProductFromProductName(productName:string):string|number;

Parse the product from Product resource.

Parameter
NameDescription
productNamestring

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the product.

matchProjectFromAttributesConfigName(attributesConfigName)

matchProjectFromAttributesConfigName(attributesConfigName:string):string|number;

Parse the project from AttributesConfig resource.

Parameter
NameDescription
attributesConfigNamestring

A fully-qualified path representing AttributesConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName:string):string|number;

Parse the project from Catalog resource.

Parameter
NameDescription
catalogNamestring

A fully-qualified path representing Catalog resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromCompletionConfigName(completionConfigName)

matchProjectFromCompletionConfigName(completionConfigName:string):string|number;

Parse the project from CompletionConfig resource.

Parameter
NameDescription
completionConfigNamestring

A fully-qualified path representing CompletionConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromControlName(controlName)

matchProjectFromControlName(controlName:string):string|number;

Parse the project from Control resource.

Parameter
NameDescription
controlNamestring

A fully-qualified path representing Control resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromModelName(modelName)

matchProjectFromModelName(modelName:string):string|number;

Parse the project from Model resource.

Parameter
NameDescription
modelNamestring

A fully-qualified path representing Model resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProductName(productName)

matchProjectFromProductName(productName:string):string|number;

Parse the project from Product resource.

Parameter
NameDescription
productNamestring

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromServingConfigName(servingConfigName)

matchProjectFromServingConfigName(servingConfigName:string):string|number;

Parse the project from ServingConfig resource.

Parameter
NameDescription
servingConfigNamestring

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchServingConfigFromServingConfigName(servingConfigName)

matchServingConfigFromServingConfigName(servingConfigName:string):string|number;

Parse the serving_config from ServingConfig resource.

Parameter
NameDescription
servingConfigNamestring

A fully-qualified path representing ServingConfig resource.

Returns
TypeDescription
string | number

{string} A string representing the serving_config.

modelPath(project, location, catalog, model)

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

Return a fully-qualified model resource name string.

Parameters
NameDescription
projectstring
locationstring
catalogstring
modelstring
Returns
TypeDescription
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
NameDescription
projectstring
locationstring
catalogstring
branchstring
productstring
Returns
TypeDescription
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
NameDescription
projectstring
locationstring
catalogstring
servingConfigstring
Returns
TypeDescription
string

{string} Resource name string.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.