Class v2.ProductServiceClient (1.5.0)

Package

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Properties

apiEndpoint

static get apiEndpoint(): string;

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

productServiceStub

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

scopes

static get scopes(): string[];

servicePath

static get servicePath(): string;

warn

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

Methods

addFulfillmentPlaces(request, options)

addFulfillmentPlaces(request?: protos.google.cloud.retail.v2.IAddFulfillmentPlacesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2.IAddFulfillmentPlacesResponse, protos.google.cloud.retail.v2.IAddFulfillmentPlacesMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of Product google.cloud.retail.v2.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
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  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 Product.fulfillment_info.type .
   */
  // const type = 'abc123'
  /**
   *  Required. The IDs for this
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.type, such as
   *  the store IDs for "pickup-in-store" or the region IDs for
   *  "same-day-delivery" to be added for this
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.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
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.type  after
   *  adding, then the update will be rejected.
   */
  // const placeIds = 'abc123'
  /**
   *  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.
   */
  // const addTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the fulfillment information will still be processed and retained for
   *  at most 1 day and processed once the
   *  Product google.cloud.retail.v2.Product  is created. If set to false, a
   *  NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callAddFulfillmentPlaces() {
    // Construct request
    const request = {
      product,
      type,
      placeIds,
    };

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

  callAddFulfillmentPlaces();

addFulfillmentPlaces(request, options, callback)

addFulfillmentPlaces(request: protos.google.cloud.retail.v2.IAddFulfillmentPlacesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2.IAddFulfillmentPlacesResponse, protos.google.cloud.retail.v2.IAddFulfillmentPlacesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

addFulfillmentPlaces(request, callback)

addFulfillmentPlaces(request: protos.google.cloud.retail.v2.IAddFulfillmentPlacesRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2.IAddFulfillmentPlacesResponse, protos.google.cloud.retail.v2.IAddFulfillmentPlacesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

branchPath(project, location, catalog, branch)

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

catalogPath(project, location, catalog)

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

checkAddFulfillmentPlacesProgress(name)

checkAddFulfillmentPlacesProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2.AddFulfillmentPlacesResponse, protos.google.cloud.retail.v2.AddFulfillmentPlacesMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of Product google.cloud.retail.v2.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
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  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 Product.fulfillment_info.type .
   */
  // const type = 'abc123'
  /**
   *  Required. The IDs for this
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.type, such as
   *  the store IDs for "pickup-in-store" or the region IDs for
   *  "same-day-delivery" to be added for this
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.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
   *  type google.cloud.retail.v2.AddFulfillmentPlacesRequest.type  after
   *  adding, then the update will be rejected.
   */
  // const placeIds = 'abc123'
  /**
   *  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.
   */
  // const addTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the fulfillment information will still be processed and retained for
   *  at most 1 day and processed once the
   *  Product google.cloud.retail.v2.Product  is created. If set to false, a
   *  NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callAddFulfillmentPlaces() {
    // Construct request
    const request = {
      product,
      type,
      placeIds,
    };

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

  callAddFulfillmentPlaces();

checkImportProductsProgress(name)

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  Unique identifier provided by client, within the ancestor
   *  dataset scope. Ensures idempotency and used for request deduplication.
   *  Server-generated if unspecified. Up to 128 characters long and must match
   *  the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
   *  ImportMetadata google.cloud.retail.v2.ImportMetadata.
   *  Only supported when
   *  ImportProductsRequest.reconciliation_mode google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode
   *  is set to `FULL`.
   */
  // const requestId = 'abc123'
  /**
   *  Required. The desired input location of the data.
   */
  // const inputConfig = {}
  /**
   *  The desired location of errors incurred during the Import.
   */
  // const errorsConfig = {}
  /**
   *  Indicates which fields in the provided imported 'products' to update. If
   *  not set, will by default update all fields.
   */
  // const updateMask = {}
  /**
   *  The mode of reconciliation between existing products and the products to be
   *  imported. Defaults to
   *  ReconciliationMode.INCREMENTAL google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL.
   */
  // const reconciliationMode = {}
  /**
   *  Pub/Sub topic for receiving notification. If this field is set,
   *  when the import is finished, a notification will be sent to
   *  specified Pub/Sub topic. The message data will be JSON string of a
   *  Operation google.longrunning.Operation.
   *  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
   *  Only supported when
   *  ImportProductsRequest.reconciliation_mode google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode
   *  is set to `FULL`.
   */
  // const notificationPubsubTopic = 'abc123'

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

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

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

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

  callImportProducts();

checkRemoveFulfillmentPlacesProgress(name)

checkRemoveFulfillmentPlacesProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2.RemoveFulfillmentPlacesResponse, protos.google.cloud.retail.v2.RemoveFulfillmentPlacesMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of Product google.cloud.retail.v2.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
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  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 Product.fulfillment_info.type .
   */
  // const type = 'abc123'
  /**
   *  Required. The IDs for this
   *  type google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type, such as
   *  the store IDs for "pickup-in-store" or the region IDs for
   *  "same-day-delivery", to be removed for this
   *  type google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.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.
   */
  // const placeIds = 'abc123'
  /**
   *  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.
   */
  // const removeTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the fulfillment information will still be processed and retained for
   *  at most 1 day and processed once the
   *  Product google.cloud.retail.v2.Product  is created. If set to false, a
   *  NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callRemoveFulfillmentPlaces() {
    // Construct request
    const request = {
      product,
      type,
      placeIds,
    };

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

  callRemoveFulfillmentPlaces();

checkSetInventoryProgress(name)

checkSetInventoryProgress(name: string): Promise<LROperation<protos.google.cloud.retail.v2.SetInventoryResponse, protos.google.cloud.retail.v2.SetInventoryMetadata>>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The inventory information to update. The allowable fields to
   *  update are:
   *  * Product.price_info google.cloud.retail.v2.Product.price_info
   *  * Product.availability google.cloud.retail.v2.Product.availability
   *  * Product.available_quantity google.cloud.retail.v2.Product.available_quantity
   *  * Product.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info
   *  The updated inventory fields must be specified in
   *  SetInventoryRequest.set_mask google.cloud.retail.v2.SetInventoryRequest.set_mask.
   *  If SetInventoryRequest.inventory.name   is empty or invalid, an
   *  INVALID_ARGUMENT error is returned.
   *  If the caller does not have permission to update the
   *  Product google.cloud.retail.v2.Product  named in
   *  Product.name google.cloud.retail.v2.Product.name, regardless of whether
   *  or not it exists, a PERMISSION_DENIED error is returned.
   *  If the Product google.cloud.retail.v2.Product  to update does not have
   *  existing inventory information, the provided inventory information will be
   *  inserted.
   *  If the Product google.cloud.retail.v2.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
   *  SetInventoryRequest.set_time google.cloud.retail.v2.SetInventoryRequest.set_time.
   *  The last update time is recorded for the following inventory fields:
   *  * Product.price_info google.cloud.retail.v2.Product.price_info
   *  * Product.availability google.cloud.retail.v2.Product.availability
   *  * Product.available_quantity google.cloud.retail.v2.Product.available_quantity
   *  * Product.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info
   *  If a full overwrite of inventory information while ignoring timestamps is
   *  needed, UpdateProduct   should be invoked instead.
   */
  // const inventory = {}
  /**
   *  Indicates which inventory fields in the provided
   *  Product google.cloud.retail.v2.Product  to update. If 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.
   */
  // const setMask = {}
  /**
   *  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.
   */
  // const setTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  with name
   *  Product.name google.cloud.retail.v2.Product.name  is not found, the
   *  inventory update will still be processed and retained for at most 1 day
   *  until the Product google.cloud.retail.v2.Product  is created. If set to
   *  false, a NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callSetInventory() {
    // Construct request
    const request = {
      inventory,
    };

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

  callSetInventory();

close()

close(): Promise<void>;

createProduct(request, options)

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
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The parent catalog resource name, such as
   *  `projects/* /locations/global/catalogs/default_catalog/branches/default_branch`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The Product google.cloud.retail.v2.Product  to create.
   */
  // const product = {}
  /**
   *  Required. The ID to use for the Product google.cloud.retail.v2.Product,
   *  which will become the final component of the
   *  Product.name google.cloud.retail.v2.Product.name.
   *  If the caller does not have permission to create the
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   *  This field must be unique among all
   *  Product google.cloud.retail.v2.Product s with the same
   *  parent google.cloud.retail.v2.CreateProductRequest.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.
   */
  // const productId = 'abc123'

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

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

  async function callCreateProduct() {
    // Construct request
    const request = {
      parent,
      product,
      productId,
    };

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

  callCreateProduct();

createProduct(request, options, callback)

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

createProduct(request, callback)

createProduct(request: protos.google.cloud.retail.v2.ICreateProductRequest, callback: Callback<protos.google.cloud.retail.v2.IProduct, protos.google.cloud.retail.v2.ICreateProductRequest | null | undefined, {} | null | undefined>): void;

deleteProduct(request, options)

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of Product google.cloud.retail.v2.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
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   *  If the Product google.cloud.retail.v2.Product  to delete does not exist,
   *  a NOT_FOUND error is returned.
   *  The Product google.cloud.retail.v2.Product  to delete can neither be a
   *  Product.Type.COLLECTION google.cloud.retail.v2.Product.Type.COLLECTION
   *  Product google.cloud.retail.v2.Product  member nor a
   *  Product.Type.PRIMARY google.cloud.retail.v2.Product.Type.PRIMARY
   *  Product google.cloud.retail.v2.Product  with more than one
   *  variants google.cloud.retail.v2.Product.Type.VARIANT. Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   *  All inventory information for the named
   *  Product google.cloud.retail.v2.Product  will be deleted.
   */
  // const name = 'abc123'

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

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

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

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

  callDeleteProduct();

deleteProduct(request, options, callback)

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

deleteProduct(request, callback)

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

getProduct(request, options)

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
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of Product google.cloud.retail.v2.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
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   *  If the requested Product google.cloud.retail.v2.Product  does not exist,
   *  a NOT_FOUND error is returned.
   */
  // const name = 'abc123'

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

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

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

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

  callGetProduct();

getProduct(request, options, callback)

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

getProduct(request, callback)

getProduct(request: protos.google.cloud.retail.v2.IGetProductRequest, callback: Callback<protos.google.cloud.retail.v2.IProduct, protos.google.cloud.retail.v2.IGetProductRequest | null | undefined, {} | null | undefined>): void;

getProjectId()

getProjectId(): Promise<string>;

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

importProducts(request, options)

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

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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.
   */
  // const parent = 'abc123'
  /**
   *  Unique identifier provided by client, within the ancestor
   *  dataset scope. Ensures idempotency and used for request deduplication.
   *  Server-generated if unspecified. Up to 128 characters long and must match
   *  the pattern: `[a-zA-Z0-9_]+`. This is returned as [Operation.name][] in
   *  ImportMetadata google.cloud.retail.v2.ImportMetadata.
   *  Only supported when
   *  ImportProductsRequest.reconciliation_mode google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode
   *  is set to `FULL`.
   */
  // const requestId = 'abc123'
  /**
   *  Required. The desired input location of the data.
   */
  // const inputConfig = {}
  /**
   *  The desired location of errors incurred during the Import.
   */
  // const errorsConfig = {}
  /**
   *  Indicates which fields in the provided imported 'products' to update. If
   *  not set, will by default update all fields.
   */
  // const updateMask = {}
  /**
   *  The mode of reconciliation between existing products and the products to be
   *  imported. Defaults to
   *  ReconciliationMode.INCREMENTAL google.cloud.retail.v2.ImportProductsRequest.ReconciliationMode.INCREMENTAL.
   */
  // const reconciliationMode = {}
  /**
   *  Pub/Sub topic for receiving notification. If this field is set,
   *  when the import is finished, a notification will be sent to
   *  specified Pub/Sub topic. The message data will be JSON string of a
   *  Operation google.longrunning.Operation.
   *  Format of the Pub/Sub topic is `projects/{project}/topics/{topic}`.
   *  Only supported when
   *  ImportProductsRequest.reconciliation_mode google.cloud.retail.v2.ImportProductsRequest.reconciliation_mode
   *  is set to `FULL`.
   */
  // const notificationPubsubTopic = 'abc123'

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

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

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

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

  callImportProducts();

importProducts(request, options, callback)

importProducts(request: protos.google.cloud.retail.v2.IImportProductsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2.IImportProductsResponse, protos.google.cloud.retail.v2.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

importProducts(request, callback)

importProducts(request: protos.google.cloud.retail.v2.IImportProductsRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2.IImportProductsResponse, protos.google.cloud.retail.v2.IImportMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

listProducts(request, options)

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, options, callback)

listProducts(request: protos.google.cloud.retail.v2.IListProductsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.retail.v2.IListProductsRequest, protos.google.cloud.retail.v2.IListProductsResponse | null | undefined, protos.google.cloud.retail.v2.IProduct>): void;

listProducts(request, callback)

listProducts(request: protos.google.cloud.retail.v2.IListProductsRequest, callback: PaginationCallback<protos.google.cloud.retail.v2.IListProductsRequest, protos.google.cloud.retail.v2.IListProductsResponse | null | undefined, protos.google.cloud.retail.v2.IProduct>): void;

listProductsAsync(request, options)

listProductsAsync(request?: protos.google.cloud.retail.v2.IListProductsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.retail.v2.IProduct>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  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
   *  Product google.cloud.retail.v2.Product s under this branch, regardless of
   *  whether or not this branch exists, a PERMISSION_DENIED error is returned.
   */
  // const parent = 'abc123'
  /**
   *  Maximum number of Product google.cloud.retail.v2.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.
   */
  // const pageSize = 1234
  /**
   *  A page token
   *  ListProductsResponse.next_page_token google.cloud.retail.v2.ListProductsResponse.next_page_token,
   *  received from a previous
   *  ProductService.ListProducts google.cloud.retail.v2.ProductService.ListProducts
   *  call. Provide this to retrieve the subsequent page.
   *  When paginating, all other parameters provided to
   *  ProductService.ListProducts google.cloud.retail.v2.ProductService.ListProducts
   *  must match the call that provided the page token. Otherwise, an
   *  INVALID_ARGUMENT error is returned.
   */
  // const pageToken = 'abc123'
  /**
   *  A filter to apply on the list results. Supported features:
   *  * List all the products under the parent branch if
   *  filter google.cloud.retail.v2.ListProductsRequest.filter  is unset.
   *  * List Product.Type.VARIANT google.cloud.retail.v2.Product.Type.VARIANT
   *  Product google.cloud.retail.v2.Product s sharing the same
   *    Product.Type.PRIMARY google.cloud.retail.v2.Product.Type.PRIMARY
   *    Product google.cloud.retail.v2.Product. For example:
   *      `primary_product_id = "some_product_id"`
   *  * List Product google.cloud.retail.v2.Product s bundled in a
   *  Product.Type.COLLECTION google.cloud.retail.v2.Product.Type.COLLECTION
   *  Product google.cloud.retail.v2.Product.
   *    For example:
   *      `collection_product_id = "some_product_id"`
   *  * List Product google.cloud.retail.v2.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
   *  Product.Type.PRIMARY google.cloud.retail.v2.Product.Type.PRIMARY
   *  Product google.cloud.retail.v2.Product  or
   *  Product.Type.COLLECTION google.cloud.retail.v2.Product.Type.COLLECTION
   *  Product google.cloud.retail.v2.Product  does not exist, a NOT_FOUND error
   *  is returned.
   */
  // const filter = 'abc123'
  /**
   *  The fields of Product google.cloud.retail.v2.Product  to return in the
   *  responses. If not set or empty, the following fields are returned:
   *  * Product.name google.cloud.retail.v2.Product.name
   *  * Product.id google.cloud.retail.v2.Product.id
   *  * Product.title google.cloud.retail.v2.Product.title
   *  * Product.uri google.cloud.retail.v2.Product.uri
   *  * Product.images google.cloud.retail.v2.Product.images
   *  * Product.price_info google.cloud.retail.v2.Product.price_info
   *  * Product.brands google.cloud.retail.v2.Product.brands
   *  If "*" is provided, all fields are returned.
   *  Product.name google.cloud.retail.v2.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.
   */
  // const readMask = {}

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

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

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

    // Run request
    const iterable = await retailClient.listProductsAsync(request);
    for await (const response of iterable) {
      console.log(response);
    }
  }

  callListProducts();

listProductsStream(request, options)

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

matchBranchFromBranchName(branchName)

matchBranchFromBranchName(branchName: string): string | number;

matchBranchFromProductName(productName)

matchBranchFromProductName(productName: string): string | number;

matchCatalogFromBranchName(branchName)

matchCatalogFromBranchName(branchName: string): string | number;

matchCatalogFromCatalogName(catalogName)

matchCatalogFromCatalogName(catalogName: string): string | number;

matchCatalogFromProductName(productName)

matchCatalogFromProductName(productName: string): string | number;

matchLocationFromBranchName(branchName)

matchLocationFromBranchName(branchName: string): string | number;

matchLocationFromCatalogName(catalogName)

matchLocationFromCatalogName(catalogName: string): string | number;

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

matchProjectFromBranchName(branchName)

matchProjectFromBranchName(branchName: string): string | number;

matchProjectFromCatalogName(catalogName)

matchProjectFromCatalogName(catalogName: string): string | number;

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

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

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

removeFulfillmentPlaces(request, options)

removeFulfillmentPlaces(request?: protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesResponse, protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Full resource name of Product google.cloud.retail.v2.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
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   */
  // const product = 'abc123'
  /**
   *  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 Product.fulfillment_info.type .
   */
  // const type = 'abc123'
  /**
   *  Required. The IDs for this
   *  type google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.type, such as
   *  the store IDs for "pickup-in-store" or the region IDs for
   *  "same-day-delivery", to be removed for this
   *  type google.cloud.retail.v2.RemoveFulfillmentPlacesRequest.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.
   */
  // const placeIds = 'abc123'
  /**
   *  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.
   */
  // const removeTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, the fulfillment information will still be processed and retained for
   *  at most 1 day and processed once the
   *  Product google.cloud.retail.v2.Product  is created. If set to false, a
   *  NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callRemoveFulfillmentPlaces() {
    // Construct request
    const request = {
      product,
      type,
      placeIds,
    };

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

  callRemoveFulfillmentPlaces();

removeFulfillmentPlaces(request, options, callback)

removeFulfillmentPlaces(request: protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesResponse, protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

removeFulfillmentPlaces(request, callback)

removeFulfillmentPlaces(request: protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesResponse, protos.google.cloud.retail.v2.IRemoveFulfillmentPlacesMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

setInventory(request, options)

setInventory(request?: protos.google.cloud.retail.v2.ISetInventoryRequest, options?: CallOptions): Promise<[
        LROperation<protos.google.cloud.retail.v2.ISetInventoryResponse, protos.google.cloud.retail.v2.ISetInventoryMetadata>,
        protos.google.longrunning.IOperation | undefined,
        {} | undefined
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The inventory information to update. The allowable fields to
   *  update are:
   *  * Product.price_info google.cloud.retail.v2.Product.price_info
   *  * Product.availability google.cloud.retail.v2.Product.availability
   *  * Product.available_quantity google.cloud.retail.v2.Product.available_quantity
   *  * Product.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info
   *  The updated inventory fields must be specified in
   *  SetInventoryRequest.set_mask google.cloud.retail.v2.SetInventoryRequest.set_mask.
   *  If SetInventoryRequest.inventory.name   is empty or invalid, an
   *  INVALID_ARGUMENT error is returned.
   *  If the caller does not have permission to update the
   *  Product google.cloud.retail.v2.Product  named in
   *  Product.name google.cloud.retail.v2.Product.name, regardless of whether
   *  or not it exists, a PERMISSION_DENIED error is returned.
   *  If the Product google.cloud.retail.v2.Product  to update does not have
   *  existing inventory information, the provided inventory information will be
   *  inserted.
   *  If the Product google.cloud.retail.v2.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
   *  SetInventoryRequest.set_time google.cloud.retail.v2.SetInventoryRequest.set_time.
   *  The last update time is recorded for the following inventory fields:
   *  * Product.price_info google.cloud.retail.v2.Product.price_info
   *  * Product.availability google.cloud.retail.v2.Product.availability
   *  * Product.available_quantity google.cloud.retail.v2.Product.available_quantity
   *  * Product.fulfillment_info google.cloud.retail.v2.Product.fulfillment_info
   *  If a full overwrite of inventory information while ignoring timestamps is
   *  needed, UpdateProduct   should be invoked instead.
   */
  // const inventory = {}
  /**
   *  Indicates which inventory fields in the provided
   *  Product google.cloud.retail.v2.Product  to update. If 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.
   */
  // const setMask = {}
  /**
   *  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.
   */
  // const setTime = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  with name
   *  Product.name google.cloud.retail.v2.Product.name  is not found, the
   *  inventory update will still be processed and retained for at most 1 day
   *  until the Product google.cloud.retail.v2.Product  is created. If set to
   *  false, a NOT_FOUND error is returned if the
   *  Product google.cloud.retail.v2.Product  is not found.
   */
  // const allowMissing = true

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

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

  async function callSetInventory() {
    // Construct request
    const request = {
      inventory,
    };

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

  callSetInventory();

setInventory(request, options, callback)

setInventory(request: protos.google.cloud.retail.v2.ISetInventoryRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.retail.v2.ISetInventoryResponse, protos.google.cloud.retail.v2.ISetInventoryMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

setInventory(request, callback)

setInventory(request: protos.google.cloud.retail.v2.ISetInventoryRequest, callback: Callback<LROperation<protos.google.cloud.retail.v2.ISetInventoryResponse, protos.google.cloud.retail.v2.ISetInventoryMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;

updateProduct(request, options)

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
    ]>;

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The product to update/create.
   *  If the caller does not have permission to update the
   *  Product google.cloud.retail.v2.Product, regardless of whether or not it
   *  exists, a PERMISSION_DENIED error is returned.
   *  If the Product google.cloud.retail.v2.Product  to update does not exist
   *  and
   *  allow_missing google.cloud.retail.v2.UpdateProductRequest.allow_missing
   *  is not set, a NOT_FOUND error is returned.
   */
  // const product = {}
  /**
   *  Indicates which fields in the provided
   *  Product google.cloud.retail.v2.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.
   */
  // const updateMask = {}
  /**
   *  If set to true, and the Product google.cloud.retail.v2.Product  is not
   *  found, a new Product google.cloud.retail.v2.Product  will be created. In
   *  this situation, `update_mask` is ignored.
   */
  // const allowMissing = true

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

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

  async function callUpdateProduct() {
    // Construct request
    const request = {
      product,
    };

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

  callUpdateProduct();

updateProduct(request, options, callback)

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

updateProduct(request, callback)

updateProduct(request: protos.google.cloud.retail.v2.IUpdateProductRequest, callback: Callback<protos.google.cloud.retail.v2.IProduct, protos.google.cloud.retail.v2.IUpdateProductRequest | null | undefined, {} | null | undefined>): void;