Class ProductServiceGrpc.ProductServiceFutureStub (2.3.0)

public static final class ProductServiceGrpc.ProductServiceFutureStub extends AbstractFutureStub<ProductServiceGrpc.ProductServiceFutureStub>

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

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > ProductServiceGrpc.ProductServiceFutureStub

Inherited Members

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

io.grpc.stub.AbstractFutureStub.<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)

public ListenableFuture<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 GetProduct or ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameter

Name	Description
request	`AddFulfillmentPlacesRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

addLocalInventories(AddLocalInventoriesRequest request)

public ListenableFuture<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 GetProduct or ListProducts. Local inventory information can only be modified using this method. CreateProduct and UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameter

Name	Description
request	`AddLocalInventoriesRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

build(Channel channel, CallOptions callOptions)

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

Parameters

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

Returns

Type	Description
ProductServiceGrpc.ProductServiceFutureStub

Overrides

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

createProduct(CreateProductRequest request)

public ListenableFuture<Product> createProduct(CreateProductRequest request)

Creates a Product.

Parameter

Name	Description
request	`CreateProductRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Product>

deleteProduct(DeleteProductRequest request)

public ListenableFuture<Empty> deleteProduct(DeleteProductRequest request)

Deletes a Product.

Parameter

Name	Description
request	`DeleteProductRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Empty>

getProduct(GetProductRequest request)

public ListenableFuture<Product> getProduct(GetProductRequest request)

Gets a Product.

Parameter

Name	Description
request	`GetProductRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Product>

importProducts(ImportProductsRequest request)

public ListenableFuture<Operation> importProducts(ImportProductsRequest request)

Bulk import of multiple Products. Request processing may be synchronous. No partial updating is supported. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated.

Parameter

Name	Description
request	`ImportProductsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listProducts(ListProductsRequest request)

public ListenableFuture<ListProductsResponse> listProducts(ListProductsRequest request)

Gets a list of Products.

Parameter

Name	Description
request	`ListProductsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<ListProductsResponse>

purgeProducts(PurgeProductsRequest request)

public ListenableFuture<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 GetProduct or 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

Name	Description
request	`PurgeProductsRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

removeFulfillmentPlaces(RemoveFulfillmentPlacesRequest request)

public ListenableFuture<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 GetProduct or ListProducts. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameter

Name	Description
request	`RemoveFulfillmentPlacesRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

removeLocalInventories(RemoveLocalInventoriesRequest request)

public ListenableFuture<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 GetProduct or ListProducts. Local inventory information can only be removed using this method. CreateProduct and UpdateProduct has no effect on local inventories. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameter

Name	Description
request	`RemoveLocalInventoriesRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

setInventory(SetInventoryRequest request)

public ListenableFuture<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 will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the Product queried by GetProduct or ListProducts. When inventory is updated with CreateProduct and UpdateProduct, the specified inventory field value(s) will overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update time for the specified inventory fields will be overwritten to the time of the CreateProduct or UpdateProduct request. If no inventory fields are set in CreateProductRequest.product, then any pre-existing inventory information for this product will be used. If no inventory fields are set in SetInventoryRequest.set_mask, then any existing inventory information will be preserved. Pre-existing inventory information can only be updated with SetInventory, AddFulfillmentPlaces, and RemoveFulfillmentPlaces. This feature is only available for users who have Retail Search enabled. Please enable Retail Search on Cloud Console before using this feature.

Parameter

Name	Description
request	`SetInventoryRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateProduct(UpdateProductRequest request)

public ListenableFuture<Product> updateProduct(UpdateProductRequest request)

Updates a Product.

Parameter

Name	Description
request	`UpdateProductRequest`

Returns

Type	Description
com.google.common.util.concurrent.ListenableFuture<Product>