Class v1p3beta1.ProductSearchClient

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

  • The API has a collection of resources, named projects/* /locations/* /productSets/*, which acts as a way to put different products into groups to limit identification.

In parallel,

  • The API has a collection of resources, named projects/* /locations/* /products/*

  • Each has a collection of resources, named projects/* /locations/* /products/* /referenceImages/* v1p3beta1

Package

@google-cloud/vision

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ProductSearchClient.

Parameter
NameDescription
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

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

auth

auth: gax.GoogleAuth;

descriptors

descriptors: Descriptors;

innerApiCalls

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

operationsClient

operationsClient: gax.OperationsClient;

pathTemplates

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

port

static get port(): number;

The port for this API service.

productSearchStub

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

scopes

static get scopes(): string[];

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

servicePath

static get servicePath(): string;

The DNS address for this API service.

warn

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

Methods

addProductToProductSet(request, options)

addProductToProductSet(request?: protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest | undefined), {} | undefined]>;

Adds a Product to the specified ProductSet. If the Product is already present, no change is made.

One Product can be added to at most 100 ProductSets.

Possible errors:

* Returns NOT_FOUND if the Product or the ProductSet doesn't exist.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest | undefined), {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for the ProductSet to modify.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
   */
  // const name = 'abc123'
  /**
   *  Required. The resource name for the Product to be added to this ProductSet.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
   */
  // const product = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.addProductToProductSet(request);
    console.log(response);
  }

  callAddProductToProductSet();

addProductToProductSet(request, options, callback)

addProductToProductSet(request: protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

addProductToProductSet(request, callback)

addProductToProductSet(request: protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

checkImportProductSetsProgress(name)

checkImportProductSetsProgress(name: string): Promise<LROperation<protos.google.cloud.vision.v1p3beta1.ImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.BatchOperationMetadata>>;

Check the status of the long running operation returned by importProductSets().

Parameter
NameDescription
name string

The operation name that will be passed.

Returns
TypeDescription
Promise<LROperation<protos.google.cloud.vision.v1p3beta1.ImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.BatchOperationMetadata>>

{Promise} - The promise which resolves to an object. The decoded operation object has result and metadata field to get information from. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project in which the ProductSets should be imported.
   *  Format is `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The input content for the list of requests.
   */
  // const inputConfig = {}

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callImportProductSets();

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
TypeDescription
Promise<void>

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

createProduct(request, options)

createProduct(request?: protos.google.cloud.vision.v1p3beta1.ICreateProductRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.ICreateProductRequest | undefined, {} | undefined]>;

Creates and returns a new product resource.

Possible errors:

* Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is missing or invalid.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateProductRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.ICreateProductRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project in which the Product should be created.
   *  Format is
   *  `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The product to create.
   */
  // const product = {}
  /**
   *  A user-supplied resource id for this Product. If set, the server will
   *  attempt to use this value as the resource id. If it is already in use, an
   *  error is returned with code ALREADY_EXISTS. Must be at most 128 characters
   *  long. It cannot contain the character `/`.
   */
  // const productId = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callCreateProduct();

createProduct(request, options, callback)

createProduct(request: protos.google.cloud.vision.v1p3beta1.ICreateProductRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.ICreateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateProductRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.ICreateProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createProduct(request, callback)

createProduct(request: protos.google.cloud.vision.v1p3beta1.ICreateProductRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.ICreateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateProductRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.ICreateProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createProductSet(request, options)

createProductSet(request?: protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest | undefined, {} | undefined]>;

Creates and returns a new ProductSet resource.

Possible errors:

* Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project in which the ProductSet should be created.
   *  Format is `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The ProductSet to create.
   */
  // const productSet = {}
  /**
   *  A user-supplied resource id for this ProductSet. If set, the server will
   *  attempt to use this value as the resource id. If it is already in use, an
   *  error is returned with code ALREADY_EXISTS. Must be at most 128 characters
   *  long. It cannot contain the character `/`.
   */
  // const productSetId = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.createProductSet(request);
    console.log(response);
  }

  callCreateProductSet();

createProductSet(request, options, callback)

createProductSet(request: protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createProductSet(request, callback)

createProductSet(request: protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.ICreateProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createReferenceImage(request, options)

createReferenceImage(request?: protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IReferenceImage, (protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest | undefined), {} | undefined]>;

Creates and returns a new ReferenceImage resource.

The bounding_poly field is optional. If bounding_poly is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles.

Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP).

Possible errors:

* Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters. * Returns INVALID_ARGUMENT if the product does not exist. * Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected. * Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IReferenceImage, (protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest | undefined), {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the product in which to create the reference image.
   *  Format is
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The reference image to create.
   *  If an image ID is specified, it is ignored.
   */
  // const referenceImage = {}
  /**
   *  A user-supplied resource id for the ReferenceImage to be added. If set,
   *  the server will attempt to use this value as the resource id. If it is
   *  already in use, an error is returned with code ALREADY_EXISTS. Must be at
   *  most 128 characters long. It cannot contain the character `/`.
   */
  // const referenceImageId = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.createReferenceImage(request);
    console.log(response);
  }

  callCreateReferenceImage();

createReferenceImage(request, options, callback)

createReferenceImage(request: protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

createReferenceImage(request, callback)

createReferenceImage(request: protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteProduct(request, options)

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

Permanently deletes a product and its reference images.

Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.

Possible errors:

* Returns NOT_FOUND if the product does not exist.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of product to delete.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
   */
  // const name = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callDeleteProduct();

deleteProduct(request, options, callback)

deleteProduct(request: protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteProduct(request, callback)

deleteProduct(request: protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteProductSet(request, options)

deleteProductSet(request?: protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest | undefined, {} | undefined]>;

Permanently deletes a ProductSet. All Products and ReferenceImages in the ProductSet will be deleted.

The actual image files are not deleted from Google Cloud Storage.

Possible errors:

* Returns NOT_FOUND if the ProductSet does not exist.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the ProductSet to delete.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
   */
  // const name = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.deleteProductSet(request);
    console.log(response);
  }

  callDeleteProductSet();

deleteProductSet(request, options, callback)

deleteProductSet(request: protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteProductSet(request, callback)

deleteProductSet(request: protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteReferenceImage(request, options)

deleteReferenceImage(request?: protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest | undefined), {} | undefined]>;

Permanently deletes a reference image.

The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.

The actual image files are not deleted from Google Cloud Storage.

Possible errors:

* Returns NOT_FOUND if the reference image does not exist.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest | undefined), {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the reference image to delete.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`
   */
  // const name = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.deleteReferenceImage(request);
    console.log(response);
  }

  callDeleteReferenceImage();

deleteReferenceImage(request, options, callback)

deleteReferenceImage(request: protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

deleteReferenceImage(request, callback)

deleteReferenceImage(request: protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProduct(request, options)

getProduct(request?: protos.google.cloud.vision.v1p3beta1.IGetProductRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IGetProductRequest | undefined, {} | undefined]>;

Gets information associated with a Product.

Possible errors:

* Returns NOT_FOUND if the Product does not exist.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetProductRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IGetProductRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the Product to get.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
   */
  // const name = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callGetProduct();

getProduct(request, options, callback)

getProduct(request: protos.google.cloud.vision.v1p3beta1.IGetProductRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IGetProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetProductRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IGetProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProduct(request, callback)

getProduct(request: protos.google.cloud.vision.v1p3beta1.IGetProductRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IGetProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetProductRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IGetProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProductSet(request, options)

getProductSet(request?: protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest | undefined, {} | undefined]>;

Gets information associated with a ProductSet.

Possible errors:

* Returns NOT_FOUND if the ProductSet does not exist.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the ProductSet to get.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
   */
  // const name = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.getProductSet(request);
    console.log(response);
  }

  callGetProductSet();

getProductSet(request, options, callback)

getProductSet(request: protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProductSet(request, callback)

getProductSet(request: protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IGetProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getProjectId()

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

getProjectId(callback)

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

getReferenceImage(request, options)

getReferenceImage(request?: protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IReferenceImage, (protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest | undefined), {} | undefined]>;

Gets information associated with a ReferenceImage.

Possible errors:

* Returns NOT_FOUND if the specified image does not exist.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IReferenceImage, (protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest | undefined), {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name of the ReferenceImage to get.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.
   */
  // const name = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.getReferenceImage(request);
    console.log(response);
  }

  callGetReferenceImage();

getReferenceImage(request, options, callback)

getReferenceImage(request: protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

getReferenceImage(request, callback)

getReferenceImage(request: protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IReferenceImage, protos.google.cloud.vision.v1p3beta1.IGetReferenceImageRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

importProductSets(request, options)

importProductSets(request?: protos.google.cloud.vision.v1p3beta1.IImportProductSetsRequest, options?: CallOptions): Promise<[LROperation<protos.google.cloud.vision.v1p3beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>;

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

The API can be used to keep track of the progress and results of the request. Operation.metadata contains BatchOperationMetadata. (progress) Operation.response contains ImportProductSetsResponse. (results)

The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see .

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IImportProductSetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[LROperation<protos.google.cloud.vision.v1p3beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | undefined, {} | undefined]>

{Promise} - The promise which resolves to an array. The first element of the array is an object representing a long running operation. Its promise() method returns a promise you can await for. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project in which the ProductSets should be imported.
   *  Format is `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  Required. The input content for the list of requests.
   */
  // const inputConfig = {}

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callImportProductSets();

importProductSets(request, options, callback)

importProductSets(request: protos.google.cloud.vision.v1p3beta1.IImportProductSetsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vision.v1p3beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IImportProductSetsRequest
options CallOptions
callback Callback<LROperation<protos.google.cloud.vision.v1p3beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

importProductSets(request, callback)

importProductSets(request: protos.google.cloud.vision.v1p3beta1.IImportProductSetsRequest, callback: Callback<LROperation<protos.google.cloud.vision.v1p3beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IImportProductSetsRequest
callback Callback<LROperation<protos.google.cloud.vision.v1p3beta1.IImportProductSetsResponse, protos.google.cloud.vision.v1p3beta1.IBatchOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

initialize()

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

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
TypeDescription
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listProducts(request, options)

listProducts(request?: protos.google.cloud.vision.v1p3beta1.IListProductsRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProduct[], protos.google.cloud.vision.v1p3beta1.IListProductsRequest | null, protos.google.cloud.vision.v1p3beta1.IListProductsResponse]>;

Lists products in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProduct[], protos.google.cloud.vision.v1p3beta1.IListProductsRequest | null, protos.google.cloud.vision.v1p3beta1.IListProductsResponse]>

{Promise} - The promise which resolves to an array. The first element of the array is Array of [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listProducts(request, options, callback)

listProducts(request: protos.google.cloud.vision.v1p3beta1.IListProductsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsRequest, protos.google.cloud.vision.v1p3beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsRequest, protos.google.cloud.vision.v1p3beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>
Returns
TypeDescription
void

listProducts(request, callback)

listProducts(request: protos.google.cloud.vision.v1p3beta1.IListProductsRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsRequest, protos.google.cloud.vision.v1p3beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsRequest
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsRequest, protos.google.cloud.vision.v1p3beta1.IListProductsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>
Returns
TypeDescription
void

listProductsAsync(request, options)

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

Equivalent to listProducts, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vision.v1p3beta1.IProduct>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project OR ProductSet from which Products should be listed.
   *  Format:
   *  `projects/PROJECT_ID/locations/LOC_ID`
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callListProducts();

listProductSets(request, options)

listProductSets(request?: protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet[], protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest | null, protos.google.cloud.vision.v1p3beta1.IListProductSetsResponse]>;

Lists ProductSets in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet[], protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest | null, protos.google.cloud.vision.v1p3beta1.IListProductSetsResponse]>

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

listProductSets(request, options, callback)

listProductSets(request: protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p3beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProductSet>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p3beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProductSet>
Returns
TypeDescription
void

listProductSets(request, callback)

listProductSets(request: protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p3beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProductSet>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, protos.google.cloud.vision.v1p3beta1.IListProductSetsResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProductSet>
Returns
TypeDescription
void

listProductSetsAsync(request, options)

listProductSetsAsync(request?: protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vision.v1p3beta1.IProductSet>;

Equivalent to listProductSets, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vision.v1p3beta1.IProductSet>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The project from which ProductSets should be listed.
   *  Format is `projects/PROJECT_ID/locations/LOC_ID`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callListProductSets();

listProductSetsStream(request, options)

listProductSetsStream(request?: protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductSetsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ProductSet] 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 listProductSetsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listProductsInProductSet(request, options)

listProductsInProductSet(request?: protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProduct[], protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest | null, protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetResponse]>;

Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProduct[], protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest | null, protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetResponse]>

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

listProductsInProductSet(request, options, callback)

listProductsInProductSet(request: protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>
Returns
TypeDescription
void

listProductsInProductSet(request, callback)

listProductsInProductSet(request: protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IProduct>
Returns
TypeDescription
void

listProductsInProductSetAsync(request, options)

listProductsInProductSetAsync(request?: protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vision.v1p3beta1.IProduct>;

Equivalent to listProductsInProductSet, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vision.v1p3beta1.IProduct>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ProductSet resource for which to retrieve Products.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
   */
  // const name = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  The next_page_token returned from a previous List request, if any.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callListProductsInProductSet();

listProductsInProductSetStream(request, options)

listProductsInProductSetStream(request?: protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [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 listProductsInProductSetAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listProductsStream(request, options)

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

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListProductsRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [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 [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listReferenceImages(request, options)

listReferenceImages(request?: protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IReferenceImage[], protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest | null, protos.google.cloud.vision.v1p3beta1.IListReferenceImagesResponse]>;

Lists reference images.

Possible errors:

* Returns NOT_FOUND if the parent product does not exist. * Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IReferenceImage[], protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest | null, protos.google.cloud.vision.v1p3beta1.IListReferenceImagesResponse]>

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

listReferenceImages(request, options, callback)

listReferenceImages(request: protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p3beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IReferenceImage>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest
options CallOptions
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p3beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IReferenceImage>
Returns
TypeDescription
void

listReferenceImages(request, callback)

listReferenceImages(request: protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, callback: PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p3beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IReferenceImage>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest
callback PaginationCallback<protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, protos.google.cloud.vision.v1p3beta1.IListReferenceImagesResponse | null | undefined, protos.google.cloud.vision.v1p3beta1.IReferenceImage>
Returns
TypeDescription
void

listReferenceImagesAsync(request, options)

listReferenceImagesAsync(request?: protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vision.v1p3beta1.IReferenceImage>;

Equivalent to listReferenceImages, but returns an iterable object.

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
AsyncIterable<protos.google.cloud.vision.v1p3beta1.IReferenceImage>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. Resource name of the product containing the reference images.
   *  Format is
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.
   */
  // const parent = 'abc123'
  /**
   *  The maximum number of items to return. Default 10, maximum 100.
   */
  // const pageSize = 1234
  /**
   *  A token identifying a page of results to be returned. This is the value
   *  of `nextPageToken` returned in a previous reference image list request.
   *  Defaults to the first page if not specified.
   */
  // const pageToken = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callListReferenceImages();

listReferenceImagesStream(request, options)

listReferenceImagesStream(request?: protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, options?: CallOptions): Transform;

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

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IListReferenceImagesRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Transform

{Stream} An object stream which emits an object representing [ReferenceImage] 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 listReferenceImagesAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

locationPath(project, location)

locationPath(project: string, location: string): string;

Return a fully-qualified location resource name string.

Parameters
NameDescription
project string
location string
Returns
TypeDescription
string

{string} Resource name string.

matchLocationFromLocationName(locationName)

matchLocationFromLocationName(locationName: string): string | number;

Parse the location from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProductName(productName)

matchLocationFromProductName(productName: string): string | number;

Parse the location from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromProductSetName(productSetName)

matchLocationFromProductSetName(productSetName: string): string | number;

Parse the location from ProductSet resource.

Parameter
NameDescription
productSetName string

A fully-qualified path representing ProductSet resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchLocationFromReferenceImageName(referenceImageName)

matchLocationFromReferenceImageName(referenceImageName: string): string | number;

Parse the location from ReferenceImage resource.

Parameter
NameDescription
referenceImageName string

A fully-qualified path representing ReferenceImage resource.

Returns
TypeDescription
string | number

{string} A string representing the location.

matchProductFromProductName(productName)

matchProductFromProductName(productName: string): string | number;

Parse the product from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the product.

matchProductFromReferenceImageName(referenceImageName)

matchProductFromReferenceImageName(referenceImageName: string): string | number;

Parse the product from ReferenceImage resource.

Parameter
NameDescription
referenceImageName string

A fully-qualified path representing ReferenceImage resource.

Returns
TypeDescription
string | number

{string} A string representing the product.

matchProductSetFromProductSetName(productSetName)

matchProductSetFromProductSetName(productSetName: string): string | number;

Parse the product_set from ProductSet resource.

Parameter
NameDescription
productSetName string

A fully-qualified path representing ProductSet resource.

Returns
TypeDescription
string | number

{string} A string representing the product_set.

matchProjectFromLocationName(locationName)

matchProjectFromLocationName(locationName: string): string | number;

Parse the project from Location resource.

Parameter
NameDescription
locationName string

A fully-qualified path representing Location resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProductName(productName)

matchProjectFromProductName(productName: string): string | number;

Parse the project from Product resource.

Parameter
NameDescription
productName string

A fully-qualified path representing Product resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromProductSetName(productSetName)

matchProjectFromProductSetName(productSetName: string): string | number;

Parse the project from ProductSet resource.

Parameter
NameDescription
productSetName string

A fully-qualified path representing ProductSet resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchProjectFromReferenceImageName(referenceImageName)

matchProjectFromReferenceImageName(referenceImageName: string): string | number;

Parse the project from ReferenceImage resource.

Parameter
NameDescription
referenceImageName string

A fully-qualified path representing ReferenceImage resource.

Returns
TypeDescription
string | number

{string} A string representing the project.

matchReferenceImageFromReferenceImageName(referenceImageName)

matchReferenceImageFromReferenceImageName(referenceImageName: string): string | number;

Parse the reference_image from ReferenceImage resource.

Parameter
NameDescription
referenceImageName string

A fully-qualified path representing ReferenceImage resource.

Returns
TypeDescription
string | number

{string} A string representing the reference_image.

productPath(project, location, product)

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

Return a fully-qualified product resource name string.

Parameters
NameDescription
project string
location string
product string
Returns
TypeDescription
string

{string} Resource name string.

productSetPath(project, location, productSet)

productSetPath(project: string, location: string, productSet: string): string;

Return a fully-qualified productSet resource name string.

Parameters
NameDescription
project string
location string
productSet string
Returns
TypeDescription
string

{string} Resource name string.

referenceImagePath(project, location, product, referenceImage)

referenceImagePath(project: string, location: string, product: string, referenceImage: string): string;

Return a fully-qualified referenceImage resource name string.

Parameters
NameDescription
project string
location string
product string
referenceImage string
Returns
TypeDescription
string

{string} Resource name string.

removeProductFromProductSet(request, options)

removeProductFromProductSet(request?: protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest | undefined), {} | undefined]>;

Removes a Product from the specified ProductSet.

Possible errors:

* Returns NOT_FOUND If the Product is not found under the ProductSet.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.protobuf.IEmpty, (protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest | undefined), {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The resource name for the ProductSet to modify.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`
   */
  // const name = 'abc123'
  /**
   *  Required. The resource name for the Product to be removed from this ProductSet.
   *  Format is:
   *  `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
   */
  // const product = 'abc123'

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

    // Run request
    const response = await visionClient.removeProductFromProductSet(request);
    console.log(response);
  }

  callRemoveProductFromProductSet();

removeProductFromProductSet(request, options, callback)

removeProductFromProductSet(request: protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest
options CallOptions
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

removeProductFromProductSet(request, callback)

removeProductFromProductSet(request: protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest
callback Callback<protos.google.protobuf.IEmpty, protos.google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateProduct(request, options)

updateProduct(request?: protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest | undefined, {} | undefined]>;

Makes changes to a Product resource. Only display_name, description and labels can be updated right now.

If labels are updated, the change will not be reflected in queries until the next index time.

Possible errors:

* Returns NOT_FOUND if the Product does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters. * Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters. * Returns INVALID_ARGUMENT if product_category is present in update_mask.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The Product resource which replaces the one on the server.
   *  product.name is immutable.
   */
  // const product = {}
  /**
   *  The FieldMask google.protobuf.FieldMask  that specifies which fields
   *  to update.
   *  If update_mask isn't specified, all mutable fields are to be updated.
   *  Valid mask paths include `product_labels`, `display_name`, and
   *  `description`.
   */
  // const updateMask = {}

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

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

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

  callUpdateProduct();

updateProduct(request, options, callback)

updateProduct(request: protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateProduct(request, callback)

updateProduct(request: protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IProduct, protos.google.cloud.vision.v1p3beta1.IUpdateProductRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateProductSet(request, options)

updateProductSet(request?: protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest, options?: CallOptions): Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest | undefined, {} | undefined]>;

Makes changes to a ProductSet resource. Only display_name can be updated currently.

Possible errors:

* Returns NOT_FOUND if the ProductSet does not exist. * Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters.

Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest

The request object that will be sent.

options CallOptions

Call options. See CallOptions for more details.

Returns
TypeDescription
Promise<[protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest | undefined, {} | undefined]>

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

Example

  /**
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  Required. The ProductSet resource which replaces the one on the server.
   */
  // const productSet = {}
  /**
   *  The FieldMask google.protobuf.FieldMask  that specifies which fields to
   *  update.
   *  If update_mask isn't specified, all mutable fields are to be updated.
   *  Valid mask path is `display_name`.
   */
  // const updateMask = {}

  // Imports the Vision library
  const {ProductSearchClient} = require('@google-cloud/vision').v1p3beta1;

  // Instantiates a client
  const visionClient = new ProductSearchClient();

  async function callUpdateProductSet() {
    // Construct request
    const request = {
      productSet,
    };

    // Run request
    const response = await visionClient.updateProductSet(request);
    console.log(response);
  }

  callUpdateProductSet();

updateProductSet(request, options, callback)

updateProductSet(request: protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest, options: CallOptions, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest
options CallOptions
callback Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void

updateProductSet(request, callback)

updateProductSet(request: protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest, callback: Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>): void;
Parameters
NameDescription
request protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest
callback Callback<protos.google.cloud.vision.v1p3beta1.IProductSet, protos.google.cloud.vision.v1p3beta1.IUpdateProductSetRequest | null | undefined, {} | null | undefined>
Returns
TypeDescription
void