com.google.cloud.retail.v2beta

Class ProductServiceGrpc.ProductServiceBlockingStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractBlockingStub<ProductServiceGrpc.ProductServiceBlockingStub>

com.google.cloud.retail.v2beta.ProductServiceGrpc.ProductServiceBlockingStub

Enclosing class:

ProductServiceGrpc

public static final class ProductServiceGrpc.ProductServiceBlockingStub
extends io.grpc.stub.AbstractBlockingStub<ProductServiceGrpc.ProductServiceBlockingStub>

 Service for ingesting [Product][google.cloud.retail.v2beta.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

Modifier and Type	Method and Description
com.google.longrunning.Operation	addFulfillmentPlaces(AddFulfillmentPlacesRequest request) Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
com.google.longrunning.Operation	addLocalInventories(AddLocalInventoriesRequest request) Updates local inventory information for a [Product][google.cloud.retail.v2beta.Product] at a list of places, while respecting the last update timestamps of each inventory field.
protected ProductServiceGrpc.ProductServiceBlockingStub	build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
Product	createProduct(CreateProductRequest request) Creates a [Product][google.cloud.retail.v2beta.Product].
com.google.protobuf.Empty	deleteProduct(DeleteProductRequest request) Deletes a [Product][google.cloud.retail.v2beta.Product].
Product	getProduct(GetProductRequest request) Gets a [Product][google.cloud.retail.v2beta.Product].
com.google.longrunning.Operation	importProducts(ImportProductsRequest request) Bulk import of multiple [Product][google.cloud.retail.v2beta.Product]s.
ListProductsResponse	listProducts(ListProductsRequest request) Gets a list of [Product][google.cloud.retail.v2beta.Product]s.
com.google.longrunning.Operation	removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request) Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
com.google.longrunning.Operation	removeLocalInventories(RemoveLocalInventoriesRequest request) Remove local inventory information for a [Product][google.cloud.retail.v2beta.Product] at a list of places at a removal timestamp.
com.google.longrunning.Operation	setInventory(SetInventoryRequest request) Updates inventory information for a [Product][google.cloud.retail.v2beta.Product] while respecting the last update timestamps of each inventory field.
Product	updateProduct(UpdateProductRequest request) Updates a [Product][google.cloud.retail.v2beta.Product].

Methods inherited from class io.grpc.stub.AbstractBlockingStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected ProductServiceGrpc.ProductServiceBlockingStub build(io.grpc.Channel channel,
                                                              io.grpc.CallOptions callOptions)

Specified by:

build in class io.grpc.stub.AbstractStub<ProductServiceGrpc.ProductServiceBlockingStub>

createProduct

public Product createProduct(CreateProductRequest request)

 Creates a [Product][google.cloud.retail.v2beta.Product].
 

getProduct

public Product getProduct(GetProductRequest request)

 Gets a [Product][google.cloud.retail.v2beta.Product].
 

listProducts

public ListProductsResponse listProducts(ListProductsRequest request)

 Gets a list of [Product][google.cloud.retail.v2beta.Product]s.
 

updateProduct

public Product updateProduct(UpdateProductRequest request)

 Updates a [Product][google.cloud.retail.v2beta.Product].
 

deleteProduct

public com.google.protobuf.Empty deleteProduct(DeleteProductRequest request)

 Deletes a [Product][google.cloud.retail.v2beta.Product].
 

importProducts

public com.google.longrunning.Operation importProducts(ImportProductsRequest request)

 Bulk import of multiple [Product][google.cloud.retail.v2beta.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.v2beta.Product]s to be successfully updated.
 

setInventory

public com.google.longrunning.Operation setInventory(SetInventoryRequest request)

 Updates inventory information for a
 [Product][google.cloud.retail.v2beta.Product] while respecting the last
 update timestamps of each inventory field.
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2beta.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.v2beta.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
 When inventory is updated with
 [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2beta.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.v2beta.ProductService.CreateProduct]
 or
 [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct]
 request.
 If no inventory fields are set in
 [CreateProductRequest.product][google.cloud.retail.v2beta.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.v2beta.SetInventoryRequest.set_mask],
 then any existing inventory information is preserved.
 Pre-existing inventory information can only be updated with
 [ProductService.SetInventory][google.cloud.retail.v2beta.ProductService.SetInventory],
 [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces],
 and
 [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.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.
 This feature is only available for users who have Retail Search enabled.
 Enable Retail Search on Cloud Console before using this feature.
 

addFulfillmentPlaces

public com.google.longrunning.Operation addFulfillmentPlaces(AddFulfillmentPlacesRequest request)

 Incrementally adds place IDs to
 [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2beta.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.v2beta.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2beta.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.
 This feature is only available for users who have Retail Search enabled.
 Enable Retail Search on Cloud Console before using this feature.
 

removeFulfillmentPlaces

public com.google.longrunning.Operation removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request)

 Incrementally removes place IDs from a
 [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
 This process is asynchronous and does not require the
 [Product][google.cloud.retail.v2beta.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.v2beta.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2beta.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.
 This feature is only available for users who have Retail Search enabled.
 Enable Retail Search on Cloud Console before using this feature.
 

addLocalInventories

public com.google.longrunning.Operation addLocalInventories(AddLocalInventoriesRequest request)

 Updates local inventory information for a
 [Product][google.cloud.retail.v2beta.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.v2beta.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.v2beta.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
 Local inventory information can only be modified using this method.
 [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2beta.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.
 This feature is only available for users who have Retail Search enabled.
 Enable Retail Search on Cloud Console before using this feature.
 

removeLocalInventories

public com.google.longrunning.Operation removeLocalInventories(RemoveLocalInventoriesRequest request)

 Remove local inventory information for a
 [Product][google.cloud.retail.v2beta.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.v2beta.Product] queried by
 [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct]
 or
 [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
 Local inventory information can only be removed using this method.
 [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct]
 and
 [ProductService.UpdateProduct][google.cloud.retail.v2beta.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.
 This feature is only available for users who have Retail Search enabled.
 Enable Retail Search on Cloud Console before using this feature.