Class ProductServiceGrpc.ProductServiceStub (2.25.0)

public static final class ProductServiceGrpc.ProductServiceStub extends AbstractAsyncStub<ProductServiceGrpc.ProductServiceStub>

A stub to allow clients to do asynchronous rpc calls to service ProductService.

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractAsyncStub > ProductServiceGrpc.ProductServiceStub

Inherited Members

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractAsyncStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withWaitForReady()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addFulfillmentPlaces(AddFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)

public 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
Name	Description
`request`	`AddFulfillmentPlacesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

addLocalInventories(AddLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)

public 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
Name	Description
`request`	`AddLocalInventoriesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

build(Channel channel, CallOptions callOptions)

protected ProductServiceGrpc.ProductServiceStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`ProductServiceGrpc.ProductServiceStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createProduct(CreateProductRequest request, StreamObserver<Product> responseObserver)

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

Creates a Product.

Parameters
Name	Description
`request`	`CreateProductRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Product>`

deleteProduct(DeleteProductRequest request, StreamObserver<Empty> responseObserver)

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

Deletes a Product.

Parameters
Name	Description
`request`	`DeleteProductRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Empty>`

getProduct(GetProductRequest request, StreamObserver<Product> responseObserver)

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

Gets a Product.

Parameters
Name	Description
`request`	`GetProductRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Product>`

importProducts(ImportProductsRequest request, StreamObserver<Operation> responseObserver)

public 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
Name	Description
`request`	`ImportProductsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

listProducts(ListProductsRequest request, StreamObserver<ListProductsResponse> responseObserver)

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

Gets a list of Products.

Parameters
Name	Description
`request`	`ListProductsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<ListProductsResponse>`

purgeProducts(PurgeProductsRequest request, StreamObserver<Operation> responseObserver)

public void purgeProducts(PurgeProductsRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters
Name	Description
`request`	`PurgeProductsRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request, StreamObserver<Operation> responseObserver)

public 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
Name	Description
`request`	`RemoveFulfillmentPlacesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

removeLocalInventories(RemoveLocalInventoriesRequest request, StreamObserver<Operation> responseObserver)

public 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
Name	Description
`request`	`RemoveLocalInventoriesRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

setInventory(SetInventoryRequest request, StreamObserver<Operation> responseObserver)

public 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
Name	Description
`request`	`SetInventoryRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Operation>`

updateProduct(UpdateProductRequest request, StreamObserver<Product> responseObserver)

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

Updates a Product.

Parameters
Name	Description
`request`	`UpdateProductRequest`
`responseObserver`	`io.grpc.stub.StreamObserver<Product>`