Package com.google.cloud.retail.v2

Class ProductServiceGrpc.ProductServiceStub

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

    • Nested Class Summary

      • Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

        io.grpc.stub.AbstractStub.StubFactory<T extends io.grpc.stub.AbstractStub<T>>

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addFulfillmentPlaces​(AddFulfillmentPlacesRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      It is recommended to use the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method instead of [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces].
      void addLocalInventories​(AddLocalInventoriesRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Updates local inventory information for a [Product][google.cloud.retail.v2.Product] at a list of places, while respecting the last update timestamps of each inventory field.
      protected ProductServiceGrpc.ProductServiceStub build​(io.grpc.Channel channel, io.grpc.CallOptions callOptions)  
      void createProduct​(CreateProductRequest request, io.grpc.stub.StreamObserver<Product> responseObserver)
      Creates a [Product][google.cloud.retail.v2.Product].
      void deleteProduct​(DeleteProductRequest request, io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
      Deletes a [Product][google.cloud.retail.v2.Product].
      void getProduct​(GetProductRequest request, io.grpc.stub.StreamObserver<Product> responseObserver)
      Gets a [Product][google.cloud.retail.v2.Product].
      void importProducts​(ImportProductsRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Bulk import of multiple [Product][google.cloud.retail.v2.Product]s.
      void listProducts​(ListProductsRequest request, io.grpc.stub.StreamObserver<ListProductsResponse> responseObserver)
      Gets a list of [Product][google.cloud.retail.v2.Product]s.
      void removeFulfillmentPlaces​(RemoveFulfillmentPlacesRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      It is recommended to use the [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] method instead of [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
      void removeLocalInventories​(RemoveLocalInventoriesRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Remove local inventory information for a [Product][google.cloud.retail.v2.Product] at a list of places at a removal timestamp.
      void setInventory​(SetInventoryRequest request, io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
      Updates inventory information for a [Product][google.cloud.retail.v2.Product] while respecting the last update timestamps of each inventory field.
      void updateProduct​(UpdateProductRequest request, io.grpc.stub.StreamObserver<Product> responseObserver)
      Updates a [Product][google.cloud.retail.v2.Product].

      • Methods inherited from class io.grpc.stub.AbstractAsyncStub

        newStub, newStub

      • Methods inherited from class io.grpc.stub.AbstractStub

        getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

    • Method Detail

      • createProduct

        public void createProduct​(CreateProductRequest request,
                          io.grpc.stub.StreamObserver<Product> responseObserver)
         Creates a [Product][google.cloud.retail.v2.Product].

      • getProduct

        public void getProduct​(GetProductRequest request,
                       io.grpc.stub.StreamObserver<Product> responseObserver)
         Gets a [Product][google.cloud.retail.v2.Product].

      • listProducts

        public void listProducts​(ListProductsRequest request,
                         io.grpc.stub.StreamObserver<ListProductsResponse> responseObserver)
         Gets a list of [Product][google.cloud.retail.v2.Product]s.

      • updateProduct

        public void updateProduct​(UpdateProductRequest request,
                          io.grpc.stub.StreamObserver<Product> responseObserver)
         Updates a [Product][google.cloud.retail.v2.Product].

      • deleteProduct

        public void deleteProduct​(DeleteProductRequest request,
                          io.grpc.stub.StreamObserver<com.google.protobuf.Empty> responseObserver)
         Deletes a [Product][google.cloud.retail.v2.Product].

      • importProducts

        public void importProducts​(ImportProductsRequest request,
                           io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Bulk import of multiple [Product][google.cloud.retail.v2.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.v2.Product]s to be successfully updated.

      • setInventory

        public void setInventory​(SetInventoryRequest request,
                         io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Updates inventory information for a
 [Product][google.cloud.retail.v2.Product] while respecting the last update
 timestamps of each inventory field.
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2.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.v2.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
 When inventory is updated with
 [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2.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.v2.ProductService.CreateProduct]
 or
 [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
 request.
 If no inventory fields are set in
 [CreateProductRequest.product][google.cloud.retail.v2.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.v2.SetInventoryRequest.set_mask],
 then any existing inventory information is preserved.
 Pre-existing inventory information can only be updated with
 [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
 [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
 and
 [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.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 void addFulfillmentPlaces​(AddFulfillmentPlacesRequest request,
                                 io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         It is recommended to use the
 [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories]
 method instead of
 [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces].
 [ProductService.AddLocalInventories][google.cloud.retail.v2.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.v2.FulfillmentInfo.place_ids].
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2.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.v2.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2.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 void removeFulfillmentPlaces​(RemoveFulfillmentPlacesRequest request,
                                    io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         It is recommended to use the
 [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories]
 method instead of
 [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
 [ProductService.RemoveLocalInventories][google.cloud.retail.v2.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.v2.FulfillmentInfo.place_ids].
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2.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.v2.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2.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 void addLocalInventories​(AddLocalInventoriesRequest request,
                                io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Updates local inventory information for a
 [Product][google.cloud.retail.v2.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.v2.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.v2.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
 Local inventory information can only be modified using this method.
 [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2.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 void removeLocalInventories​(RemoveLocalInventoriesRequest request,
                                   io.grpc.stub.StreamObserver<com.google.longrunning.Operation> responseObserver)
         Remove local inventory information for a
 [Product][google.cloud.retail.v2.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.v2.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
 Local inventory information can only be removed using this method.
 [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2.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.