Class ProductSearchGrpc.ProductSearchBlockingStub (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class ProductSearchGrpc.ProductSearchBlockingStub extends AbstractBlockingStub<ProductSearchGrpc.ProductSearchBlockingStub>

Manages Products and ProductSets of reference images for use in product search. It uses the following resource model:

  • The API has a collection of ProductSet resources, named projects/*/locations/*/productSets/*, which acts as a way to put different products into groups to limit identification. In parallel,
  • The API has a collection of Product resources, named projects/*/locations/*/products/*
  • Each Product has a collection of ReferenceImage resources, named projects/*/locations/*/products/*/referenceImages/*

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > ProductSearchGrpc.ProductSearchBlockingStub

Methods

addProductToProductSet(AddProductToProductSetRequest request)

public Empty addProductToProductSet(AddProductToProductSetRequest request)

Adds a Product to the specified ProductSet. If the Product is already present, no change is made. One Product can be added to at most 100 ProductSets. Possible errors:

  • Returns NOT_FOUND if the Product or the ProductSet doesn't exist.
Parameter
NameDescription
requestAddProductToProductSetRequest
Returns
TypeDescription
Empty

build(Channel channel, CallOptions callOptions)

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

createProduct(CreateProductRequest request)

public Product createProduct(CreateProductRequest request)

Creates and returns a new product resource. Possible errors:

  • Returns INVALID_ARGUMENT if display_name is missing or longer than 4096 characters.
  • Returns INVALID_ARGUMENT if description is longer than 4096 characters.
  • Returns INVALID_ARGUMENT if product_category is missing or invalid.
Parameter
NameDescription
requestCreateProductRequest
Returns
TypeDescription
Product

createProductSet(CreateProductSetRequest request)

public ProductSet createProductSet(CreateProductSetRequest request)

Creates and returns a new ProductSet resource. Possible errors:

  • Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.
Parameter
NameDescription
requestCreateProductSetRequest
Returns
TypeDescription
ProductSet

createReferenceImage(CreateReferenceImageRequest request)

public ReferenceImage createReferenceImage(CreateReferenceImageRequest request)

Creates and returns a new ReferenceImage resource. The bounding_poly field is optional. If bounding_poly is not specified, the system will try to detect regions of interest in the image that are compatible with the product_category on the parent product. If it is specified, detection is ALWAYS skipped. The system converts polygons into non-rotated rectangles. Note that the pipeline will resize the image if the image resolution is too large to process (above 50MP). Possible errors:

  • Returns INVALID_ARGUMENT if the image_uri is missing or longer than 4096 characters.
  • Returns INVALID_ARGUMENT if the product does not exist.
  • Returns INVALID_ARGUMENT if bounding_poly is not provided, and nothing compatible with the parent product's product_category is detected.
  • Returns INVALID_ARGUMENT if bounding_poly contains more than 10 polygons.
Parameter
NameDescription
requestCreateReferenceImageRequest
Returns
TypeDescription
ReferenceImage

deleteProduct(DeleteProductRequest request)

public Empty deleteProduct(DeleteProductRequest request)

Permanently delete