Class protos.google.cloud.vision.v1p3beta1.ProductSearch (4.2.1)

Represents a ProductSearch

Inheritance

$protobuf.rpc.Service > protos.google.cloud.vision.v1p3beta1.ProductSearch

Package

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new ProductSearch service.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Methods

addProductToProductSet(request, callback)

public addProductToProductSet(request: google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.AddProductToProductSetCallback): void;

Calls AddProductToProductSet.

Parameters
Name	Description
`request`	`IAddProductToProductSetRequest` AddProductToProductSetRequest message or plain object
`callback`	`AddProductToProductSetCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

addProductToProductSet(request)

public addProductToProductSet(request: google.cloud.vision.v1p3beta1.IAddProductToProductSetRequest): Promise<google.protobuf.Empty>;

Calls AddProductToProductSet.

Parameter
Name	Description
`request`	`IAddProductToProductSetRequest` AddProductToProductSetRequest message or plain object

Returns
Type	Description
`Promise<google.protobuf.Empty>`	Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): ProductSearch;

Creates new ProductSearch service using the specified rpc implementation.

Parameters
Name	Description
`rpcImpl`	`$protobuf.RPCImpl` RPC implementation
`requestDelimited`	`boolean` Whether requests are length-delimited
`responseDelimited`	`boolean` Whether responses are length-delimited

Returns
Type	Description
`ProductSearch`	RPC service. Useful where requests and/or responses are streamed.

createProduct(request, callback)

public createProduct(request: google.cloud.vision.v1p3beta1.ICreateProductRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.CreateProductCallback): void;

Calls CreateProduct.

Parameters
Name	Description
`request`	`ICreateProductRequest` CreateProductRequest message or plain object
`callback`	`CreateProductCallback` Node-style callback called with the error, if any, and Product

Returns
Type	Description
`void`

createProduct(request)

public createProduct(request: google.cloud.vision.v1p3beta1.ICreateProductRequest): Promise<google.cloud.vision.v1p3beta1.Product>;

Calls CreateProduct.

Parameter
Name	Description
`request`	`ICreateProductRequest` CreateProductRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.Product>`	Promise

createProductSet(request, callback)

public createProductSet(request: google.cloud.vision.v1p3beta1.ICreateProductSetRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.CreateProductSetCallback): void;

Calls CreateProductSet.

Parameters
Name	Description
`request`	`ICreateProductSetRequest` CreateProductSetRequest message or plain object
`callback`	`CreateProductSetCallback` Node-style callback called with the error, if any, and ProductSet

Returns
Type	Description
`void`

createProductSet(request)

public createProductSet(request: google.cloud.vision.v1p3beta1.ICreateProductSetRequest): Promise<google.cloud.vision.v1p3beta1.ProductSet>;

Calls CreateProductSet.

Parameter
Name	Description
`request`	`ICreateProductSetRequest` CreateProductSetRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ProductSet>`	Promise

createReferenceImage(request, callback)

public createReferenceImage(request: google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.CreateReferenceImageCallback): void;

Calls CreateReferenceImage.

Parameters
Name	Description
`request`	`ICreateReferenceImageRequest` CreateReferenceImageRequest message or plain object
`callback`	`CreateReferenceImageCallback` Node-style callback called with the error, if any, and ReferenceImage

Returns
Type	Description
`void`

createReferenceImage(request)

public createReferenceImage(request: google.cloud.vision.v1p3beta1.ICreateReferenceImageRequest): Promise<google.cloud.vision.v1p3beta1.ReferenceImage>;

Calls CreateReferenceImage.

Parameter
Name	Description
`request`	`ICreateReferenceImageRequest` CreateReferenceImageRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ReferenceImage>`	Promise

deleteProduct(request, callback)

public deleteProduct(request: google.cloud.vision.v1p3beta1.IDeleteProductRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.DeleteProductCallback): void;

Calls DeleteProduct.

Parameters
Name	Description
`request`	`IDeleteProductRequest` DeleteProductRequest message or plain object
`callback`	`DeleteProductCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

deleteProduct(request)

public deleteProduct(request: google.cloud.vision.v1p3beta1.IDeleteProductRequest): Promise<google.protobuf.Empty>;

Calls DeleteProduct.

Parameter
Name	Description
`request`	`IDeleteProductRequest` DeleteProductRequest message or plain object

Returns
Type	Description
`Promise<google.protobuf.Empty>`	Promise

deleteProductSet(request, callback)

public deleteProductSet(request: google.cloud.vision.v1p3beta1.IDeleteProductSetRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.DeleteProductSetCallback): void;

Calls DeleteProductSet.

Parameters
Name	Description
`request`	`IDeleteProductSetRequest` DeleteProductSetRequest message or plain object
`callback`	`DeleteProductSetCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

deleteProductSet(request)

public deleteProductSet(request: google.cloud.vision.v1p3beta1.IDeleteProductSetRequest): Promise<google.protobuf.Empty>;

Calls DeleteProductSet.

Parameter
Name	Description
`request`	`IDeleteProductSetRequest` DeleteProductSetRequest message or plain object

Returns
Type	Description
`Promise<google.protobuf.Empty>`	Promise

deleteReferenceImage(request, callback)

public deleteReferenceImage(request: google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.DeleteReferenceImageCallback): void;

Calls DeleteReferenceImage.

Parameters
Name	Description
`request`	`IDeleteReferenceImageRequest` DeleteReferenceImageRequest message or plain object
`callback`	`DeleteReferenceImageCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

deleteReferenceImage(request)

public deleteReferenceImage(request: google.cloud.vision.v1p3beta1.IDeleteReferenceImageRequest): Promise<google.protobuf.Empty>;

Calls DeleteReferenceImage.

Parameter
Name	Description
`request`	`IDeleteReferenceImageRequest` DeleteReferenceImageRequest message or plain object

Returns
Type	Description
`Promise<google.protobuf.Empty>`	Promise

getProduct(request, callback)

public getProduct(request: google.cloud.vision.v1p3beta1.IGetProductRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.GetProductCallback): void;

Calls GetProduct.

Parameters
Name	Description
`request`	`IGetProductRequest` GetProductRequest message or plain object
`callback`	`GetProductCallback` Node-style callback called with the error, if any, and Product

Returns
Type	Description
`void`

getProduct(request)

public getProduct(request: google.cloud.vision.v1p3beta1.IGetProductRequest): Promise<google.cloud.vision.v1p3beta1.Product>;

Calls GetProduct.

Parameter
Name	Description
`request`	`IGetProductRequest` GetProductRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.Product>`	Promise

getProductSet(request, callback)

public getProductSet(request: google.cloud.vision.v1p3beta1.IGetProductSetRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.GetProductSetCallback): void;

Calls GetProductSet.

Parameters
Name	Description
`request`	`IGetProductSetRequest` GetProductSetRequest message or plain object
`callback`	`GetProductSetCallback` Node-style callback called with the error, if any, and ProductSet

Returns
Type	Description
`void`

getProductSet(request)

public getProductSet(request: google.cloud.vision.v1p3beta1.IGetProductSetRequest): Promise<google.cloud.vision.v1p3beta1.ProductSet>;

Calls GetProductSet.

Parameter
Name	Description
`request`	`IGetProductSetRequest` GetProductSetRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ProductSet>`	Promise

getReferenceImage(request, callback)

public getReferenceImage(request: google.cloud.vision.v1p3beta1.IGetReferenceImageRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.GetReferenceImageCallback): void;

Calls GetReferenceImage.

Parameters
Name	Description
`request`	`IGetReferenceImageRequest` GetReferenceImageRequest message or plain object
`callback`	`GetReferenceImageCallback` Node-style callback called with the error, if any, and ReferenceImage

Returns
Type	Description
`void`

getReferenceImage(request)

public getReferenceImage(request: google.cloud.vision.v1p3beta1.IGetReferenceImageRequest): Promise<google.cloud.vision.v1p3beta1.ReferenceImage>;

Calls GetReferenceImage.

Parameter
Name	Description
`request`	`IGetReferenceImageRequest` GetReferenceImageRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ReferenceImage>`	Promise

importProductSets(request, callback)

public importProductSets(request: google.cloud.vision.v1p3beta1.IImportProductSetsRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.ImportProductSetsCallback): void;

Calls ImportProductSets.

Parameters
Name	Description
`request`	`IImportProductSetsRequest` ImportProductSetsRequest message or plain object
`callback`	`ImportProductSetsCallback` Node-style callback called with the error, if any, and Operation

Returns
Type	Description
`void`

importProductSets(request)

public importProductSets(request: google.cloud.vision.v1p3beta1.IImportProductSetsRequest): Promise<google.longrunning.Operation>;

Calls ImportProductSets.

Parameter
Name	Description
`request`	`IImportProductSetsRequest` ImportProductSetsRequest message or plain object

Returns
Type	Description
`Promise<google.longrunning.Operation>`	Promise

listProducts(request, callback)

public listProducts(request: google.cloud.vision.v1p3beta1.IListProductsRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.ListProductsCallback): void;

Calls ListProducts.

Parameters
Name	Description
`request`	`IListProductsRequest` ListProductsRequest message or plain object
`callback`	`ListProductsCallback` Node-style callback called with the error, if any, and ListProductsResponse

Returns
Type	Description
`void`

listProducts(request)

public listProducts(request: google.cloud.vision.v1p3beta1.IListProductsRequest): Promise<google.cloud.vision.v1p3beta1.ListProductsResponse>;

Calls ListProducts.

