Interface ProductServiceGrpc.AsyncService (2.29.0)

public static interface ProductServiceGrpc.AsyncService

Service for ingesting Product information of the customer's website.

Methods

addFulfillmentPlaces(AddFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)

public default void addFulfillmentPlaces(AddFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)

It is recommended to use the ProductService.AddLocalInventories method instead of ProductService.AddFulfillmentPlaces. ProductService.AddLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally adds place IDs to Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

Parameters
NameDescription
requestAddFulfillmentPlacesRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

addLocalInventories(AddLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)

public default void addLocalInventories(AddLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)

Updates local inventory information for a Product at a list of places, while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be modified using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

Parameters
NameDescription
requestAddLocalInventoriesRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

createProduct(CreateProductRequest request, StreamObserver<Product> responseObserver)

public default void createProduct(CreateProductRequest request, StreamObserver<Product> responseObserver)

Creates a Product.

Parameters
NameDescription
requestCreateProductRequest
responseObserverio.grpc.stub.StreamObserver<Product>

deleteProduct(DeleteProductRequest request, StreamObserver<Empty> responseObserver)

public default void deleteProduct(DeleteProductRequest request, StreamObserver<Empty> responseObserver)

Deletes a Product.

Parameters
NameDescription
requestDeleteProductRequest
responseObserverio.grpc.stub.StreamObserver<Empty>

getProduct(GetProductRequest request, StreamObserver<Product> responseObserver)

public default void getProduct(GetProductRequest request, StreamObserver<Product> responseObserver)

Gets a Product.

Parameters
NameDescription
requestGetProductRequest
responseObserverio.grpc.stub.StreamObserver<Product>

importProducts(ImportProductsRequest request, StreamObserver<Operation> responseObserver)

public default void importProducts(ImportProductsRequest request, StreamObserver<Operation> responseObserver)

Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated.

Parameters
NameDescription
requestImportProductsRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

listProducts(ListProductsRequest request, StreamObserver<ListProductsResponse> responseObserver)

public default void listProducts(ListProductsRequest request, StreamObserver<ListProductsResponse> responseObserver)

Gets a list of Products.

Parameters
NameDescription
requestListProductsRequest
responseObserverio.grpc.stub.StreamObserver<ListProductsResponse>

removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)

public default void removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)

It is recommended to use the ProductService.RemoveLocalInventories method instead of ProductService.RemoveFulfillmentPlaces. ProductService.RemoveLocalInventories achieves the same results but provides more fine-grained control over ingesting local inventory data. Incrementally removes place IDs from a Product.fulfillment_info.place_ids. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

Parameters
NameDescription
requestRemoveFulfillmentPlacesRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

removeLocalInventories(RemoveLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)

public default void removeLocalInventories(RemoveLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)

Remove local inventory information for a Product at a list of places at a removal timestamp. This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. Local inventory information can only be removed using this method. ProductService.CreateProduct and ProductService.UpdateProduct has no effect on local inventories. The returned Operations will be obsolete after 1 day, and GetOperation API will return NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates will not be marked as done until being obsolete.

Parameters
NameDescription
requestRemoveLocalInventoriesRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

setInventory(SetInventoryRequest request, StreamObserver<Operation> responseObserver)

public default void setInventory(SetInventoryRequest request, StreamObserver<Operation> responseObserver)

Updates inventory information for a Product while respecting the last update timestamps of each inventory field. This process is asynchronous and does not require the Product to exist before updating fulfillment information. If the request is valid, the update is enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by ProductService.GetProduct or ProductService.ListProducts. When inventory is updated with ProductService.CreateProduct and ProductService.UpdateProduct, the specified inventory field value(s) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times of the ProductService.CreateProduct or ProductService.UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product is used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information is preserved. Pre-existing inventory information can only be updated with ProductService.SetInventory, ProductService.AddFulfillmentPlaces, and ProductService.RemoveFulfillmentPlaces. The returned Operations is obsolete after one day, and the GetOperation API returns NOT_FOUND afterwards. If conflicting updates are issued, the Operations associated with the stale updates are not marked as done until they are obsolete.

Parameters
NameDescription
requestSetInventoryRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

updateProduct(UpdateProductRequest request, StreamObserver<Product> responseObserver)

public default void updateProduct(UpdateProductRequest request, StreamObserver<Product> responseObserver)

Updates a Product.

Parameters
NameDescription
requestUpdateProductRequest
responseObserverio.grpc.stub.StreamObserver<Product>