import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * Service for ingesting {@link protos.google.cloud.retail.v2.Product|Product} information * of the customer's website. * @class * @memberof v2 */ export declare class ProductServiceClient { private _terminated; private _opts; private _providedCustomServicePath; private _gaxModule; private _gaxGrpc; private _protos; private _defaults; private _universeDomain; private _servicePath; private _log; auth: gax.GoogleAuth; descriptors: Descriptors; warn: (code: string, message: string, warnType?: string) => void; innerApiCalls: { [name: string]: Function; }; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; productServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of ProductServiceClient. * * @param {object} [options] - The configuration object. * The options accepted by the constructor are described in detail * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance). * The common options are: * @param {object} [options.credentials] - Credentials object. * @param {string} [options.credentials.client_email] * @param {string} [options.credentials.private_key] * @param {string} [options.email] - Account email address. Required when * using a .pem or .p12 keyFilename. * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or * .p12 key downloaded from the Google Developers Console. If you provide * a path to a JSON file, the projectId option below is not necessary. * NOTE: .pem and .p12 require you to specify options.email as well. * @param {number} [options.port] - The port on which to connect to * the remote host. * @param {string} [options.projectId] - The project ID from the Google * Developer's Console, e.g. 'grape-spaceship-123'. We will also check * the environment variable GCLOUD_PROJECT for your project ID. If your * app is running in an environment which supports * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials}, * your project ID will be detected automatically. * @param {string} [options.apiEndpoint] - The domain name of the * API remote host. * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override. * Follows the structure of {@link gapicConfig}. * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode. * For more information, please check the * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}. * @param {gax} [gaxInstance]: 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 ProductServiceClient({fallback: true}, gax); * ``` */ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback); /** * 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 {Promise} A promise that resolves to an authenticated service stub. */ initialize(): Promise<{ [name: string]: Function; }>; /** * The DNS address for this API service. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get servicePath(): string; /** * The DNS address for this API service - same as servicePath. * @deprecated Use the apiEndpoint method of the client instance. * @returns {string} The DNS address for this service. */ static get apiEndpoint(): string; /** * The DNS address for this API service. * @returns {string} The DNS address for this service. */ get apiEndpoint(): string; get universeDomain(): string; /** * The port for this API service. * @returns {number} The default port for this service. */ static get port(): number; /** * The scopes needed to make gRPC calls for every method defined * in this service. * @returns {string[]} List of default scopes. */ static get scopes(): string[]; getProjectId(): Promise; getProjectId(callback: Callback): void; /** * Creates a {@link protos.google.cloud.retail.v2.Product|Product}. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent catalog resource name, such as * `projects/* /locations/global/catalogs/default_catalog/branches/default_branch`. * @param {google.cloud.retail.v2.Product} request.product * Required. The {@link protos.google.cloud.retail.v2.Product|Product} to create. * @param {string} request.productId * Required. The ID to use for the {@link protos.google.cloud.retail.v2.Product|Product}, * which will become the final component of the * {@link protos.google.cloud.retail.v2.Product.name|Product.name}. * * If the caller does not have permission to create the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * * This field must be unique among all * {@link protos.google.cloud.retail.v2.Product|Product}s with the same * {@link protos.google.cloud.retail.v2.CreateProductRequest.parent|parent}. Otherwise, an * ALREADY_EXISTS error is returned. * * This field must be a UTF-8 encoded string with a length limit of 128 * characters. Otherwise, an INVALID_ARGUMENT error is returned. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.retail.v2.Product|Product}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.create_product.js * region_tag:retail_v2_generated_ProductService_CreateProduct_async */ createProduct(request?: protos.google.cloud.retail.v2.ICreateProductRequest, options?: CallOptions): Promise<[ protos.google.cloud.retail.v2.IProduct, protos.google.cloud.retail.v2.ICreateProductRequest | undefined, {} | undefined ]>; createProduct(request: protos.google.cloud.retail.v2.ICreateProductRequest, options: CallOptions, callback: Callback): void; createProduct(request: protos.google.cloud.retail.v2.ICreateProductRequest, callback: Callback): void; /** * Gets a {@link protos.google.cloud.retail.v2.Product|Product}. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Full resource name of {@link protos.google.cloud.retail.v2.Product|Product}, * such as * `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. * * If the caller does not have permission to access the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * * If the requested {@link protos.google.cloud.retail.v2.Product|Product} does not exist, * a NOT_FOUND error is returned. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.retail.v2.Product|Product}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.get_product.js * region_tag:retail_v2_generated_ProductService_GetProduct_async */ getProduct(request?: protos.google.cloud.retail.v2.IGetProductRequest, options?: CallOptions): Promise<[ protos.google.cloud.retail.v2.IProduct, protos.google.cloud.retail.v2.IGetProductRequest | undefined, {} | undefined ]>; getProduct(request: protos.google.cloud.retail.v2.IGetProductRequest, options: CallOptions, callback: Callback): void; getProduct(request: protos.google.cloud.retail.v2.IGetProductRequest, callback: Callback): void; /** * Updates a {@link protos.google.cloud.retail.v2.Product|Product}. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.retail.v2.Product} request.product * Required. The product to update/create. * * If the caller does not have permission to update the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * * If the {@link protos.google.cloud.retail.v2.Product|Product} to update does not exist * and * {@link protos.google.cloud.retail.v2.UpdateProductRequest.allow_missing|allow_missing} * is not set, a NOT_FOUND error is returned. * @param {google.protobuf.FieldMask} request.updateMask * Indicates which fields in the provided * {@link protos.google.cloud.retail.v2.Product|Product} to update. The immutable and * output only fields are NOT supported. If not set, all supported fields (the * fields that are neither immutable nor output only) are updated. * * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error * is returned. * * The attribute key can be updated by setting the mask path as * "attributes.${key_name}". If a key name is present in the mask but not in * the patching product from the request, this key will be deleted after the * update. * @param {boolean} request.allowMissing * If set to true, and the {@link protos.google.cloud.retail.v2.Product|Product} is not * found, a new {@link protos.google.cloud.retail.v2.Product|Product} will be created. In * this situation, `update_mask` is ignored. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.cloud.retail.v2.Product|Product}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.update_product.js * region_tag:retail_v2_generated_ProductService_UpdateProduct_async */ updateProduct(request?: protos.google.cloud.retail.v2.IUpdateProductRequest, options?: CallOptions): Promise<[ protos.google.cloud.retail.v2.IProduct, protos.google.cloud.retail.v2.IUpdateProductRequest | undefined, {} | undefined ]>; updateProduct(request: protos.google.cloud.retail.v2.IUpdateProductRequest, options: CallOptions, callback: Callback): void; updateProduct(request: protos.google.cloud.retail.v2.IUpdateProductRequest, callback: Callback): void; /** * Deletes a {@link protos.google.cloud.retail.v2.Product|Product}. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. Full resource name of {@link protos.google.cloud.retail.v2.Product|Product}, * such as * `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. * * If the caller does not have permission to delete the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * * If the {@link protos.google.cloud.retail.v2.Product|Product} to delete does not exist, * a NOT_FOUND error is returned. * * The {@link protos.google.cloud.retail.v2.Product|Product} to delete can neither be a * {@link protos.google.cloud.retail.v2.Product.Type.COLLECTION|Product.Type.COLLECTION} * {@link protos.google.cloud.retail.v2.Product|Product} member nor a * {@link protos.google.cloud.retail.v2.Product.Type.PRIMARY|Product.Type.PRIMARY} * {@link protos.google.cloud.retail.v2.Product|Product} with more than one * {@link protos.google.cloud.retail.v2.Product.Type.VARIANT|variants}. Otherwise, an * INVALID_ARGUMENT error is returned. * * All inventory information for the named * {@link protos.google.cloud.retail.v2.Product|Product} will be deleted. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.delete_product.js * region_tag:retail_v2_generated_ProductService_DeleteProduct_async */ deleteProduct(request?: protos.google.cloud.retail.v2.IDeleteProductRequest, options?: CallOptions): Promise<[ protos.google.protobuf.IEmpty, protos.google.cloud.retail.v2.IDeleteProductRequest | undefined, {} | undefined ]>; deleteProduct(request: protos.google.cloud.retail.v2.IDeleteProductRequest, options: CallOptions, callback: Callback): void; deleteProduct(request: protos.google.cloud.retail.v2.IDeleteProductRequest, callback: Callback): void; /** * Permanently deletes all selected {@link protos.google.cloud.retail.v2.Product|Product}s * under a branch. * * This process is asynchronous. If the request is valid, the removal will be * enqueued and processed offline. Depending on the number of * {@link protos.google.cloud.retail.v2.Product|Product}s, this operation could take hours * to complete. Before the operation completes, some * {@link protos.google.cloud.retail.v2.Product|Product}s may still be returned by * {@link protos.google.cloud.retail.v2.ProductService.GetProduct|ProductService.GetProduct} * or * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts}. * * Depending on the number of {@link protos.google.cloud.retail.v2.Product|Product}s, this * operation could take hours to complete. To get a sample of * {@link protos.google.cloud.retail.v2.Product|Product}s that would be deleted, set * {@link protos.google.cloud.retail.v2.PurgeProductsRequest.force|PurgeProductsRequest.force} * to false. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The resource name of the branch under which the products are * created. The format is * `projects/${projectId}/locations/global/catalogs/${catalogId}/branches/${branchId}` * @param {string} request.filter * Required. The filter string to specify the products to be deleted with a * length limit of 5,000 characters. * * Empty string filter is not allowed. "*" implies delete all items in a * branch. * * The eligible fields for filtering are: * * * `availability`: Double quoted * {@link protos.google.cloud.retail.v2.Product.availability|Product.availability} string. * * `create_time` : in ISO 8601 "zulu" format. * * Supported syntax: * * * Comparators (">", "<", ">=", "<=", "="). * Examples: * * create_time <= "2015-02-13T17:05:46Z" * * availability = "IN_STOCK" * * * Conjunctions ("AND") * Examples: * * create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER" * * * Disjunctions ("OR") * Examples: * * create_time <= "2015-02-13T17:05:46Z" OR availability = "IN_STOCK" * * * Can support nested queries. * Examples: * * (create_time <= "2015-02-13T17:05:46Z" AND availability = "PREORDER") * OR (create_time >= "2015-02-14T13:03:32Z" AND availability = "IN_STOCK") * * * Filter Limits: * * Filter should not contain more than 6 conditions. * * Max nesting depth should not exceed 2 levels. * * Examples queries: * * Delete back order products created before a timestamp. * create_time <= "2015-02-13T17:05:46Z" OR availability = "BACKORDER" * @param {boolean} request.force * Actually perform the purge. * If `force` is set to false, the method will return the expected purge count * without deleting any products. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.purge_products.js * region_tag:retail_v2_generated_ProductService_PurgeProducts_async */ purgeProducts(request?: protos.google.cloud.retail.v2.IPurgeProductsRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; purgeProducts(request: protos.google.cloud.retail.v2.IPurgeProductsRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; purgeProducts(request: protos.google.cloud.retail.v2.IPurgeProductsRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `purgeProducts()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.purge_products.js * region_tag:retail_v2_generated_ProductService_PurgeProducts_async */ checkPurgeProductsProgress(name: string): Promise>; /** * Bulk import of multiple {@link protos.google.cloud.retail.v2.Product|Product}s. * * Request processing may be synchronous. * Non-existing items are created. * * Note that it is possible for a subset of the * {@link protos.google.cloud.retail.v2.Product|Product}s to be successfully updated. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. * `projects/1234/locations/global/catalogs/default_catalog/branches/default_branch` * * If no updateMask is specified, requires products.create permission. * If updateMask is specified, requires products.update permission. * @param {string} request.requestId * Deprecated. This field has no effect. * @param {google.cloud.retail.v2.ProductInputConfig} request.inputConfig * Required. The desired input location of the data. * @param {google.cloud.retail.v2.ImportErrorsConfig} request.errorsConfig * The desired location of errors incurred during the Import. * @param {google.protobuf.FieldMask} request.updateMask * Indicates which fields in the provided imported `products` to update. If * not set, all fields are updated. If provided, only the existing product * fields are updated. Missing products will not be created. * @param {google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode} request.reconciliationMode * The mode of reconciliation between existing products and the products to be * imported. Defaults to * {@link protos.google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}. * @param {string} request.notificationPubsubTopic * Full Pub/Sub topic name 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 * {@link protos.google.longrunning.Operation|Operation}. * * Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`. It has * to be within the same project as * {@link protos.google.cloud.retail.v2.ImportProductsRequest.parent|ImportProductsRequest.parent}. * Make sure that both * `cloud-retail-customer-data-access@system.gserviceaccount.com` and * `service-@gcp-sa-retail.iam.gserviceaccount.com` * have the `pubsub.topics.publish` IAM permission on the topic. * * Only supported when * {@link protos.google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode|ImportProductsRequest.reconciliation_mode} * is set to `FULL`. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.import_products.js * region_tag:retail_v2_generated_ProductService_ImportProducts_async */ importProducts(request?: protos.google.cloud.retail.v2.IImportProductsRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; importProducts(request: protos.google.cloud.retail.v2.IImportProductsRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; importProducts(request: protos.google.cloud.retail.v2.IImportProductsRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `importProducts()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.import_products.js * region_tag:retail_v2_generated_ProductService_ImportProducts_async */ checkImportProductsProgress(name: string): Promise>; /** * Updates inventory information for a * {@link protos.google.cloud.retail.v2.Product|Product} while respecting the last update * timestamps of each inventory field. * * This process is asynchronous and does not require the * {@link protos.google.cloud.retail.v2.Product|Product} to exist before updating * fulfillment information. If the request is valid, the update is enqueued * and processed downstream. As a consequence, when a response is returned, * updates are not immediately manifested in the * {@link protos.google.cloud.retail.v2.Product|Product} queried by * {@link protos.google.cloud.retail.v2.ProductService.GetProduct|ProductService.GetProduct} * or * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts}. * * When inventory is updated with * {@link protos.google.cloud.retail.v2.ProductService.CreateProduct|ProductService.CreateProduct} * and * {@link protos.google.cloud.retail.v2.ProductService.UpdateProduct|ProductService.UpdateProduct}, * the specified inventory field value(s) overwrite any existing value(s) * while ignoring the last update time for this field. Furthermore, the last * update times for the specified inventory fields are overwritten by the * times of the * {@link protos.google.cloud.retail.v2.ProductService.CreateProduct|ProductService.CreateProduct} * or * {@link protos.google.cloud.retail.v2.ProductService.UpdateProduct|ProductService.UpdateProduct} * request. * * If no inventory fields are set in * {@link protos.google.cloud.retail.v2.CreateProductRequest.product|CreateProductRequest.product}, * then any pre-existing inventory information for this product is used. * * If no inventory fields are set in * {@link protos.google.cloud.retail.v2.SetInventoryRequest.set_mask|SetInventoryRequest.set_mask}, * then any existing inventory information is preserved. * * Pre-existing inventory information can only be updated with * {@link protos.google.cloud.retail.v2.ProductService.SetInventory|ProductService.SetInventory}, * {@link protos.google.cloud.retail.v2.ProductService.AddFulfillmentPlaces|ProductService.AddFulfillmentPlaces}, * and * {@link protos.google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces|ProductService.RemoveFulfillmentPlaces}. * * The returned {@link protos.google.longrunning.Operation|Operation}s is obsolete after * one day, and the {@link protos.google.longrunning.Operations.GetOperation|GetOperation} * API returns `NOT_FOUND` afterwards. * * If conflicting updates are issued, the * {@link protos.google.longrunning.Operation|Operation}s associated with the stale * updates are not marked as {@link protos.google.longrunning.Operation.done|done} until * they are obsolete. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.retail.v2.Product} request.inventory * Required. The inventory information to update. The allowable fields to * update are: * * * {@link protos.google.cloud.retail.v2.Product.price_info|Product.price_info} * * {@link protos.google.cloud.retail.v2.Product.availability|Product.availability} * * {@link protos.google.cloud.retail.v2.Product.available_quantity|Product.available_quantity} * * {@link protos.google.cloud.retail.v2.Product.fulfillment_info|Product.fulfillment_info} * The updated inventory fields must be specified in * {@link protos.google.cloud.retail.v2.SetInventoryRequest.set_mask|SetInventoryRequest.set_mask}. * * If * {@link protos.google.cloud.retail.v2.Product.name|SetInventoryRequest.inventory.name} * is empty or invalid, an INVALID_ARGUMENT error is returned. * * If the caller does not have permission to update the * {@link protos.google.cloud.retail.v2.Product|Product} named in * {@link protos.google.cloud.retail.v2.Product.name|Product.name}, regardless of whether * or not it exists, a PERMISSION_DENIED error is returned. * * If the {@link protos.google.cloud.retail.v2.Product|Product} to update does not have * existing inventory information, the provided inventory information will be * inserted. * * If the {@link protos.google.cloud.retail.v2.Product|Product} to update has existing * inventory information, the provided inventory information will be merged * while respecting the last update time for each inventory field, using the * provided or default value for * {@link protos.google.cloud.retail.v2.SetInventoryRequest.set_time|SetInventoryRequest.set_time}. * * The caller can replace place IDs for a subset of fulfillment types in the * following ways: * * * Adds "fulfillment_info" in * {@link protos.google.cloud.retail.v2.SetInventoryRequest.set_mask|SetInventoryRequest.set_mask} * * Specifies only the desired fulfillment types and corresponding place IDs * to update in * {@link protos.google.cloud.retail.v2.Product.fulfillment_info|SetInventoryRequest.inventory.fulfillment_info} * * The caller can clear all place IDs from a subset of fulfillment types in * the following ways: * * * Adds "fulfillment_info" in * {@link protos.google.cloud.retail.v2.SetInventoryRequest.set_mask|SetInventoryRequest.set_mask} * * Specifies only the desired fulfillment types to clear in * {@link protos.google.cloud.retail.v2.Product.fulfillment_info|SetInventoryRequest.inventory.fulfillment_info} * * Checks that only the desired fulfillment info types have empty * {@link protos.google.cloud.retail.v2.FulfillmentInfo.place_ids|SetInventoryRequest.inventory.fulfillment_info.place_ids} * * The last update time is recorded for the following inventory fields: * * {@link protos.google.cloud.retail.v2.Product.price_info|Product.price_info} * * {@link protos.google.cloud.retail.v2.Product.availability|Product.availability} * * {@link protos.google.cloud.retail.v2.Product.available_quantity|Product.available_quantity} * * {@link protos.google.cloud.retail.v2.Product.fulfillment_info|Product.fulfillment_info} * * If a full overwrite of inventory information while ignoring timestamps is * needed, * {@link protos.google.cloud.retail.v2.ProductService.UpdateProduct|ProductService.UpdateProduct} * should be invoked instead. * @param {google.protobuf.FieldMask} request.setMask * Indicates which inventory fields in the provided * {@link protos.google.cloud.retail.v2.Product|Product} to update. * * At least one field must be provided. * * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error * is returned and the entire update will be ignored. * @param {google.protobuf.Timestamp} request.setTime * The time when the request is issued, used to prevent * out-of-order updates on inventory fields with the last update time * recorded. If not provided, the internal system time will be used. * @param {boolean} request.allowMissing * If set to true, and the {@link protos.google.cloud.retail.v2.Product|Product} with name * {@link protos.google.cloud.retail.v2.Product.name|Product.name} is not found, the * inventory update will still be processed and retained for at most 1 day * until the {@link protos.google.cloud.retail.v2.Product|Product} is created. If set to * false, a NOT_FOUND error is returned if the * {@link protos.google.cloud.retail.v2.Product|Product} is not found. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.set_inventory.js * region_tag:retail_v2_generated_ProductService_SetInventory_async */ setInventory(request?: protos.google.cloud.retail.v2.ISetInventoryRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; setInventory(request: protos.google.cloud.retail.v2.ISetInventoryRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; setInventory(request: protos.google.cloud.retail.v2.ISetInventoryRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `setInventory()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.set_inventory.js * region_tag:retail_v2_generated_ProductService_SetInventory_async */ checkSetInventoryProgress(name: string): Promise>; /** * We recommend that you use the * {@link protos.google.cloud.retail.v2.ProductService.AddLocalInventories|ProductService.AddLocalInventories} * method instead of the * {@link protos.google.cloud.retail.v2.ProductService.AddFulfillmentPlaces|ProductService.AddFulfillmentPlaces} * method. * {@link protos.google.cloud.retail.v2.ProductService.AddLocalInventories|ProductService.AddLocalInventories} * achieves the same results but provides more fine-grained control over * ingesting local inventory data. * * Incrementally adds place IDs to * {@link protos.google.cloud.retail.v2.FulfillmentInfo.place_ids|Product.fulfillment_info.place_ids}. * * This process is asynchronous and does not require the * {@link protos.google.cloud.retail.v2.Product|Product} to exist before updating * fulfillment information. If the request is valid, the update will be * enqueued and processed downstream. As a consequence, when a response is * returned, the added place IDs are not immediately manifested in the * {@link protos.google.cloud.retail.v2.Product|Product} queried by * {@link protos.google.cloud.retail.v2.ProductService.GetProduct|ProductService.GetProduct} * or * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts}. * * The returned {@link protos.google.longrunning.Operation|Operation}s will be obsolete * after 1 day, and {@link protos.google.longrunning.Operations.GetOperation|GetOperation} * API will return NOT_FOUND afterwards. * * If conflicting updates are issued, the * {@link protos.google.longrunning.Operation|Operation}s associated with the stale * updates will not be marked as {@link protos.google.longrunning.Operation.done|done} * until being obsolete. * * @param {Object} request * The request object that will be sent. * @param {string} request.product * Required. Full resource name of {@link protos.google.cloud.retail.v2.Product|Product}, * such as * `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. * * If the caller does not have permission to access the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * @param {string} request.type * Required. The fulfillment type, including commonly used types (such as * pickup in store and same day delivery), and custom types. * * Supported values: * * * "pickup-in-store" * * "ship-to-store" * * "same-day-delivery" * * "next-day-delivery" * * "custom-type-1" * * "custom-type-2" * * "custom-type-3" * * "custom-type-4" * * "custom-type-5" * * If this field is set to an invalid value other than these, an * INVALID_ARGUMENT error is returned. * * This field directly corresponds to * {@link protos.google.cloud.retail.v2.FulfillmentInfo.type|Product.fulfillment_info.type}. * @param {string[]} request.placeIds * Required. The IDs for this * {@link protos.google.cloud.retail.v2.AddFulfillmentPlacesRequest.type|type}, such as * the store IDs for "pickup-in-store" or the region IDs for * "same-day-delivery" to be added for this * {@link protos.google.cloud.retail.v2.AddFulfillmentPlacesRequest.type|type}. Duplicate * IDs will be automatically ignored. * * At least 1 value is required, and a maximum of 2000 values are allowed. * Each value must be a string with a length limit of 10 characters, matching * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an * INVALID_ARGUMENT error is returned. * * If the total number of place IDs exceeds 2000 for this * {@link protos.google.cloud.retail.v2.AddFulfillmentPlacesRequest.type|type} after * adding, then the update will be rejected. * @param {google.protobuf.Timestamp} request.addTime * The time when the fulfillment updates are issued, used to prevent * out-of-order updates on fulfillment information. If not provided, the * internal system time will be used. * @param {boolean} request.allowMissing * If set to true, and the {@link protos.google.cloud.retail.v2.Product|Product} is not * found, the fulfillment information will still be processed and retained for * at most 1 day and processed once the * {@link protos.google.cloud.retail.v2.Product|Product} is created. If set to false, a * NOT_FOUND error is returned if the * {@link protos.google.cloud.retail.v2.Product|Product} is not found. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.add_fulfillment_places.js * region_tag:retail_v2_generated_ProductService_AddFulfillmentPlaces_async */ addFulfillmentPlaces(request?: protos.google.cloud.retail.v2.IAddFulfillmentPlacesRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; addFulfillmentPlaces(request: protos.google.cloud.retail.v2.IAddFulfillmentPlacesRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; addFulfillmentPlaces(request: protos.google.cloud.retail.v2.IAddFulfillmentPlacesRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `addFulfillmentPlaces()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.add_fulfillment_places.js * region_tag:retail_v2_generated_ProductService_AddFulfillmentPlaces_async */ checkAddFulfillmentPlacesProgress(name: string): Promise>; /** * We recommend that you use the * {@link protos.google.cloud.retail.v2.ProductService.RemoveLocalInventories|ProductService.RemoveLocalInventories} * method instead of the * {@link protos.google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces|ProductService.RemoveFulfillmentPlaces} * method. * {@link protos.google.cloud.retail.v2.ProductService.RemoveLocalInventories|ProductService.RemoveLocalInventories} * achieves the same results but provides more fine-grained control over * ingesting local inventory data. * * Incrementally removes place IDs from a * {@link protos.google.cloud.retail.v2.FulfillmentInfo.place_ids|Product.fulfillment_info.place_ids}. * * This process is asynchronous and does not require the * {@link protos.google.cloud.retail.v2.Product|Product} to exist before updating * fulfillment information. If the request is valid, the update will be * enqueued and processed downstream. As a consequence, when a response is * returned, the removed place IDs are not immediately manifested in the * {@link protos.google.cloud.retail.v2.Product|Product} queried by * {@link protos.google.cloud.retail.v2.ProductService.GetProduct|ProductService.GetProduct} * or * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts}. * * The returned {@link protos.google.longrunning.Operation|Operation}s will be obsolete * after 1 day, and {@link protos.google.longrunning.Operations.GetOperation|GetOperation} * API will return NOT_FOUND afterwards. * * If conflicting updates are issued, the * {@link protos.google.longrunning.Operation|Operation}s associated with the stale * updates will not be marked as {@link protos.google.longrunning.Operation.done|done} * until being obsolete. * * @param {Object} request * The request object that will be sent. * @param {string} request.product * Required. Full resource name of {@link protos.google.cloud.retail.v2.Product|Product}, * such as * `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. * * If the caller does not have permission to access the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * @param {string} request.type * Required. The fulfillment type, including commonly used types (such as * pickup in store and same day delivery), and custom types. * * Supported values: * * * "pickup-in-store" * * "ship-to-store" * * "same-day-delivery" * * "next-day-delivery" * * "custom-type-1" * * "custom-type-2" * * "custom-type-3" * * "custom-type-4" * * "custom-type-5" * * If this field is set to an invalid value other than these, an * INVALID_ARGUMENT error is returned. * * This field directly corresponds to * {@link protos.google.cloud.retail.v2.FulfillmentInfo.type|Product.fulfillment_info.type}. * @param {string[]} request.placeIds * Required. The IDs for this * {@link protos.google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type|type}, such as * the store IDs for "pickup-in-store" or the region IDs for * "same-day-delivery", to be removed for this * {@link protos.google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type|type}. * * At least 1 value is required, and a maximum of 2000 values are allowed. * Each value must be a string with a length limit of 10 characters, matching * the pattern `[a-zA-Z0-9_-]+`, such as "store1" or "REGION-2". Otherwise, an * INVALID_ARGUMENT error is returned. * @param {google.protobuf.Timestamp} request.removeTime * The time when the fulfillment updates are issued, used to prevent * out-of-order updates on fulfillment information. If not provided, the * internal system time will be used. * @param {boolean} request.allowMissing * If set to true, and the {@link protos.google.cloud.retail.v2.Product|Product} is not * found, the fulfillment information will still be processed and retained for * at most 1 day and processed once the * {@link protos.google.cloud.retail.v2.Product|Product} is created. If set to false, a * NOT_FOUND error is returned if the * {@link protos.google.cloud.retail.v2.Product|Product} is not found. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.remove_fulfillment_places.js * region_tag:retail_v2_generated_ProductService_RemoveFulfillmentPlaces_async */ removeFulfillmentPlaces(request?: protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; removeFulfillmentPlaces(request: protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; removeFulfillmentPlaces(request: protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `removeFulfillmentPlaces()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.remove_fulfillment_places.js * region_tag:retail_v2_generated_ProductService_RemoveFulfillmentPlaces_async */ checkRemoveFulfillmentPlacesProgress(name: string): Promise>; /** * Updates local inventory information for a * {@link protos.google.cloud.retail.v2.Product|Product} at a list of places, while * respecting the last update timestamps of each inventory field. * * This process is asynchronous and does not require the * {@link protos.google.cloud.retail.v2.Product|Product} to exist before updating * inventory information. If the request is valid, the update will be enqueued * and processed downstream. As a consequence, when a response is returned, * updates are not immediately manifested in the * {@link protos.google.cloud.retail.v2.Product|Product} queried by * {@link protos.google.cloud.retail.v2.ProductService.GetProduct|ProductService.GetProduct} * or * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts}. * * Local inventory information can only be modified using this method. * {@link protos.google.cloud.retail.v2.ProductService.CreateProduct|ProductService.CreateProduct} * and * {@link protos.google.cloud.retail.v2.ProductService.UpdateProduct|ProductService.UpdateProduct} * has no effect on local inventories. * * The returned {@link protos.google.longrunning.Operation|Operation}s will be obsolete * after 1 day, and {@link protos.google.longrunning.Operations.GetOperation|GetOperation} * API will return NOT_FOUND afterwards. * * If conflicting updates are issued, the * {@link protos.google.longrunning.Operation|Operation}s associated with the stale * updates will not be marked as {@link protos.google.longrunning.Operation.done|done} * until being obsolete. * * @param {Object} request * The request object that will be sent. * @param {string} request.product * Required. Full resource name of {@link protos.google.cloud.retail.v2.Product|Product}, * such as * `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. * * If the caller does not have permission to access the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * @param {number[]} request.localInventories * Required. A list of inventory information at difference places. Each place * is identified by its place ID. At most 3000 inventories are allowed per * request. * @param {google.protobuf.FieldMask} request.addMask * Indicates which inventory fields in the provided list of * {@link protos.google.cloud.retail.v2.LocalInventory|LocalInventory} to update. The * field is updated to the provided value. * * If a field is set while the place does not have a previous local inventory, * the local inventory at that store is created. * * If a field is set while the value of that field is not provided, the * original field value, if it exists, is deleted. * * If the mask is not set or set with empty paths, all inventory fields will * be updated. * * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error * is returned and the entire update will be ignored. * @param {google.protobuf.Timestamp} request.addTime * The time when the inventory updates are issued. Used to prevent * out-of-order updates on local inventory fields. If not provided, the * internal system time will be used. * @param {boolean} request.allowMissing * If set to true, and the {@link protos.google.cloud.retail.v2.Product|Product} is not * found, the local inventory will still be processed and retained for at most * 1 day and processed once the {@link protos.google.cloud.retail.v2.Product|Product} is * created. If set to false, a NOT_FOUND error is returned if the * {@link protos.google.cloud.retail.v2.Product|Product} is not found. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.add_local_inventories.js * region_tag:retail_v2_generated_ProductService_AddLocalInventories_async */ addLocalInventories(request?: protos.google.cloud.retail.v2.IAddLocalInventoriesRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; addLocalInventories(request: protos.google.cloud.retail.v2.IAddLocalInventoriesRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; addLocalInventories(request: protos.google.cloud.retail.v2.IAddLocalInventoriesRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `addLocalInventories()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.add_local_inventories.js * region_tag:retail_v2_generated_ProductService_AddLocalInventories_async */ checkAddLocalInventoriesProgress(name: string): Promise>; /** * Remove local inventory information for a * {@link protos.google.cloud.retail.v2.Product|Product} at a list of places at a removal * timestamp. * * This process is asynchronous. If the request is valid, the removal will be * enqueued and processed downstream. As a consequence, when a response is * returned, removals are not immediately manifested in the * {@link protos.google.cloud.retail.v2.Product|Product} queried by * {@link protos.google.cloud.retail.v2.ProductService.GetProduct|ProductService.GetProduct} * or * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts}. * * Local inventory information can only be removed using this method. * {@link protos.google.cloud.retail.v2.ProductService.CreateProduct|ProductService.CreateProduct} * and * {@link protos.google.cloud.retail.v2.ProductService.UpdateProduct|ProductService.UpdateProduct} * has no effect on local inventories. * * The returned {@link protos.google.longrunning.Operation|Operation}s will be obsolete * after 1 day, and {@link protos.google.longrunning.Operations.GetOperation|GetOperation} * API will return NOT_FOUND afterwards. * * If conflicting updates are issued, the * {@link protos.google.longrunning.Operation|Operation}s associated with the stale * updates will not be marked as {@link protos.google.longrunning.Operation.done|done} * until being obsolete. * * @param {Object} request * The request object that will be sent. * @param {string} request.product * Required. Full resource name of {@link protos.google.cloud.retail.v2.Product|Product}, * such as * `projects/* /locations/global/catalogs/default_catalog/branches/default_branch/products/some_product_id`. * * If the caller does not have permission to access the * {@link protos.google.cloud.retail.v2.Product|Product}, regardless of whether or not it * exists, a PERMISSION_DENIED error is returned. * @param {string[]} request.placeIds * Required. A list of place IDs to have their inventory deleted. * At most 3000 place IDs are allowed per request. * @param {google.protobuf.Timestamp} request.removeTime * The time when the inventory deletions are issued. Used to prevent * out-of-order updates and deletions on local inventory fields. If not * provided, the internal system time will be used. * @param {boolean} request.allowMissing * If set to true, and the {@link protos.google.cloud.retail.v2.Product|Product} is not * found, the local inventory removal request will still be processed and * retained for at most 1 day and processed once the * {@link protos.google.cloud.retail.v2.Product|Product} is created. If set to false, a * NOT_FOUND error is returned if the * {@link protos.google.cloud.retail.v2.Product|Product} is not found. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.remove_local_inventories.js * region_tag:retail_v2_generated_ProductService_RemoveLocalInventories_async */ removeLocalInventories(request?: protos.google.cloud.retail.v2.IRemoveLocalInventoriesRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; removeLocalInventories(request: protos.google.cloud.retail.v2.IRemoveLocalInventoriesRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; removeLocalInventories(request: protos.google.cloud.retail.v2.IRemoveLocalInventoriesRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `removeLocalInventories()`. * @param {String} name * The operation name that will be passed. * @returns {Promise} - The promise which resolves to an object. * The decoded operation object has result and metadata field to get information from. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.remove_local_inventories.js * region_tag:retail_v2_generated_ProductService_RemoveLocalInventories_async */ checkRemoveLocalInventoriesProgress(name: string): Promise>; /** * Gets a list of {@link protos.google.cloud.retail.v2.Product|Product}s. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent branch resource name, such as * `projects/* /locations/global/catalogs/default_catalog/branches/0`. Use * `default_branch` as the branch ID, to list products under the default * branch. * * If the caller does not have permission to list * {@link protos.google.cloud.retail.v2.Product|Product}s under this branch, regardless of * whether or not this branch exists, a PERMISSION_DENIED error is returned. * @param {number} request.pageSize * Maximum number of {@link protos.google.cloud.retail.v2.Product|Product}s to return. If * unspecified, defaults to 100. The maximum allowed value is 1000. Values * above 1000 will be coerced to 1000. * * If this field is negative, an INVALID_ARGUMENT error is returned. * @param {string} request.pageToken * A page token * {@link protos.google.cloud.retail.v2.ListProductsResponse.next_page_token|ListProductsResponse.next_page_token}, * received from a previous * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts} * must match the call that provided the page token. Otherwise, an * INVALID_ARGUMENT error is returned. * @param {string} request.filter * A filter to apply on the list results. Supported features: * * * List all the products under the parent branch if * {@link protos.google.cloud.retail.v2.ListProductsRequest.filter|filter} is unset. * * List {@link protos.google.cloud.retail.v2.Product.Type.VARIANT|Product.Type.VARIANT} * {@link protos.google.cloud.retail.v2.Product|Product}s sharing the same * {@link protos.google.cloud.retail.v2.Product.Type.PRIMARY|Product.Type.PRIMARY} * {@link protos.google.cloud.retail.v2.Product|Product}. For example: * `primary_product_id = "some_product_id"` * * List {@link protos.google.cloud.retail.v2.Product|Product}s bundled in a * {@link protos.google.cloud.retail.v2.Product.Type.COLLECTION|Product.Type.COLLECTION} * {@link protos.google.cloud.retail.v2.Product|Product}. * For example: * `collection_product_id = "some_product_id"` * * List {@link protos.google.cloud.retail.v2.Product|Product}s with a partibular type. * For example: * `type = "PRIMARY"` * `type = "VARIANT"` * `type = "COLLECTION"` * * If the field is unrecognizable, an INVALID_ARGUMENT error is returned. * * If the specified * {@link protos.google.cloud.retail.v2.Product.Type.PRIMARY|Product.Type.PRIMARY} * {@link protos.google.cloud.retail.v2.Product|Product} or * {@link protos.google.cloud.retail.v2.Product.Type.COLLECTION|Product.Type.COLLECTION} * {@link protos.google.cloud.retail.v2.Product|Product} does not exist, a NOT_FOUND error * is returned. * @param {google.protobuf.FieldMask} request.readMask * The fields of {@link protos.google.cloud.retail.v2.Product|Product} to return in the * responses. If not set or empty, the following fields are returned: * * * {@link protos.google.cloud.retail.v2.Product.name|Product.name} * * {@link protos.google.cloud.retail.v2.Product.id|Product.id} * * {@link protos.google.cloud.retail.v2.Product.title|Product.title} * * {@link protos.google.cloud.retail.v2.Product.uri|Product.uri} * * {@link protos.google.cloud.retail.v2.Product.images|Product.images} * * {@link protos.google.cloud.retail.v2.Product.price_info|Product.price_info} * * {@link protos.google.cloud.retail.v2.Product.brands|Product.brands} * * If "*" is provided, all fields are returned. * {@link protos.google.cloud.retail.v2.Product.name|Product.name} is always returned no * matter what mask is set. * * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error * is returned. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is Array of {@link protos.google.cloud.retail.v2.Product|Product}. * 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 `listProductsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listProducts(request?: protos.google.cloud.retail.v2.IListProductsRequest, options?: CallOptions): Promise<[ protos.google.cloud.retail.v2.IProduct[], protos.google.cloud.retail.v2.IListProductsRequest | null, protos.google.cloud.retail.v2.IListProductsResponse ]>; listProducts(request: protos.google.cloud.retail.v2.IListProductsRequest, options: CallOptions, callback: PaginationCallback): void; listProducts(request: protos.google.cloud.retail.v2.IListProductsRequest, callback: PaginationCallback): void; /** * Equivalent to `listProducts`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent branch resource name, such as * `projects/* /locations/global/catalogs/default_catalog/branches/0`. Use * `default_branch` as the branch ID, to list products under the default * branch. * * If the caller does not have permission to list * {@link protos.google.cloud.retail.v2.Product|Product}s under this branch, regardless of * whether or not this branch exists, a PERMISSION_DENIED error is returned. * @param {number} request.pageSize * Maximum number of {@link protos.google.cloud.retail.v2.Product|Product}s to return. If * unspecified, defaults to 100. The maximum allowed value is 1000. Values * above 1000 will be coerced to 1000. * * If this field is negative, an INVALID_ARGUMENT error is returned. * @param {string} request.pageToken * A page token * {@link protos.google.cloud.retail.v2.ListProductsResponse.next_page_token|ListProductsResponse.next_page_token}, * received from a previous * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts} * must match the call that provided the page token. Otherwise, an * INVALID_ARGUMENT error is returned. * @param {string} request.filter * A filter to apply on the list results. Supported features: * * * List all the products under the parent branch if * {@link protos.google.cloud.retail.v2.ListProductsRequest.filter|filter} is unset. * * List {@link protos.google.cloud.retail.v2.Product.Type.VARIANT|Product.Type.VARIANT} * {@link protos.google.cloud.retail.v2.Product|Product}s sharing the same * {@link protos.google.cloud.retail.v2.Product.Type.PRIMARY|Product.Type.PRIMARY} * {@link protos.google.cloud.retail.v2.Product|Product}. For example: * `primary_product_id = "some_product_id"` * * List {@link protos.google.cloud.retail.v2.Product|Product}s bundled in a * {@link protos.google.cloud.retail.v2.Product.Type.COLLECTION|Product.Type.COLLECTION} * {@link protos.google.cloud.retail.v2.Product|Product}. * For example: * `collection_product_id = "some_product_id"` * * List {@link protos.google.cloud.retail.v2.Product|Product}s with a partibular type. * For example: * `type = "PRIMARY"` * `type = "VARIANT"` * `type = "COLLECTION"` * * If the field is unrecognizable, an INVALID_ARGUMENT error is returned. * * If the specified * {@link protos.google.cloud.retail.v2.Product.Type.PRIMARY|Product.Type.PRIMARY} * {@link protos.google.cloud.retail.v2.Product|Product} or * {@link protos.google.cloud.retail.v2.Product.Type.COLLECTION|Product.Type.COLLECTION} * {@link protos.google.cloud.retail.v2.Product|Product} does not exist, a NOT_FOUND error * is returned. * @param {google.protobuf.FieldMask} request.readMask * The fields of {@link protos.google.cloud.retail.v2.Product|Product} to return in the * responses. If not set or empty, the following fields are returned: * * * {@link protos.google.cloud.retail.v2.Product.name|Product.name} * * {@link protos.google.cloud.retail.v2.Product.id|Product.id} * * {@link protos.google.cloud.retail.v2.Product.title|Product.title} * * {@link protos.google.cloud.retail.v2.Product.uri|Product.uri} * * {@link protos.google.cloud.retail.v2.Product.images|Product.images} * * {@link protos.google.cloud.retail.v2.Product.price_info|Product.price_info} * * {@link protos.google.cloud.retail.v2.Product.brands|Product.brands} * * If "*" is provided, all fields are returned. * {@link protos.google.cloud.retail.v2.Product.name|Product.name} is always returned no * matter what mask is set. * * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error * is returned. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.retail.v2.Product|Product} 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 `listProductsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listProductsStream(request?: protos.google.cloud.retail.v2.IListProductsRequest, options?: CallOptions): Transform; /** * Equivalent to `listProducts`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * Required. The parent branch resource name, such as * `projects/* /locations/global/catalogs/default_catalog/branches/0`. Use * `default_branch` as the branch ID, to list products under the default * branch. * * If the caller does not have permission to list * {@link protos.google.cloud.retail.v2.Product|Product}s under this branch, regardless of * whether or not this branch exists, a PERMISSION_DENIED error is returned. * @param {number} request.pageSize * Maximum number of {@link protos.google.cloud.retail.v2.Product|Product}s to return. If * unspecified, defaults to 100. The maximum allowed value is 1000. Values * above 1000 will be coerced to 1000. * * If this field is negative, an INVALID_ARGUMENT error is returned. * @param {string} request.pageToken * A page token * {@link protos.google.cloud.retail.v2.ListProductsResponse.next_page_token|ListProductsResponse.next_page_token}, * received from a previous * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts} * call. Provide this to retrieve the subsequent page. * * When paginating, all other parameters provided to * {@link protos.google.cloud.retail.v2.ProductService.ListProducts|ProductService.ListProducts} * must match the call that provided the page token. Otherwise, an * INVALID_ARGUMENT error is returned. * @param {string} request.filter * A filter to apply on the list results. Supported features: * * * List all the products under the parent branch if * {@link protos.google.cloud.retail.v2.ListProductsRequest.filter|filter} is unset. * * List {@link protos.google.cloud.retail.v2.Product.Type.VARIANT|Product.Type.VARIANT} * {@link protos.google.cloud.retail.v2.Product|Product}s sharing the same * {@link protos.google.cloud.retail.v2.Product.Type.PRIMARY|Product.Type.PRIMARY} * {@link protos.google.cloud.retail.v2.Product|Product}. For example: * `primary_product_id = "some_product_id"` * * List {@link protos.google.cloud.retail.v2.Product|Product}s bundled in a * {@link protos.google.cloud.retail.v2.Product.Type.COLLECTION|Product.Type.COLLECTION} * {@link protos.google.cloud.retail.v2.Product|Product}. * For example: * `collection_product_id = "some_product_id"` * * List {@link protos.google.cloud.retail.v2.Product|Product}s with a partibular type. * For example: * `type = "PRIMARY"` * `type = "VARIANT"` * `type = "COLLECTION"` * * If the field is unrecognizable, an INVALID_ARGUMENT error is returned. * * If the specified * {@link protos.google.cloud.retail.v2.Product.Type.PRIMARY|Product.Type.PRIMARY} * {@link protos.google.cloud.retail.v2.Product|Product} or * {@link protos.google.cloud.retail.v2.Product.Type.COLLECTION|Product.Type.COLLECTION} * {@link protos.google.cloud.retail.v2.Product|Product} does not exist, a NOT_FOUND error * is returned. * @param {google.protobuf.FieldMask} request.readMask * The fields of {@link protos.google.cloud.retail.v2.Product|Product} to return in the * responses. If not set or empty, the following fields are returned: * * * {@link protos.google.cloud.retail.v2.Product.name|Product.name} * * {@link protos.google.cloud.retail.v2.Product.id|Product.id} * * {@link protos.google.cloud.retail.v2.Product.title|Product.title} * * {@link protos.google.cloud.retail.v2.Product.uri|Product.uri} * * {@link protos.google.cloud.retail.v2.Product.images|Product.images} * * {@link protos.google.cloud.retail.v2.Product.price_info|Product.price_info} * * {@link protos.google.cloud.retail.v2.Product.brands|Product.brands} * * If "*" is provided, all fields are returned. * {@link protos.google.cloud.retail.v2.Product.name|Product.name} is always returned no * matter what mask is set. * * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error * is returned. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.retail.v2.Product|Product}. 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v2/product_service.list_products.js * region_tag:retail_v2_generated_ProductService_ListProducts_async */ listProductsAsync(request?: protos.google.cloud.retail.v2.IListProductsRequest, options?: CallOptions): AsyncIterable; /** * Gets information about a location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Resource name for the location. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details. * @returns {Promise} - The promise which resolves to an array. * The first element of the array is an object representing {@link google.cloud.location.Location | Location}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` * const [response] = await client.getLocation(request); * ``` */ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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. * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource that owns the locations collection, if applicable. * @param {string} request.filter * The standard list filter. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | 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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` * const iterable = client.listLocationsAsync(request); * for await (const response of iterable) { * // process response * } * ``` */ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error, ?Object)=} callback * The function which will be called with the result of the API call. * * The second parameter to the callback is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * @return {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | google.longrunning.Operation}. * The promise has a method named "cancel" which cancels the ongoing API call. * * @example * ``` * const client = longrunning.operationsClient(); * const name = ''; * const [response] = await client.getOperation({name}); * // doThingsWith(response) * ``` */ getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise<[protos.google.longrunning.Operation]>; /** * 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. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation collection. * @param {string} request.filter - The standard list filter. * @param {number=} request.pageSize - * The maximum number of resources contained in the underlying API * response. If page streaming is performed per-resource, this * parameter does not affect the return value. If page streaming is * performed per-page, this determines the maximum number of * resources in a page. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @returns {Object} * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. * * @example * ``` * const client = longrunning.operationsClient(); * for await (const response of client.listOperationsAsync(request)); * // doThingsWith(response) * ``` */ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable; /** * 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 * {@link Operations.GetOperation} 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of * 1, corresponding to `Code.CANCELLED`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be cancelled. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.cancelOperation({name: ''}); * ``` */ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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`. * * @param {Object} request - The request object that will be sent. * @param {string} request.name - The name of the operation resource to be deleted. * @param {Object=} options * Optional parameters. You can override the default settings for this call, * e.g, timeout, retries, paginations, etc. See {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} * for the details. * @param {function(?Error)=} callback * The function which will be called with the result of the API call. * @return {Promise} - The promise which resolves when API call finishes. * The promise has a method named "cancel" which cancels the ongoing API * call. * * @example * ``` * const client = longrunning.operationsClient(); * await client.deleteOperation({name: ''}); * ``` */ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * Return a fully-qualified attributesConfig resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @returns {string} Resource name string. */ attributesConfigPath(project: string, location: string, catalog: string): string; /** * Parse the project from AttributesConfig resource. * * @param {string} attributesConfigName * A fully-qualified path representing AttributesConfig resource. * @returns {string} A string representing the project. */ matchProjectFromAttributesConfigName(attributesConfigName: string): string | number; /** * Parse the location from AttributesConfig resource. * * @param {string} attributesConfigName * A fully-qualified path representing AttributesConfig resource. * @returns {string} A string representing the location. */ matchLocationFromAttributesConfigName(attributesConfigName: string): string | number; /** * Parse the catalog from AttributesConfig resource. * * @param {string} attributesConfigName * A fully-qualified path representing AttributesConfig resource. * @returns {string} A string representing the catalog. */ matchCatalogFromAttributesConfigName(attributesConfigName: string): string | number; /** * Return a fully-qualified branch resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @param {string} branch * @returns {string} Resource name string. */ branchPath(project: string, location: string, catalog: string, branch: string): string; /** * Parse the project from Branch resource. * * @param {string} branchName * A fully-qualified path representing Branch resource. * @returns {string} A string representing the project. */ matchProjectFromBranchName(branchName: string): string | number; /** * Parse the location from Branch resource. * * @param {string} branchName * A fully-qualified path representing Branch resource. * @returns {string} A string representing the location. */ matchLocationFromBranchName(branchName: string): string | number; /** * Parse the catalog from Branch resource. * * @param {string} branchName * A fully-qualified path representing Branch resource. * @returns {string} A string representing the catalog. */ matchCatalogFromBranchName(branchName: string): string | number; /** * Parse the branch from Branch resource. * * @param {string} branchName * A fully-qualified path representing Branch resource. * @returns {string} A string representing the branch. */ matchBranchFromBranchName(branchName: string): string | number; /** * Return a fully-qualified catalog resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @returns {string} Resource name string. */ catalogPath(project: string, location: string, catalog: string): string; /** * Parse the project from Catalog resource. * * @param {string} catalogName * A fully-qualified path representing Catalog resource. * @returns {string} A string representing the project. */ matchProjectFromCatalogName(catalogName: string): string | number; /** * Parse the location from Catalog resource. * * @param {string} catalogName * A fully-qualified path representing Catalog resource. * @returns {string} A string representing the location. */ matchLocationFromCatalogName(catalogName: string): string | number; /** * Parse the catalog from Catalog resource. * * @param {string} catalogName * A fully-qualified path representing Catalog resource. * @returns {string} A string representing the catalog. */ matchCatalogFromCatalogName(catalogName: string): string | number; /** * Return a fully-qualified completionConfig resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @returns {string} Resource name string. */ completionConfigPath(project: string, location: string, catalog: string): string; /** * Parse the project from CompletionConfig resource. * * @param {string} completionConfigName * A fully-qualified path representing CompletionConfig resource. * @returns {string} A string representing the project. */ matchProjectFromCompletionConfigName(completionConfigName: string): string | number; /** * Parse the location from CompletionConfig resource. * * @param {string} completionConfigName * A fully-qualified path representing CompletionConfig resource. * @returns {string} A string representing the location. */ matchLocationFromCompletionConfigName(completionConfigName: string): string | number; /** * Parse the catalog from CompletionConfig resource. * * @param {string} completionConfigName * A fully-qualified path representing CompletionConfig resource. * @returns {string} A string representing the catalog. */ matchCatalogFromCompletionConfigName(completionConfigName: string): string | number; /** * Return a fully-qualified control resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @param {string} control * @returns {string} Resource name string. */ controlPath(project: string, location: string, catalog: string, control: string): string; /** * Parse the project from Control resource. * * @param {string} controlName * A fully-qualified path representing Control resource. * @returns {string} A string representing the project. */ matchProjectFromControlName(controlName: string): string | number; /** * Parse the location from Control resource. * * @param {string} controlName * A fully-qualified path representing Control resource. * @returns {string} A string representing the location. */ matchLocationFromControlName(controlName: string): string | number; /** * Parse the catalog from Control resource. * * @param {string} controlName * A fully-qualified path representing Control resource. * @returns {string} A string representing the catalog. */ matchCatalogFromControlName(controlName: string): string | number; /** * Parse the control from Control resource. * * @param {string} controlName * A fully-qualified path representing Control resource. * @returns {string} A string representing the control. */ matchControlFromControlName(controlName: string): string | number; /** * Return a fully-qualified model resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @param {string} model * @returns {string} Resource name string. */ modelPath(project: string, location: string, catalog: string, model: string): string; /** * Parse the project from Model resource. * * @param {string} modelName * A fully-qualified path representing Model resource. * @returns {string} A string representing the project. */ matchProjectFromModelName(modelName: string): string | number; /** * Parse the location from Model resource. * * @param {string} modelName * A fully-qualified path representing Model resource. * @returns {string} A string representing the location. */ matchLocationFromModelName(modelName: string): string | number; /** * Parse the catalog from Model resource. * * @param {string} modelName * A fully-qualified path representing Model resource. * @returns {string} A string representing the catalog. */ matchCatalogFromModelName(modelName: string): string | number; /** * Parse the model from Model resource. * * @param {string} modelName * A fully-qualified path representing Model resource. * @returns {string} A string representing the model. */ matchModelFromModelName(modelName: string): string | number; /** * Return a fully-qualified product resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @param {string} branch * @param {string} product * @returns {string} Resource name string. */ productPath(project: string, location: string, catalog: string, branch: string, product: string): string; /** * Parse the project from Product resource. * * @param {string} productName * A fully-qualified path representing Product resource. * @returns {string} A string representing the project. */ matchProjectFromProductName(productName: string): string | number; /** * Parse the location from Product resource. * * @param {string} productName * A fully-qualified path representing Product resource. * @returns {string} A string representing the location. */ matchLocationFromProductName(productName: string): string | number; /** * Parse the catalog from Product resource. * * @param {string} productName * A fully-qualified path representing Product resource. * @returns {string} A string representing the catalog. */ matchCatalogFromProductName(productName: string): string | number; /** * Parse the branch from Product resource. * * @param {string} productName * A fully-qualified path representing Product resource. * @returns {string} A string representing the branch. */ matchBranchFromProductName(productName: string): string | number; /** * Parse the product from Product resource. * * @param {string} productName * A fully-qualified path representing Product resource. * @returns {string} A string representing the product. */ matchProductFromProductName(productName: string): string | number; /** * Return a fully-qualified servingConfig resource name string. * * @param {string} project * @param {string} location * @param {string} catalog * @param {string} serving_config * @returns {string} Resource name string. */ servingConfigPath(project: string, location: string, catalog: string, servingConfig: string): string; /** * Parse the project from ServingConfig resource. * * @param {string} servingConfigName * A fully-qualified path representing ServingConfig resource. * @returns {string} A string representing the project. */ matchProjectFromServingConfigName(servingConfigName: string): string | number; /** * Parse the location from ServingConfig resource. * * @param {string} servingConfigName * A fully-qualified path representing ServingConfig resource. * @returns {string} A string representing the location. */ matchLocationFromServingConfigName(servingConfigName: string): string | number; /** * Parse the catalog from ServingConfig resource. * * @param {string} servingConfigName * A fully-qualified path representing ServingConfig resource. * @returns {string} A string representing the catalog. */ matchCatalogFromServingConfigName(servingConfigName: string): string | number; /** * Parse the serving_config from ServingConfig resource. * * @param {string} servingConfigName * A fully-qualified path representing ServingConfig resource. * @returns {string} A string representing the serving_config. */ matchServingConfigFromServingConfigName(servingConfigName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }