ProductService

google .cloud .retail .v2alpha. ProductService

Represents a ProductService

Constructor

new ProductService(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new ProductService service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

addFulfillmentPlaces(request, callback) → {undefined}

Calls AddFulfillmentPlaces.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IAddFulfillmentPlacesRequest	AddFulfillmentPlacesRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.AddFulfillmentPlacesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

addFulfillmentPlaces(request) → {Promise.<google.longrunning.Operation>}

Calls AddFulfillmentPlaces.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IAddFulfillmentPlacesRequest	AddFulfillmentPlacesRequest message or plain object

Returns:

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

addLocalInventories(request, callback) → {undefined}

Calls AddLocalInventories.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IAddLocalInventoriesRequest	AddLocalInventoriesRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.AddLocalInventoriesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

addLocalInventories(request) → {Promise.<google.longrunning.Operation>}

Calls AddLocalInventories.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IAddLocalInventoriesRequest	AddLocalInventoriesRequest message or plain object

Returns:

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

createProduct(request, callback) → {undefined}

Calls CreateProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.ICreateProductRequest	CreateProductRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.CreateProductCallback	Node-style callback called with the error, if any, and Product

Returns:

Type	Description
undefined

createProduct(request) → {Promise.<google.cloud.retail.v2alpha.Product>}

Calls CreateProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.ICreateProductRequest	CreateProductRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2alpha.Product>	Promise

deleteProduct(request, callback) → {undefined}

Calls DeleteProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IDeleteProductRequest	DeleteProductRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.DeleteProductCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteProduct(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IDeleteProductRequest	DeleteProductRequest message or plain object

Returns:

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

exportProducts(request, callback) → {undefined}

Calls ExportProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IExportProductsRequest	ExportProductsRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.ExportProductsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

exportProducts(request) → {Promise.<google.longrunning.Operation>}

Calls ExportProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IExportProductsRequest	ExportProductsRequest message or plain object

Returns:

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

getProduct(request, callback) → {undefined}

Calls GetProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IGetProductRequest	GetProductRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.GetProductCallback	Node-style callback called with the error, if any, and Product

Returns:

Type	Description
undefined

getProduct(request) → {Promise.<google.cloud.retail.v2alpha.Product>}

Calls GetProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IGetProductRequest	GetProductRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2alpha.Product>	Promise

importProducts(request, callback) → {undefined}

Calls ImportProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IImportProductsRequest	ImportProductsRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.ImportProductsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

importProducts(request) → {Promise.<google.longrunning.Operation>}

Calls ImportProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IImportProductsRequest	ImportProductsRequest message or plain object

Returns:

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

listProducts(request, callback) → {undefined}

Calls ListProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IListProductsRequest	ListProductsRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.ListProductsCallback	Node-style callback called with the error, if any, and ListProductsResponse

Returns:

Type	Description
undefined

listProducts(request) → {Promise.<google.cloud.retail.v2alpha.ListProductsResponse>}

Calls ListProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IListProductsRequest	ListProductsRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2alpha.ListProductsResponse>	Promise

purgeProducts(request, callback) → {undefined}

Calls PurgeProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IPurgeProductsRequest	PurgeProductsRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.PurgeProductsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

purgeProducts(request) → {Promise.<google.longrunning.Operation>}

Calls PurgeProducts.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IPurgeProductsRequest	PurgeProductsRequest message or plain object

Returns:

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

removeFulfillmentPlaces(request, callback) → {undefined}

Calls RemoveFulfillmentPlaces.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IRemoveFulfillmentPlacesRequest	RemoveFulfillmentPlacesRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlacesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

removeFulfillmentPlaces(request) → {Promise.<google.longrunning.Operation>}

Calls RemoveFulfillmentPlaces.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IRemoveFulfillmentPlacesRequest	RemoveFulfillmentPlacesRequest message or plain object

Returns:

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

removeLocalInventories(request, callback) → {undefined}

Calls RemoveLocalInventories.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IRemoveLocalInventoriesRequest	RemoveLocalInventoriesRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.RemoveLocalInventoriesCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

removeLocalInventories(request) → {Promise.<google.longrunning.Operation>}

Calls RemoveLocalInventories.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IRemoveLocalInventoriesRequest	RemoveLocalInventoriesRequest message or plain object

Returns:

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

setInventory(request, callback) → {undefined}

Calls SetInventory.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.ISetInventoryRequest	SetInventoryRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.SetInventoryCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

setInventory(request) → {Promise.<google.longrunning.Operation>}

Calls SetInventory.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.ISetInventoryRequest	SetInventoryRequest message or plain object

Returns:

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

updateProduct(request, callback) → {undefined}

Calls UpdateProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IUpdateProductRequest	UpdateProductRequest message or plain object
`callback`	google.cloud.retail.v2alpha.ProductService.UpdateProductCallback	Node-style callback called with the error, if any, and Product

Returns:

Type	Description
undefined

updateProduct(request) → {Promise.<google.cloud.retail.v2alpha.Product>}

Calls UpdateProduct.

Parameters:

Name	Type	Description
`request`	google.cloud.retail.v2alpha.IUpdateProductRequest	UpdateProductRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.retail.v2alpha.Product>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {ProductService}

Creates new ProductService service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
ProductService	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AddFulfillmentPlacesCallback(error, responseopt)

Callback as used by addFulfillmentPlaces.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

AddLocalInventoriesCallback(error, responseopt)

Callback as used by addLocalInventories.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

CreateProductCallback(error, responseopt)

Callback as used by createProduct.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2alpha.Product	<optional>	Product

DeleteProductCallback(error, responseopt)

Callback as used by deleteProduct.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

ExportProductsCallback(error, responseopt)

Callback as used by exportProducts.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

GetProductCallback(error, responseopt)

Callback as used by getProduct.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2alpha.Product	<optional>	Product

ImportProductsCallback(error, responseopt)

Callback as used by importProducts.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

ListProductsCallback(error, responseopt)

Callback as used by listProducts.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2alpha.ListProductsResponse	<optional>	ListProductsResponse

PurgeProductsCallback(error, responseopt)

Callback as used by purgeProducts.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

RemoveFulfillmentPlacesCallback(error, responseopt)

Callback as used by removeFulfillmentPlaces.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

RemoveLocalInventoriesCallback(error, responseopt)

Callback as used by removeLocalInventories.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

SetInventoryCallback(error, responseopt)

Callback as used by setInventory.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.longrunning.Operation	<optional>	Operation

UpdateProductCallback(error, responseopt)

Callback as used by updateProduct.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.retail.v2alpha.Product	<optional>	Product