Package com.google.cloud.retail.v2alpha

Class ProductServiceGrpc.ProductServiceBlockingStub

  • Enclosing class:
    ProductServiceGrpc
    public static final class ProductServiceGrpc.ProductServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<ProductServiceGrpc.ProductServiceBlockingStub>
    A stub to allow clients to do synchronous rpc calls to service ProductService. 
     Service for ingesting [Product][google.cloud.retail.v2alpha.Product]
 information of the customer's website.

    • Method Detail

      • createProduct

        public Product createProduct​(CreateProductRequest request)
         Creates a [Product][google.cloud.retail.v2alpha.Product].

      • getProduct

        public Product getProduct​(GetProductRequest request)
         Gets a [Product][google.cloud.retail.v2alpha.Product].

      • updateProduct

        public Product updateProduct​(UpdateProductRequest request)
         Updates a [Product][google.cloud.retail.v2alpha.Product].

      • deleteProduct

        public com.google.protobuf.Empty deleteProduct​(DeleteProductRequest request)
         Deletes a [Product][google.cloud.retail.v2alpha.Product].

      • purgeProducts

        public com.google.longrunning.Operation purgeProducts​(PurgeProductsRequest request)
         Permanently deletes all selected
 [Product][google.cloud.retail.v2alpha.Product]s under a branch.
 This process is asynchronous. If the request is valid, the removal will be
 enqueued and processed offline. Depending on the number of
 [Product][google.cloud.retail.v2alpha.Product]s, this operation could take
 hours to complete. Before the operation completes, some
 [Product][google.cloud.retail.v2alpha.Product]s may still be returned by
 [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
 Depending on the number of [Product][google.cloud.retail.v2alpha.Product]s,
 this operation could take hours to complete. To get a sample of
 [Product][google.cloud.retail.v2alpha.Product]s that would be deleted, set
 [PurgeProductsRequest.force][google.cloud.retail.v2alpha.PurgeProductsRequest.force]
 to false.

      • importProducts

        public com.google.longrunning.Operation importProducts​(ImportProductsRequest request)
         Bulk import of multiple [Product][google.cloud.retail.v2alpha.Product]s.
 Request processing may be synchronous.
 Non-existing items are created.
 Note that it is possible for a subset of the
 [Product][google.cloud.retail.v2alpha.Product]s to be successfully updated.

      • setInventory

        public com.google.longrunning.Operation setInventory​(SetInventoryRequest request)
         Updates inventory information for a
 [Product][google.cloud.retail.v2alpha.Product] while respecting the last
 update timestamps of each inventory field.
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
 When inventory is updated with
 [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.ProductService.CreateProduct]
 or
 [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct]
 request.
 If no inventory fields are set in
 [CreateProductRequest.product][google.cloud.retail.v2alpha.CreateProductRequest.product],
 then any pre-existing inventory information for this product is used.
 If no inventory fields are set in
 [SetInventoryRequest.set_mask][google.cloud.retail.v2alpha.SetInventoryRequest.set_mask],
 then any existing inventory information is preserved.
 Pre-existing inventory information can only be updated with
 [ProductService.SetInventory][google.cloud.retail.v2alpha.ProductService.SetInventory],
 [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.AddFulfillmentPlaces],
 and
 [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlaces].
 The returned [Operation][google.longrunning.Operation]s is obsolete after
 one day, and the [GetOperation][google.longrunning.Operations.GetOperation]
 API returns `NOT_FOUND` afterwards.
 If conflicting updates are issued, the
 [Operation][google.longrunning.Operation]s associated with the stale
 updates are not marked as [done][google.longrunning.Operation.done] until
 they are obsolete.

      • addFulfillmentPlaces

        public com.google.longrunning.Operation addFulfillmentPlaces​(AddFulfillmentPlacesRequest request)
         It is recommended to use the
 [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories]
 method instead of
 [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.AddFulfillmentPlaces].
 [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids].
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
 The returned [Operation][google.longrunning.Operation]s will be obsolete
 after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
 API will return NOT_FOUND afterwards.
 If conflicting updates are issued, the
 [Operation][google.longrunning.Operation]s associated with the stale
 updates will not be marked as [done][google.longrunning.Operation.done]
 until being obsolete.

      • removeFulfillmentPlaces

        public com.google.longrunning.Operation removeFulfillmentPlaces​(RemoveFulfillmentPlacesRequest request)
         It is recommended to use the
 [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories]
 method instead of
 [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlaces].
 [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids].
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
 The returned [Operation][google.longrunning.Operation]s will be obsolete
 after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
 API will return NOT_FOUND afterwards.
 If conflicting updates are issued, the
 [Operation][google.longrunning.Operation]s associated with the stale
 updates will not be marked as [done][google.longrunning.Operation.done]
 until being obsolete.

      • addLocalInventories

        public com.google.longrunning.Operation addLocalInventories​(AddLocalInventoriesRequest request)
         Updates local inventory information for a
 [Product][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
 Local inventory information can only be modified using this method.
 [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct]
 has no effect on local inventories.
 The returned [Operation][google.longrunning.Operation]s will be obsolete
 after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
 API will return NOT_FOUND afterwards.
 If conflicting updates are issued, the
 [Operation][google.longrunning.Operation]s associated with the stale
 updates will not be marked as [done][google.longrunning.Operation.done]
 until being obsolete.

      • removeLocalInventories

        public com.google.longrunning.Operation removeLocalInventories​(RemoveLocalInventoriesRequest request)
         Remove local inventory information for a
 [Product][google.cloud.retail.v2alpha.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][google.cloud.retail.v2alpha.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
 Local inventory information can only be removed using this method.
 [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct]
 has no effect on local inventories.
 The returned [Operation][google.longrunning.Operation]s will be obsolete
 after 1 day, and [GetOperation][google.longrunning.Operations.GetOperation]
 API will return NOT_FOUND afterwards.
 If conflicting updates are issued, the
 [Operation][google.longrunning.Operation]s associated with the stale
 updates will not be marked as [done][google.longrunning.Operation.done]
 until being obsolete.