Parameter
Name	Description
`request`	`IListProductsRequest` ListProductsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ListProductsResponse>`	Promise

listProductSets(request, callback)

public listProductSets(request: google.cloud.vision.v1p3beta1.IListProductSetsRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.ListProductSetsCallback): void;

Calls ListProductSets.

Parameters
Name	Description
`request`	`IListProductSetsRequest` ListProductSetsRequest message or plain object
`callback`	`ListProductSetsCallback` Node-style callback called with the error, if any, and ListProductSetsResponse

Returns
Type	Description
`void`

listProductSets(request)

public listProductSets(request: google.cloud.vision.v1p3beta1.IListProductSetsRequest): Promise<google.cloud.vision.v1p3beta1.ListProductSetsResponse>;

Calls ListProductSets.

Parameter
Name	Description
`request`	`IListProductSetsRequest` ListProductSetsRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ListProductSetsResponse>`	Promise

listProductsInProductSet(request, callback)

public listProductsInProductSet(request: google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.ListProductsInProductSetCallback): void;

Calls ListProductsInProductSet.

Parameters
Name	Description
`request`	`IListProductsInProductSetRequest` ListProductsInProductSetRequest message or plain object
`callback`	`ListProductsInProductSetCallback` Node-style callback called with the error, if any, and ListProductsInProductSetResponse

Returns
Type	Description
`void`

listProductsInProductSet(request)

public listProductsInProductSet(request: google.cloud.vision.v1p3beta1.IListProductsInProductSetRequest): Promise<google.cloud.vision.v1p3beta1.ListProductsInProductSetResponse>;

Calls ListProductsInProductSet.

Parameter
Name	Description
`request`	`IListProductsInProductSetRequest` ListProductsInProductSetRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ListProductsInProductSetResponse>`	Promise

listReferenceImages(request, callback)

public listReferenceImages(request: google.cloud.vision.v1p3beta1.IListReferenceImagesRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.ListReferenceImagesCallback): void;

Calls ListReferenceImages.

Parameters
Name	Description
`request`	`IListReferenceImagesRequest` ListReferenceImagesRequest message or plain object
`callback`	`ListReferenceImagesCallback` Node-style callback called with the error, if any, and ListReferenceImagesResponse

Returns
Type	Description
`void`

listReferenceImages(request)

public listReferenceImages(request: google.cloud.vision.v1p3beta1.IListReferenceImagesRequest): Promise<google.cloud.vision.v1p3beta1.ListReferenceImagesResponse>;

Calls ListReferenceImages.

Parameter
Name	Description
`request`	`IListReferenceImagesRequest` ListReferenceImagesRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ListReferenceImagesResponse>`	Promise

removeProductFromProductSet(request, callback)

public removeProductFromProductSet(request: google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.RemoveProductFromProductSetCallback): void;

Calls RemoveProductFromProductSet.

Parameters
Name	Description
`request`	`IRemoveProductFromProductSetRequest` RemoveProductFromProductSetRequest message or plain object
`callback`	`RemoveProductFromProductSetCallback` Node-style callback called with the error, if any, and Empty

Returns
Type	Description
`void`

removeProductFromProductSet(request)

public removeProductFromProductSet(request: google.cloud.vision.v1p3beta1.IRemoveProductFromProductSetRequest): Promise<google.protobuf.Empty>;

Calls RemoveProductFromProductSet.

Parameter
Name	Description
`request`	`IRemoveProductFromProductSetRequest` RemoveProductFromProductSetRequest message or plain object

Returns
Type	Description
`Promise<google.protobuf.Empty>`	Promise

updateProduct(request, callback)

public updateProduct(request: google.cloud.vision.v1p3beta1.IUpdateProductRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.UpdateProductCallback): void;

Calls UpdateProduct.

Parameters
Name	Description
`request`	`IUpdateProductRequest` UpdateProductRequest message or plain object
`callback`	`UpdateProductCallback` Node-style callback called with the error, if any, and Product

Returns
Type	Description
`void`

updateProduct(request)

public updateProduct(request: google.cloud.vision.v1p3beta1.IUpdateProductRequest): Promise<google.cloud.vision.v1p3beta1.Product>;

Calls UpdateProduct.

Parameter
Name	Description
`request`	`IUpdateProductRequest` UpdateProductRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.Product>`	Promise

updateProductSet(request, callback)

public updateProductSet(request: google.cloud.vision.v1p3beta1.IUpdateProductSetRequest, callback: google.cloud.vision.v1p3beta1.ProductSearch.UpdateProductSetCallback): void;

Calls UpdateProductSet.

Parameters
Name	Description
`request`	`IUpdateProductSetRequest` UpdateProductSetRequest message or plain object
`callback`	`UpdateProductSetCallback` Node-style callback called with the error, if any, and ProductSet

Returns
Type	Description
`void`

updateProductSet(request)

public updateProductSet(request: google.cloud.vision.v1p3beta1.IUpdateProductSetRequest): Promise<google.cloud.vision.v1p3beta1.ProductSet>;

Calls UpdateProductSet.

Parameter
Name	Description
`request`	`IUpdateProductSetRequest` UpdateProductSetRequest message or plain object

Returns
Type	Description
`Promise<google.cloud.vision.v1p3beta1.ProductSet>`	Promise