Class protos.google.cloud.retail.v2.ProductService (3.1.0)

Represents a ProductService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.retail.v2.ProductService

Package

@google-cloud/retail

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new ProductService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

addFulfillmentPlaces(request, callback)

public addFulfillmentPlaces(request: google.cloud.retail.v2.IAddFulfillmentPlacesRequest, callback: google.cloud.retail.v2.ProductService.AddFulfillmentPlacesCallback): void;

Calls AddFulfillmentPlaces.

Parameters
Name Description
request IAddFulfillmentPlacesRequest

AddFulfillmentPlacesRequest message or plain object
callback AddFulfillmentPlacesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

addFulfillmentPlaces(request)

public addFulfillmentPlaces(request: google.cloud.retail.v2.IAddFulfillmentPlacesRequest): Promise<google.longrunning.Operation>;

Calls AddFulfillmentPlaces.

Parameter
Name Description
request IAddFulfillmentPlacesRequest

AddFulfillmentPlacesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

addLocalInventories(request, callback)

public addLocalInventories(request: google.cloud.retail.v2.IAddLocalInventoriesRequest, callback: google.cloud.retail.v2.ProductService.AddLocalInventoriesCallback): void;

Calls AddLocalInventories.

Parameters
Name Description
request IAddLocalInventoriesRequest

AddLocalInventoriesRequest message or plain object
callback AddLocalInventoriesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

addLocalInventories(request)

public addLocalInventories(request: google.cloud.retail.v2.IAddLocalInventoriesRequest): Promise<google.longrunning.Operation>;

Calls AddLocalInventories.

Parameter
Name Description
request IAddLocalInventoriesRequest

AddLocalInventoriesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new ProductService 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
ProductService

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

createProduct(request, callback)

public createProduct(request: google.cloud.retail.v2.ICreateProductRequest, callback: google.cloud.retail.v2.ProductService.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.retail.v2.ICreateProductRequest): Promise<google.cloud.retail.v2.Product>;

Calls CreateProduct.

Parameter
Name Description
request ICreateProductRequest

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

Promise

deleteProduct(request, callback)

public deleteProduct(request: google.cloud.retail.v2.IDeleteProductRequest, callback: google.cloud.retail.v2.ProductService.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.retail.v2.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

getProduct(request, callback)

public getProduct(request: google.cloud.retail.v2.IGetProductRequest, callback: google.cloud.retail.v2.ProductService.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.retail.v2.IGetProductRequest): Promise<google.cloud.retail.v2.Product>;

Calls GetProduct.

Parameter
Name Description
request IGetProductRequest

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

Promise

importProducts(request, callback)

public importProducts(request: google.cloud.retail.v2.IImportProductsRequest, callback: google.cloud.retail.v2.ProductService.ImportProductsCallback): void;

Calls ImportProducts.

Parameters
Name Description
request IImportProductsRequest

ImportProductsRequest message or plain object
callback ImportProductsCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

importProducts(request)

public importProducts(request: google.cloud.retail.v2.IImportProductsRequest): Promise<google.longrunning.Operation>;

Calls ImportProducts.

Parameter
Name Description
request IImportProductsRequest

ImportProductsRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

listProducts(request, callback)

public listProducts(request: google.cloud.retail.v2.IListProductsRequest, callback: google.cloud.retail.v2.ProductService.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.retail.v2.IListProductsRequest): Promise<google.cloud.retail.v2.ListProductsResponse>;

Calls ListProducts.

Parameter
Name Description
request IListProductsRequest

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

Promise

removeFulfillmentPlaces(request, callback)

public removeFulfillmentPlaces(request: google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest, callback: google.cloud.retail.v2.ProductService.RemoveFulfillmentPlacesCallback): void;

Calls RemoveFulfillmentPlaces.

Parameters
Name Description
request IRemoveFulfillmentPlacesRequest

RemoveFulfillmentPlacesRequest message or plain object
callback RemoveFulfillmentPlacesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

removeFulfillmentPlaces(request)

public removeFulfillmentPlaces(request: google.cloud.retail.v2.IRemoveFulfillmentPlacesRequest): Promise<google.longrunning.Operation>;

Calls RemoveFulfillmentPlaces.

Parameter
Name Description
request IRemoveFulfillmentPlacesRequest

RemoveFulfillmentPlacesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

removeLocalInventories(request, callback)

public removeLocalInventories(request: google.cloud.retail.v2.IRemoveLocalInventoriesRequest, callback: google.cloud.retail.v2.ProductService.RemoveLocalInventoriesCallback): void;

Calls RemoveLocalInventories.

Parameters
Name Description
request IRemoveLocalInventoriesRequest

RemoveLocalInventoriesRequest message or plain object
callback RemoveLocalInventoriesCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

removeLocalInventories(request)

public removeLocalInventories(request: google.cloud.retail.v2.IRemoveLocalInventoriesRequest): Promise<google.longrunning.Operation>;

Calls RemoveLocalInventories.

Parameter
Name Description
request IRemoveLocalInventoriesRequest

RemoveLocalInventoriesRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

setInventory(request, callback)

public setInventory(request: google.cloud.retail.v2.ISetInventoryRequest, callback: google.cloud.retail.v2.ProductService.SetInventoryCallback): void;

Calls SetInventory.

Parameters
Name Description
request ISetInventoryRequest

SetInventoryRequest message or plain object
callback SetInventoryCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setInventory(request)

public setInventory(request: google.cloud.retail.v2.ISetInventoryRequest): Promise<google.longrunning.Operation>;

Calls SetInventory.

Parameter
Name Description
request ISetInventoryRequest

SetInventoryRequest message or plain object
Returns
Type Description
Promise<google.longrunning.Operation>

Promise

updateProduct(request, callback)

public updateProduct(request: google.cloud.retail.v2.IUpdateProductRequest, callback: google.cloud.retail.v2.ProductService.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.retail.v2.IUpdateProductRequest): Promise<google.cloud.retail.v2.Product>;

Calls UpdateProduct.

Parameter
Name Description
request IUpdateProductRequest

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

Promise