public sealed class ProductSearchClientImpl : ProductSearchClientProductSearch client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Vision.V1Assembly
Google.Cloud.Vision.V1.dll
Remarks
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][google.cloud.vision.v1.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][google.cloud.vision.v1.Product] resources, named
projects/*/locations/*/products/*Each [Product][google.cloud.vision.v1.Product] has a collection of [ReferenceImage][google.cloud.vision.v1.ReferenceImage] resources, named
projects/*/locations/*/products/*/referenceImages/*
Constructors
ProductSearchClientImpl(ProductSearch.ProductSearchClient, ProductSearchSettings, ILogger)
public ProductSearchClientImpl(ProductSearch.ProductSearchClient grpcClient, ProductSearchSettings settings, ILogger logger)Constructs a client wrapper for the ProductSearch service, with the specified gRPC client and settings.
| Parameters | |
|---|---|
| Name | Description |
grpcClient | ProductSearch.ProductSearchClientThe underlying gRPC client. |
settings | ProductSearchSettingsThe base ProductSearchSettings used within this client. |
logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override ProductSearch.ProductSearchClient GrpcClient { get; }The underlying gRPC ProductSearch client
| Property Value | |
|---|---|
| Type | Description |
ProductSearch.ProductSearchClient | |
ImportProductSetsOperationsClient
public override OperationsClient ImportProductSetsOperationsClient { get; }The long-running operations client for ImportProductSets.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
PurgeProductsOperationsClient
public override OperationsClient PurgeProductsOperationsClient { get; }The long-running operations client for PurgeProducts.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
Methods
AddProductToProductSet(AddProductToProductSetRequest, CallSettings)
public override void AddProductToProductSet(AddProductToProductSetRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | AddProductToProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
AddProductToProductSetAsync(AddProductToProductSetRequest, CallSettings)
public override Task AddProductToProductSetAsync(AddProductToProductSetRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | AddProductToProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
CreateProduct(CreateProductRequest, CallSettings)
public override Product CreateProduct(CreateProductRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | CreateProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Product | The RPC response. |
CreateProductAsync(CreateProductRequest, CallSettings)
public override Task<Product> CreateProductAsync(CreateProductRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | CreateProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Product> | A Task containing the RPC response. |
CreateProductSet(CreateProductSetRequest, CallSettings)
public override ProductSet CreateProductSet(CreateProductSetRequest request, CallSettings callSettings = null)Creates and returns a new ProductSet resource.
Possible errors:
- Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.
| Parameters | |
|---|---|
| Name | Description |
request | CreateProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ProductSet | The RPC response. |
CreateProductSetAsync(CreateProductSetRequest, CallSettings)
public override Task<ProductSet> CreateProductSetAsync(CreateProductSetRequest request, CallSettings callSettings = null)Creates and returns a new ProductSet resource.
Possible errors:
- Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.
| Parameters | |
|---|---|
| Name | Description |
request | CreateProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ProductSet> | A Task containing the RPC response. |
CreateReferenceImage(CreateReferenceImageRequest, CallSettings)
public override ReferenceImage CreateReferenceImage(CreateReferenceImageRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | CreateReferenceImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ReferenceImage | The RPC response. |
CreateReferenceImageAsync(CreateReferenceImageRequest, CallSettings)
public override Task<ReferenceImage> CreateReferenceImageAsync(CreateReferenceImageRequest request, CallSettings callSettings = null)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.
| Parameters | |
|---|---|
| Name | Description |
request | CreateReferenceImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ReferenceImage> | A Task containing the RPC response. |
DeleteProduct(DeleteProductRequest, CallSettings)
public override void DeleteProduct(DeleteProductRequest request, CallSettings callSettings = null)Permanently deletes a product and its reference images.
Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteProductAsync(DeleteProductRequest, CallSettings)
public override Task DeleteProductAsync(DeleteProductRequest request, CallSettings callSettings = null)Permanently deletes a product and its reference images.
Metadata of the product and all its images will be deleted right away, but search queries against ProductSets containing the product may still work until all related caches are refreshed.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteProductSet(DeleteProductSetRequest, CallSettings)
public override void DeleteProductSet(DeleteProductSetRequest request, CallSettings callSettings = null)Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud Storage.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteProductSetAsync(DeleteProductSetRequest, CallSettings)
public override Task DeleteProductSetAsync(DeleteProductSetRequest request, CallSettings callSettings = null)Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud Storage.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
DeleteReferenceImage(DeleteReferenceImageRequest, CallSettings)
public override void DeleteReferenceImage(DeleteReferenceImageRequest request, CallSettings callSettings = null)Permanently deletes a reference image.
The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.
The actual image files are not deleted from Google Cloud Storage.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteReferenceImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteReferenceImageAsync(DeleteReferenceImageRequest, CallSettings)
public override Task DeleteReferenceImageAsync(DeleteReferenceImageRequest request, CallSettings callSettings = null)Permanently deletes a reference image.
The image metadata will be deleted right away, but search queries against ProductSets containing the image may still work until all related caches are refreshed.
The actual image files are not deleted from Google Cloud Storage.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteReferenceImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
GetProduct(GetProductRequest, CallSettings)
public override Product GetProduct(GetProductRequest request, CallSettings callSettings = null)Gets information associated with a Product.
Possible errors:
- Returns NOT_FOUND if the Product does not exist.
| Parameters | |
|---|---|
| Name | Description |
request | GetProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Product | The RPC response. |
GetProductAsync(GetProductRequest, CallSettings)
public override Task<Product> GetProductAsync(GetProductRequest request, CallSettings callSettings = null)Gets information associated with a Product.
Possible errors:
- Returns NOT_FOUND if the Product does not exist.
| Parameters | |
|---|---|
| Name | Description |
request | GetProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Product> | A Task containing the RPC response. |
GetProductSet(GetProductSetRequest, CallSettings)
public override ProductSet GetProductSet(GetProductSetRequest request, CallSettings callSettings = null)Gets information associated with a ProductSet.
Possible errors:
- Returns NOT_FOUND if the ProductSet does not exist.
| Parameters | |
|---|---|
| Name | Description |
request | GetProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ProductSet | The RPC response. |
GetProductSetAsync(GetProductSetRequest, CallSettings)
public override Task<ProductSet> GetProductSetAsync(GetProductSetRequest request, CallSettings callSettings = null)Gets information associated with a ProductSet.
Possible errors:
- Returns NOT_FOUND if the ProductSet does not exist.
| Parameters | |
|---|---|
| Name | Description |
request | GetProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ProductSet> | A Task containing the RPC response. |
GetReferenceImage(GetReferenceImageRequest, CallSettings)
public override ReferenceImage GetReferenceImage(GetReferenceImageRequest request, CallSettings callSettings = null)Gets information associated with a ReferenceImage.
Possible errors:
- Returns NOT_FOUND if the specified image does not exist.
| Parameters | |
|---|---|
| Name | Description |
request | GetReferenceImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ReferenceImage | The RPC response. |
GetReferenceImageAsync(GetReferenceImageRequest, CallSettings)
public override Task<ReferenceImage> GetReferenceImageAsync(GetReferenceImageRequest request, CallSettings callSettings = null)Gets information associated with a ReferenceImage.
Possible errors:
- Returns NOT_FOUND if the specified image does not exist.
| Parameters | |
|---|---|
| Name | Description |
request | GetReferenceImageRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ReferenceImage> | A Task containing the RPC response. |
ImportProductSets(ImportProductSetsRequest, CallSettings)
public override Operation<ImportProductSetsResponse, BatchOperationMetadata> ImportProductSets(ImportProductSetsRequest request, CallSettings callSettings = null)Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
progress and results of the request.
Operation.metadata contains BatchOperationMetadata. (progress)
Operation.response contains ImportProductSetsResponse. (results)
The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri].
| Parameters | |
|---|---|
| Name | Description |
request | ImportProductSetsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<ImportProductSetsResponse, BatchOperationMetadata> | The RPC response. |
ImportProductSetsAsync(ImportProductSetsRequest, CallSettings)
public override async Task<Operation<ImportProductSetsResponse, BatchOperationMetadata>> ImportProductSetsAsync(ImportProductSetsRequest request, CallSettings callSettings = null)Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
progress and results of the request.
Operation.metadata contains BatchOperationMetadata. (progress)
Operation.response contains ImportProductSetsResponse. (results)
The input source of this method is a csv file on Google Cloud Storage. For the format of the csv file please see [ImportProductSetsGcsSource.csv_file_uri][google.cloud.vision.v1.ImportProductSetsGcsSource.csv_file_uri].
| Parameters | |
|---|---|
| Name | Description |
request | ImportProductSetsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<ImportProductSetsResponse, BatchOperationMetadata>> | A Task containing the RPC response. |
ListProducts(ListProductsRequest, CallSettings)
public override PagedEnumerable<ListProductsResponse, Product> ListProducts(ListProductsRequest request, CallSettings callSettings = null)Lists products in an unspecified order.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListProductsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListProductsResponse, Product> | A pageable sequence of Product resources. |
ListProductsAsync(ListProductsRequest, CallSettings)
public override PagedAsyncEnumerable<ListProductsResponse, Product> ListProductsAsync(ListProductsRequest request, CallSettings callSettings = null)Lists products in an unspecified order.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListProductsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListProductsResponse, Product> | A pageable asynchronous sequence of Product resources. |
ListProductSets(ListProductSetsRequest, CallSettings)
public override PagedEnumerable<ListProductSetsResponse, ProductSet> ListProductSets(ListProductSetsRequest request, CallSettings callSettings = null)Lists ProductSets in an unspecified order.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListProductSetsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListProductSetsResponse, ProductSet> | A pageable sequence of ProductSet resources. |
ListProductSetsAsync(ListProductSetsRequest, CallSettings)
public override PagedAsyncEnumerable<ListProductSetsResponse, ProductSet> ListProductSetsAsync(ListProductSetsRequest request, CallSettings callSettings = null)Lists ProductSets in an unspecified order.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListProductSetsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListProductSetsResponse, ProductSet> | A pageable asynchronous sequence of ProductSet resources. |
ListProductsInProductSet(ListProductsInProductSetRequest, CallSettings)
public override PagedEnumerable<ListProductsInProductSetResponse, Product> ListProductsInProductSet(ListProductsInProductSetRequest request, CallSettings callSettings = null)Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListProductsInProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListProductsInProductSetResponse, Product> | A pageable sequence of Product resources. |
ListProductsInProductSetAsync(ListProductsInProductSetRequest, CallSettings)
public override PagedAsyncEnumerable<ListProductsInProductSetResponse, Product> ListProductsInProductSetAsync(ListProductsInProductSetRequest request, CallSettings callSettings = null)Lists the Products in a ProductSet, in an unspecified order. If the ProductSet does not exist, the products field of the response will be empty.
Possible errors:
- Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListProductsInProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListProductsInProductSetResponse, Product> | A pageable asynchronous sequence of Product resources. |
ListReferenceImages(ListReferenceImagesRequest, CallSettings)
public override PagedEnumerable<ListReferenceImagesResponse, ReferenceImage> ListReferenceImages(ListReferenceImagesRequest request, CallSettings callSettings = null)Lists reference images.
Possible errors:
- Returns NOT_FOUND if the parent product does not exist.
- Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListReferenceImagesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListReferenceImagesResponse, ReferenceImage> | A pageable sequence of ReferenceImage resources. |
ListReferenceImagesAsync(ListReferenceImagesRequest, CallSettings)
public override PagedAsyncEnumerable<ListReferenceImagesResponse, ReferenceImage> ListReferenceImagesAsync(ListReferenceImagesRequest request, CallSettings callSettings = null)Lists reference images.
Possible errors:
- Returns NOT_FOUND if the parent product does not exist.
- Returns INVALID_ARGUMENT if the page_size is greater than 100, or less than 1.
| Parameters | |
|---|---|
| Name | Description |
request | ListReferenceImagesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListReferenceImagesResponse, ReferenceImage> | A pageable asynchronous sequence of ReferenceImage resources. |
PurgeProducts(PurgeProductsRequest, CallSettings)
public override Operation<Empty, BatchOperationMetadata> PurgeProducts(PurgeProductsRequest request, CallSettings callSettings = null)Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted.
It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted.
It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion.
If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet.
The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
progress and results of the request.
Operation.metadata contains BatchOperationMetadata. (progress)
| Parameters | |
|---|---|
| Name | Description |
request | PurgeProductsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, BatchOperationMetadata> | The RPC response. |
PurgeProductsAsync(PurgeProductsRequest, CallSettings)
public override async Task<Operation<Empty, BatchOperationMetadata>> PurgeProductsAsync(PurgeProductsRequest request, CallSettings callSettings = null)Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
If a Product is a member of the specified ProductSet in addition to other ProductSets, the Product will still be deleted.
It is recommended to not delete the specified ProductSet until after this operation has completed. It is also recommended to not add any of the Products involved in the batch delete to a new ProductSet while this operation is running because those Products may still end up deleted.
It's not possible to undo the PurgeProducts operation. Therefore, it is recommended to keep the csv files used in ImportProductSets (if that was how you originally built the Product Set) before starting PurgeProducts, in case you need to re-import the data after deletion.
If the plan is to purge all of the Products from a ProductSet and then re-use the empty ProductSet to re-import new Products into the empty ProductSet, you must wait until the PurgeProducts operation has finished for that ProductSet.
The [google.longrunning.Operation][google.longrunning.Operation] API can be used to keep track of the
progress and results of the request.
Operation.metadata contains BatchOperationMetadata. (progress)
| Parameters | |
|---|---|
| Name | Description |
request | PurgeProductsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, BatchOperationMetadata>> | A Task containing the RPC response. |
RemoveProductFromProductSet(RemoveProductFromProductSetRequest, CallSettings)
public override void RemoveProductFromProductSet(RemoveProductFromProductSetRequest request, CallSettings callSettings = null)Removes a Product from the specified ProductSet.
| Parameters | |
|---|---|
| Name | Description |
request | RemoveProductFromProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
RemoveProductFromProductSetAsync(RemoveProductFromProductSetRequest, CallSettings)
public override Task RemoveProductFromProductSetAsync(RemoveProductFromProductSetRequest request, CallSettings callSettings = null)Removes a Product from the specified ProductSet.
| Parameters | |
|---|---|
| Name | Description |
request | RemoveProductFromProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
UpdateProduct(UpdateProductRequest, CallSettings)
public override Product UpdateProduct(UpdateProductRequest request, CallSettings callSettings = null)Makes changes to a Product resource.
Only the display_name, description, and labels fields can be updated
right now.
If labels are updated, the change will not be reflected in queries until the next index time.
Possible errors:
- Returns NOT_FOUND if the Product does not exist.
- Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters.
- Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters.
- Returns INVALID_ARGUMENT if product_category is present in update_mask.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Product | The RPC response. |
UpdateProductAsync(UpdateProductRequest, CallSettings)
public override Task<Product> UpdateProductAsync(UpdateProductRequest request, CallSettings callSettings = null)Makes changes to a Product resource.
Only the display_name, description, and labels fields can be updated
right now.
If labels are updated, the change will not be reflected in queries until the next index time.
Possible errors:
- Returns NOT_FOUND if the Product does not exist.
- Returns INVALID_ARGUMENT if display_name is present in update_mask but is missing from the request or longer than 4096 characters.
- Returns INVALID_ARGUMENT if description is present in update_mask but is longer than 4096 characters.
- Returns INVALID_ARGUMENT if product_category is present in update_mask.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateProductRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Product> | A Task containing the RPC response. |
UpdateProductSet(UpdateProductSetRequest, CallSettings)
public override ProductSet UpdateProductSet(UpdateProductSetRequest request, CallSettings callSettings = null)Makes changes to a ProductSet resource. Only display_name can be updated currently.
Possible errors:
- Returns NOT_FOUND if the ProductSet does not exist.
- Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ProductSet | The RPC response. |
UpdateProductSetAsync(UpdateProductSetRequest, CallSettings)
public override Task<ProductSet> UpdateProductSetAsync(UpdateProductSetRequest request, CallSettings callSettings = null)Makes changes to a ProductSet resource. Only display_name can be updated currently.
Possible errors:
- Returns NOT_FOUND if the ProductSet does not exist.
- Returns INVALID_ARGUMENT if display_name is present in update_mask but missing from the request or longer than 4096 characters.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateProductSetRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ProductSet> | A Task containing the RPC response. |