Auto-completion 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. v2beta
Package
@google-cloud/retailConstructors
(constructor)(opts, gaxInstance)
constructor
(
opts
?:
ClientOptions
,
gaxInstance
?:
typeof
gax
|
typeof
gax
.
fallback
);
Construct an instance of CompletionServiceClient.
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 CompletionServiceClient({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
;
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
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.
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.
project
string
location
string
catalog
string
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
.
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 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.
Promise
<protos. google.protobuf.Empty
>
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.
project
string
location
string
catalog
string
string
{string} Resource name string.
checkImportCompletionDataProgress(name)
checkImportCompletionDataProgress
(
name
:
string
)
:
Promise<LROperation<protos
.
google
.
cloud
.
retail
.
v2beta
.
ImportCompletionDataResponse
,
protos
.
google
.
cloud
.
retail
.
v2beta
.
ImportMetadata
>> ;
Check the status of the long running operation returned by importCompletionData()
.
name
string
The operation name that will be passed.
Promise
< LROperation
<protos. google.cloud.retail.v2beta.ImportCompletionDataResponse
, protos. google.cloud.retail.v2beta.ImportMetadata
>>
{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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 library
const
{
CompletionServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2beta
;
// Instantiates a client
const
retailClient
=
new
CompletionServiceClient
();
async
function
callImportCompletionData
()
{
// Construct request
const
request
=
{
parent
,
inputConfig
,
};
// Run request
const
[
operation
]
=
await
retailClient
.
importCompletionData
(
request
);
const
[
response
]
=
await
operation
.
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.
Promise
<void>
{Promise} A promise that resolves when the client is closed.
completeQuery(request, options)
completeQuery
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryResponse
,
protos
.
google
.
cloud
.
retail
.
v2beta
.
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.
request
protos. google.cloud.retail.v2beta.ICompleteQueryRequest
The request object that will be sent.
options
Promise
<[
protos. google.cloud.retail.v2beta.ICompleteQueryResponse
,
protos. google.cloud.retail.v2beta.ICompleteQueryRequest
| undefined,
{} | undefined
]>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
/**
* 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 = 'abc123'
/**
* 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.v2beta.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.v2beta.CompletionConfig.max_suggestions.
* The maximum allowed max suggestions is 20. If it is set higher, it will be
* capped by 20.
*/
// const maxSuggestions = 1234
// Imports the Retail library
const
{
CompletionServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2beta
;
// Instantiates a client
const
retailClient
=
new
CompletionServiceClient
();
async
function
callCompleteQuery
()
{
// Construct request
const
request
=
{
catalog
,
query
,
};
// Run request
const
response
=
await
retailClient
.
completeQuery
(
request
);
console
.
log
(
response
);
}
callCompleteQuery
();
completeQuery(request, options, callback)
completeQuery
(
request
:
protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryResponse
,
protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2beta.ICompleteQueryRequest
options
CallOptions
callback
Callback
<protos. google.cloud.retail.v2beta.ICompleteQueryResponse
, protos. google.cloud.retail.v2beta.ICompleteQueryRequest
| null | undefined, {} | null | undefined>
void
completeQuery(request, callback)
completeQuery
(
request
:
protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryResponse
,
protos
.
google
.
cloud
.
retail
.
v2beta
.
ICompleteQueryRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2beta.ICompleteQueryRequest
callback
Callback
<protos. google.cloud.retail.v2beta.ICompleteQueryResponse
, protos. google.cloud.retail.v2beta.ICompleteQueryRequest
| null | undefined, {} | null | undefined>
void
completionConfigPath(project, location, catalog)
completionConfigPath
(
project
:
string
,
location
:
string
,
catalog
:
string
)
:
string
;
Return a fully-qualified completionConfig resource name string.
project
string
location
string
catalog
string
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.
project
string
location
string
catalog
string
control
string
string
{string} Resource name string.
deleteOperation(request, options, callback)
deleteOperation
(
request
:
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
options
?:
gax
.
CallOptions
|
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> ,
callback
?:
Callback<protos
.
google
.
protobuf
.
Empty
,
protos
.
google
.
longrunning
.
DeleteOperationRequest
,
{}
|
null
|
undefined
> )
:
Promise<protos
.
google
.
protobuf
.
Empty
> ;
Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED
.
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 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.
Promise
<protos. google.protobuf.Empty
>
const
client
=
longrunning
.
operationsClient
();
await
client
.
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.
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>
Promise
<LocationProtos. google.cloud.location.ILocation
>
{Promise} - The promise which resolves to an array. The first element of the array is an object representing . Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods) for more details and examples.
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.
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 for the details.
callback
Callback
<protos. google.longrunning.Operation
, protos. google.longrunning.GetOperationRequest
, {} | null | undefined>
The function which will be called with the result of the API call.
The second parameter to the callback is an object representing . {Promise} - The promise which resolves to an array. The first element of the array is an object representing . The promise has a method named "cancel" which cancels the ongoing API call.
Promise
<[protos. google.longrunning.Operation
]>
const
client
=
longrunning
.
operationsClient
();
const
name
=
''
;
const
[
response
]
=
await
client
.
getOperation
({
name
});
// doThingsWith(response)
getProjectId()
getProjectId
()
:
Promise<string>
;
Promise
<string>
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
callback
Callback
<string, undefined, undefined>
void
importCompletionData(request, options)
importCompletionData
(
request
?:
protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportCompletionDataRequest
,
options
?:
CallOptions
)
:
Promise
< [
LROperation<protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportCompletionDataResponse
,
protos
.
google
.
cloud
.
retail
.
v2beta
.
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.
request
protos. google.cloud.retail.v2beta.IImportCompletionDataRequest
The request object that will be sent.
options
Promise
<[ LROperation
<protos. google.cloud.retail.v2beta.IImportCompletionDataResponse
, protos. google.cloud.retail.v2beta.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. Its promise()
method returns a promise you can await
for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.
/**
* 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 library
const
{
CompletionServiceClient
}
=
require
(
' @google-cloud/retail
'
).
v2beta
;
// Instantiates a client
const
retailClient
=
new
CompletionServiceClient
();
async
function
callImportCompletionData
()
{
// Construct request
const
request
=
{
parent
,
inputConfig
,
};
// Run request
const
[
operation
]
=
await
retailClient
.
importCompletionData
(
request
);
const
[
response
]
=
await
operation
.
promise
();
console
.
log
(
response
);
}
callImportCompletionData
();
importCompletionData(request, options, callback)
importCompletionData
(
request
:
protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportCompletionDataRequest
,
options
:
CallOptions
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportCompletionDataResponse
,
protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2beta.IImportCompletionDataRequest
options
CallOptions
callback
Callback
< LROperation
<protos. google.cloud.retail.v2beta.IImportCompletionDataResponse
, protos. google.cloud.retail.v2beta.IImportMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
void
importCompletionData(request, callback)
importCompletionData
(
request
:
protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportCompletionDataRequest
,
callback
:
Callback<LROperation<protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportCompletionDataResponse
,
protos
.
google
.
cloud
.
retail
.
v2beta
.
IImportMetadata
> ,
protos
.
google
.
longrunning
.
IOperation
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
request
protos. google.cloud.retail.v2beta.IImportCompletionDataRequest
callback
Callback
< LROperation
<protos. google.cloud.retail.v2beta.IImportCompletionDataResponse
, protos. google.cloud.retail.v2beta.IImportMetadata
>, protos. google.longrunning.IOperation
| null | undefined, {} | null | undefined>
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.
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.
request
LocationProtos. google.cloud.location.IListLocationsRequest
The request object that will be sent.
options
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 . 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.
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.
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 for the details.
AsyncIterable
<protos. google.longrunning.ListOperationsResponse
>
{Object} An iterable Object that conforms to iteration protocols .
const
client
=
longrunning
.
operationsClient
();
for
await
(
const
response
of
client
.
listOperationsAsync
(
request
));
// doThingsWith(response)
matchBranchFromProductName(productName)
matchBranchFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the branch from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the branch.
matchCatalogFromAttributesConfigName(attributesConfigName)
matchCatalogFromAttributesConfigName
(
attributesConfigName
:
string
)
:
string
|
number
;
Parse the catalog from AttributesConfig resource.
attributesConfigName
string
A fully-qualified path representing AttributesConfig resource.
string | number
{string} A string representing the catalog.
matchCatalogFromCatalogName(catalogName)
matchCatalogFromCatalogName
(
catalogName
:
string
)
:
string
|
number
;
Parse the catalog from Catalog resource.
catalogName
string
A fully-qualified path representing Catalog resource.
string | number
{string} A string representing the catalog.
matchCatalogFromCompletionConfigName(completionConfigName)
matchCatalogFromCompletionConfigName
(
completionConfigName
:
string
)
:
string
|
number
;
Parse the catalog from CompletionConfig resource.
completionConfigName
string
A fully-qualified path representing CompletionConfig resource.
string | number
{string} A string representing the catalog.
matchCatalogFromControlName(controlName)
matchCatalogFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the catalog from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the catalog.
matchCatalogFromModelName(modelName)
matchCatalogFromModelName
(
modelName
:
string
)
:
string
|
number
;
Parse the catalog from Model resource.
modelName
string
A fully-qualified path representing Model resource.
string | number
{string} A string representing the catalog.
matchCatalogFromProductName(productName)
matchCatalogFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the catalog from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the catalog.
matchCatalogFromServingConfigName(servingConfigName)
matchCatalogFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the catalog from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
string | number
{string} A string representing the catalog.
matchControlFromControlName(controlName)
matchControlFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the control from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the control.
matchLocationFromAttributesConfigName(attributesConfigName)
matchLocationFromAttributesConfigName
(
attributesConfigName
:
string
)
:
string
|
number
;
Parse the location from AttributesConfig resource.
attributesConfigName
string
A fully-qualified path representing AttributesConfig resource.
string | number
{string} A string representing the location.
matchLocationFromCatalogName(catalogName)
matchLocationFromCatalogName
(
catalogName
:
string
)
:
string
|
number
;
Parse the location from Catalog resource.
catalogName
string
A fully-qualified path representing Catalog resource.
string | number
{string} A string representing the location.
matchLocationFromCompletionConfigName(completionConfigName)
matchLocationFromCompletionConfigName
(
completionConfigName
:
string
)
:
string
|
number
;
Parse the location from CompletionConfig resource.
completionConfigName
string
A fully-qualified path representing CompletionConfig resource.
string | number
{string} A string representing the location.
matchLocationFromControlName(controlName)
matchLocationFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the location from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the location.
matchLocationFromModelName(modelName)
matchLocationFromModelName
(
modelName
:
string
)
:
string
|
number
;
Parse the location from Model resource.
modelName
string
A fully-qualified path representing Model resource.
string | number
{string} A string representing the location.
matchLocationFromProductName(productName)
matchLocationFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the location from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the location.
matchLocationFromServingConfigName(servingConfigName)
matchLocationFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the location from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
string | number
{string} A string representing the location.
matchModelFromModelName(modelName)
matchModelFromModelName
(
modelName
:
string
)
:
string
|
number
;
Parse the model from Model resource.
modelName
string
A fully-qualified path representing Model resource.
string | number
{string} A string representing the model.
matchProductFromProductName(productName)
matchProductFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the product from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the product.
matchProjectFromAttributesConfigName(attributesConfigName)
matchProjectFromAttributesConfigName
(
attributesConfigName
:
string
)
:
string
|
number
;
Parse the project from AttributesConfig resource.
attributesConfigName
string
A fully-qualified path representing AttributesConfig resource.
string | number
{string} A string representing the project.
matchProjectFromCatalogName(catalogName)
matchProjectFromCatalogName
(
catalogName
:
string
)
:
string
|
number
;
Parse the project from Catalog resource.
catalogName
string
A fully-qualified path representing Catalog resource.
string | number
{string} A string representing the project.
matchProjectFromCompletionConfigName(completionConfigName)
matchProjectFromCompletionConfigName
(
completionConfigName
:
string
)
:
string
|
number
;
Parse the project from CompletionConfig resource.
completionConfigName
string
A fully-qualified path representing CompletionConfig resource.
string | number
{string} A string representing the project.
matchProjectFromControlName(controlName)
matchProjectFromControlName
(
controlName
:
string
)
:
string
|
number
;
Parse the project from Control resource.
controlName
string
A fully-qualified path representing Control resource.
string | number
{string} A string representing the project.
matchProjectFromModelName(modelName)
matchProjectFromModelName
(
modelName
:
string
)
:
string
|
number
;
Parse the project from Model resource.
modelName
string
A fully-qualified path representing Model resource.
string | number
{string} A string representing the project.
matchProjectFromProductName(productName)
matchProjectFromProductName
(
productName
:
string
)
:
string
|
number
;
Parse the project from Product resource.
productName
string
A fully-qualified path representing Product resource.
string | number
{string} A string representing the project.
matchProjectFromServingConfigName(servingConfigName)
matchProjectFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the project from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
string | number
{string} A string representing the project.
matchServingConfigFromServingConfigName(servingConfigName)
matchServingConfigFromServingConfigName
(
servingConfigName
:
string
)
:
string
|
number
;
Parse the serving_config from ServingConfig resource.
servingConfigName
string
A fully-qualified path representing ServingConfig resource.
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.
project
string
location
string
catalog
string
model
string
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.
project
string
location
string
catalog
string
branch
string
product
string
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.
project
string
location
string
catalog
string
servingConfig
string
string
{string} Resource name string.
