Class ProductServiceGrpc.ProductServiceBlockingStub (2.14.0)

public static final class ProductServiceGrpc.ProductServiceBlockingStub extends AbstractBlockingStub<ProductServiceGrpc.ProductServiceBlockingStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ProductServiceGrpc.ProductServiceBlockingStub

Methods

addFulfillmentPlaces(AddFulfillmentPlacesRequest request)

public Operation addFulfillmentPlaces(AddFulfillmentPlacesRequest request)

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. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameter
NameDescription
requestAddFulfillmentPlacesRequest
Returns
TypeDescription
Operation

addLocalInventories(AddLocalInventoriesRequest request)

public Operation addLocalInventories(AddLocalInventoriesRequest request)

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. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameter
NameDescription
requestAddLocalInventoriesRequest
Returns
TypeDescription
Operation

build(Channel channel, CallOptions callOptions)

protected ProductServiceGrpc.ProductServiceBlockingStub build(Channel channel, CallOptions callOptions)
Parameters
NameDescription
channelio.grpc.Channel
callOptionsio.grpc.CallOptions
Returns
TypeDescription
ProductServiceGrpc.ProductServiceBlockingStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createProduct(CreateProductRequest request)

public Product createProduct(CreateProductRequest request)

Creates a Product.

Parameter
NameDescription
requestCreateProductRequest
Returns
TypeDescription
Product

deleteProduct(DeleteProductRequest request)

public Empty deleteProduct(DeleteProductRequest request)

Deletes a Product.

Parameter
NameDescription
requestDeleteProductRequest
Returns
TypeDescription
Empty

getProduct(GetProductRequest request)

public Product getProduct(GetProductRequest request)

Gets a Product.

Parameter
NameDescription
requestGetProductRequest
Returns
TypeDescription
Product

importProducts(ImportProductsRequest request)

public Operation importProducts(ImportProductsRequest request)

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.

Parameter
NameDescription
requestImportProductsRequest
Returns
TypeDescription
Operation

listProducts(ListProductsRequest request)

public ListProductsResponse listProducts(ListProductsRequest request)

Gets a list of Products.

Parameter
NameDescription
requestListProductsRequest
Returns
TypeDescription
ListProductsResponse

purgeProducts(PurgeProductsRequest request)

public Operation purgeProducts(PurgeProductsRequest request)

Permanently deletes all selected Products 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 Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false.

Parameter
NameDescription
requestPurgeProductsRequest
Returns
TypeDescription
Operation

removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request)

public Operation removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request)

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. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameter
NameDescription
requestRemoveFulfillmentPlacesRequest
Returns
TypeDescription
Operation

removeLocalInventories(RemoveLocalInventoriesRequest request)

public Operation removeLocalInventories(RemoveLocalInventoriesRequest request)

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. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameter
NameDescription
requestRemoveLocalInventoriesRequest
Returns
TypeDescription
Operation

setInventory(SetInventoryRequest request)

public Operation setInventory(SetInventoryRequest request)

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. This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature.

Parameter
NameDescription
requestSetInventoryRequest
Returns
TypeDescription
Operation

updateProduct(UpdateProductRequest request)

public Product updateProduct(UpdateProductRequest request)

Updates a Product.

Parameter
NameDescription
requestUpdateProductRequest
Returns
TypeDescription
Product