ProductService

google.cloud.retail.v2. 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.v2.IAddFulfillmentPlacesRequest

AddFulfillmentPlacesRequest message or plain object
callback google.cloud.retail.v2.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.v2.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.v2.IAddLocalInventoriesRequest

AddLocalInventoriesRequest message or plain object
callback google.cloud.retail.v2.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.v2.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.v2.ICreateProductRequest

CreateProductRequest message or plain object
callback google.cloud.retail.v2.ProductService.CreateProductCallback

Node-style callback called with the error, if any, and Product
Returns:
Type Description
undefined

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

Calls CreateProduct.

Parameters:
Name Type Description
request google.cloud.retail.v2.ICreateProductRequest

CreateProductRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.retail.v2.Product>

Promise

deleteProduct(request, callback) → {undefined}

Calls DeleteProduct.

Parameters:
Name Type Description
request google.cloud.retail.v2.IDeleteProductRequest

DeleteProductRequest message or plain object
callback google.cloud.retail.v2.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.v2.IDeleteProductRequest

DeleteProductRequest message or plain object
Returns:
Type Description
Promise.<google.protobuf.Empty>

Promise

getProduct(request, callback) → {undefined}

Calls GetProduct.

Parameters:
Name Type Description
request google.cloud.retail.v2.IGetProductRequest

GetProductRequest message or plain object
callback google.cloud.retail.v2.ProductService.GetProductCallback

Node-style callback called with the error, if any, and Product
Returns:
Type Description
undefined

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

Calls GetProduct.

Parameters:
Name Type Description
request google.cloud.retail.v2.IGetProductRequest

GetProductRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.retail.v2.Product>

Promise

importProducts(request, callback) → {undefined}

Calls ImportProducts.

Parameters:
Name Type Description
request google.cloud.retail.v2.IImportProductsRequest

ImportProductsRequest message or plain object
callback google.cloud.retail.v2.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.v2.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.v2.IListProductsRequest

ListProductsRequest message or plain object
callback google.cloud.retail.v2.ProductService.ListProductsCallback

Node-style callback called with the error, if any, and ListProductsResponse
Returns:
Type Description
undefined

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

Calls ListProducts.

Parameters:
Name Type Description
request google.cloud.retail.v2.IListProductsRequest

ListProductsRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.retail.v2.ListProductsResponse>

Promise

removeFulfillmentPlaces(request, callback) → {undefined}

Calls RemoveFulfillmentPlaces.

Parameters:
Name Type Description
request google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest

RemoveFulfillmentPlacesRequest message or plain object
callback google.cloud.retail.v2.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.v2.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.v2.IRemoveLocalInventoriesRequest

RemoveLocalInventoriesRequest message or plain object
callback google.cloud.retail.v2.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.v2.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.v2.ISetInventoryRequest

SetInventoryRequest message or plain object
callback google.cloud.retail.v2.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.v2.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.v2.IUpdateProductRequest

UpdateProductRequest message or plain object
callback google.cloud.retail.v2.ProductService.UpdateProductCallback

Node-style callback called with the error, if any, and Product
Returns:
Type Description
undefined

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

Calls UpdateProduct.

Parameters:
Name Type Description
request google.cloud.retail.v2.IUpdateProductRequest

UpdateProductRequest message or plain object
Returns:
Type Description
Promise.<google.cloud.retail.v2.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.v2.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

GetProductCallback(error, responseopt)

Callback as used by getProduct.

Parameters:
Name Type Attributes Description
error Error | null

Error, if any
response google.cloud.retail.v2.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.v2.ListProductsResponse <optional>

ListProductsResponse

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.v2.Product <optional>

Product