ProductSearchClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.vision.v1.ProductSearchClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
public class ProductSearchClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: 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/*`
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   String productSetId = "";
   ProductSet response = productSearchClient.createProductSet(parent, productSet, productSetId);
 }
 
 
```
Note: close() needs to be called on the productSearchClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of ProductSearchSettings to create(). For example:
To customize credentials:
```
 
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ProductSearchClient productSearchClient =
     ProductSearchClient.create(productSearchSettings);
 
 
```
To customize the endpoint:
```
 
 ProductSearchSettings productSearchSettings =
     ProductSearchSettings.newBuilder().setEndpoint(myEndpoint).build();
 ProductSearchClient productSearchClient =
     ProductSearchClient.create(productSearchSettings);
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ProductSearchClient.ListProductSetsFixedSizeCollection`
`static class`	`ProductSearchClient.ListProductSetsPage`
`static class`	`ProductSearchClient.ListProductSetsPagedResponse`
`static class`	`ProductSearchClient.ListProductsFixedSizeCollection`
`static class`	`ProductSearchClient.ListProductsInProductSetFixedSizeCollection`
`static class`	`ProductSearchClient.ListProductsInProductSetPage`
`static class`	`ProductSearchClient.ListProductsInProductSetPagedResponse`
`static class`	`ProductSearchClient.ListProductsPage`
`static class`	`ProductSearchClient.ListProductsPagedResponse`
`static class`	`ProductSearchClient.ListReferenceImagesFixedSizeCollection`
`static class`	`ProductSearchClient.ListReferenceImagesPage`
`static class`	`ProductSearchClient.ListReferenceImagesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ProductSearchClient(ProductSearchSettings settings)` Constructs an instance of ProductSearchClient, using the given settings.
`protected`	`ProductSearchClient(ProductSearchStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addProductToProductSet(AddProductToProductSetRequest request)` Adds a Product to the specified ProductSet.
`void`	`addProductToProductSet(ProductSetName name, ProductName product)` Adds a Product to the specified ProductSet.
`void`	`addProductToProductSet(String name, String product)` Adds a Product to the specified ProductSet.
`com.google.api.gax.rpc.UnaryCallable<AddProductToProductSetRequest,Empty>`	`addProductToProductSetCallable()` Adds a Product to the specified ProductSet.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ProductSearchClient`	`create()` Constructs an instance of ProductSearchClient with default settings.
`static ProductSearchClient`	`create(ProductSearchSettings settings)` Constructs an instance of ProductSearchClient, using the given settings.
`static ProductSearchClient`	`create(ProductSearchStub stub)` Constructs an instance of ProductSearchClient, using the given stub for making calls.
`Product`	`createProduct(CreateProductRequest request)` Creates and returns a new product resource.
`Product`	`createProduct(LocationName parent, Product product, String productId)` Creates and returns a new product resource.
`Product`	`createProduct(String parent, Product product, String productId)` Creates and returns a new product resource.
`com.google.api.gax.rpc.UnaryCallable<CreateProductRequest,Product>`	`createProductCallable()` Creates and returns a new product resource.
`ProductSet`	`createProductSet(CreateProductSetRequest request)` Creates and returns a new ProductSet resource.
`ProductSet`	`createProductSet(LocationName parent, ProductSet productSet, String productSetId)` Creates and returns a new ProductSet resource.
`ProductSet`	`createProductSet(String parent, ProductSet productSet, String productSetId)` Creates and returns a new ProductSet resource.
`com.google.api.gax.rpc.UnaryCallable<CreateProductSetRequest,ProductSet>`	`createProductSetCallable()` Creates and returns a new ProductSet resource.
`ReferenceImage`	`createReferenceImage(CreateReferenceImageRequest request)` Creates and returns a new ReferenceImage resource.
`ReferenceImage`	`createReferenceImage(ProductName parent, ReferenceImage referenceImage, String referenceImageId)` Creates and returns a new ReferenceImage resource.
`ReferenceImage`	`createReferenceImage(String parent, ReferenceImage referenceImage, String referenceImageId)` Creates and returns a new ReferenceImage resource.
`com.google.api.gax.rpc.UnaryCallable<CreateReferenceImageRequest,ReferenceImage>`	`createReferenceImageCallable()` Creates and returns a new ReferenceImage resource.
`void`	`deleteProduct(DeleteProductRequest request)` Permanently deletes a product and its reference images.
`void`	`deleteProduct(ProductName name)` Permanently deletes a product and its reference images.
`void`	`deleteProduct(String name)` Permanently deletes a product and its reference images.
`com.google.api.gax.rpc.UnaryCallable<DeleteProductRequest,Empty>`	`deleteProductCallable()` Permanently deletes a product and its reference images.
`void`	`deleteProductSet(DeleteProductSetRequest request)` Permanently deletes a ProductSet.
`void`	`deleteProductSet(ProductSetName name)` Permanently deletes a ProductSet.
`void`	`deleteProductSet(String name)` Permanently deletes a ProductSet.
`com.google.api.gax.rpc.UnaryCallable<DeleteProductSetRequest,Empty>`	`deleteProductSetCallable()` Permanently deletes a ProductSet.
`void`	`deleteReferenceImage(DeleteReferenceImageRequest request)` Permanently deletes a reference image.
`void`	`deleteReferenceImage(ReferenceImageName name)` Permanently deletes a reference image.
`void`	`deleteReferenceImage(String name)` Permanently deletes a reference image.
`com.google.api.gax.rpc.UnaryCallable<DeleteReferenceImageRequest,Empty>`	`deleteReferenceImageCallable()` Permanently deletes a reference image.
`static String`	`formatLocationName(String project, String location)` Deprecated. Use the `LocationName` class instead.
`static String`	`formatProductName(String project, String location, String product)` Deprecated. Use the `ProductName` class instead.
`static String`	`formatProductSetName(String project, String location, String productSet)` Deprecated. Use the `ProductSetName` class instead.
`static String`	`formatReferenceImageName(String project, String location, String product, String referenceImage)` Deprecated. Use the `ReferenceImageName` class instead.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`Product`	`getProduct(GetProductRequest request)` Gets information associated with a Product.
`Product`	`getProduct(ProductName name)` Gets information associated with a Product.
`Product`	`getProduct(String name)` Gets information associated with a Product.
`com.google.api.gax.rpc.UnaryCallable<GetProductRequest,Product>`	`getProductCallable()` Gets information associated with a Product.
`ProductSet`	`getProductSet(GetProductSetRequest request)` Gets information associated with a ProductSet.
`ProductSet`	`getProductSet(ProductSetName name)` Gets information associated with a ProductSet.
`ProductSet`	`getProductSet(String name)` Gets information associated with a ProductSet.
`com.google.api.gax.rpc.UnaryCallable<GetProductSetRequest,ProductSet>`	`getProductSetCallable()` Gets information associated with a ProductSet.
`ReferenceImage`	`getReferenceImage(GetReferenceImageRequest request)` Gets information associated with a ReferenceImage.
`ReferenceImage`	`getReferenceImage(ReferenceImageName name)` Gets information associated with a ReferenceImage.
`ReferenceImage`	`getReferenceImage(String name)` Gets information associated with a ReferenceImage.
`com.google.api.gax.rpc.UnaryCallable<GetReferenceImageRequest,ReferenceImage>`	`getReferenceImageCallable()` Gets information associated with a ReferenceImage.
`ProductSearchSettings`	`getSettings()`
`ProductSearchStub`	`getStub()`
`com.google.api.gax.longrunning.OperationFuture<ImportProductSetsResponse,BatchOperationMetadata>`	`importProductSetsAsync(ImportProductSetsRequest request)` Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
`com.google.api.gax.longrunning.OperationFuture<ImportProductSetsResponse,BatchOperationMetadata>`	`importProductSetsAsync(LocationName parent, ImportProductSetsInputConfig inputConfig)` Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
`com.google.api.gax.longrunning.OperationFuture<ImportProductSetsResponse,BatchOperationMetadata>`	`importProductSetsAsync(String parent, ImportProductSetsInputConfig inputConfig)` Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
`com.google.api.gax.rpc.UnaryCallable<ImportProductSetsRequest,com.google.longrunning.Operation>`	`importProductSetsCallable()` Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
`com.google.api.gax.rpc.OperationCallable<ImportProductSetsRequest,ImportProductSetsResponse,BatchOperationMetadata>`	`importProductSetsOperationCallable()` Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ProductSearchClient.ListProductsPagedResponse`	`listProducts(ListProductsRequest request)` Lists products in an unspecified order.
`ProductSearchClient.ListProductsPagedResponse`	`listProducts(LocationName parent)` Lists products in an unspecified order.
`ProductSearchClient.ListProductsPagedResponse`	`listProducts(String parent)` Lists products in an unspecified order.
`com.google.api.gax.rpc.UnaryCallable<ListProductsRequest,ListProductsResponse>`	`listProductsCallable()` Lists products in an unspecified order.
`ProductSearchClient.ListProductSetsPagedResponse`	`listProductSets(ListProductSetsRequest request)` Lists ProductSets in an unspecified order.
`ProductSearchClient.ListProductSetsPagedResponse`	`listProductSets(LocationName parent)` Lists ProductSets in an unspecified order.
`ProductSearchClient.ListProductSetsPagedResponse`	`listProductSets(String parent)` Lists ProductSets in an unspecified order.
`com.google.api.gax.rpc.UnaryCallable<ListProductSetsRequest,ListProductSetsResponse>`	`listProductSetsCallable()` Lists ProductSets in an unspecified order.
`com.google.api.gax.rpc.UnaryCallable<ListProductSetsRequest,ProductSearchClient.ListProductSetsPagedResponse>`	`listProductSetsPagedCallable()` Lists ProductSets in an unspecified order.
`ProductSearchClient.ListProductsInProductSetPagedResponse`	`listProductsInProductSet(ListProductsInProductSetRequest request)` Lists the Products in a ProductSet, in an unspecified order.
`ProductSearchClient.ListProductsInProductSetPagedResponse`	`listProductsInProductSet(ProductSetName name)` Lists the Products in a ProductSet, in an unspecified order.
`ProductSearchClient.ListProductsInProductSetPagedResponse`	`listProductsInProductSet(String name)` Lists the Products in a ProductSet, in an unspecified order.
`com.google.api.gax.rpc.UnaryCallable<ListProductsInProductSetRequest,ListProductsInProductSetResponse>`	`listProductsInProductSetCallable()` Lists the Products in a ProductSet, in an unspecified order.
`com.google.api.gax.rpc.UnaryCallable<ListProductsInProductSetRequest,ProductSearchClient.ListProductsInProductSetPagedResponse>`	`listProductsInProductSetPagedCallable()` Lists the Products in a ProductSet, in an unspecified order.
`com.google.api.gax.rpc.UnaryCallable<ListProductsRequest,ProductSearchClient.ListProductsPagedResponse>`	`listProductsPagedCallable()` Lists products in an unspecified order.
`ProductSearchClient.ListReferenceImagesPagedResponse`	`listReferenceImages(ListReferenceImagesRequest request)` Lists reference images.
`ProductSearchClient.ListReferenceImagesPagedResponse`	`listReferenceImages(ProductName parent)` Lists reference images.
`ProductSearchClient.ListReferenceImagesPagedResponse`	`listReferenceImages(String parent)` Lists reference images.
`com.google.api.gax.rpc.UnaryCallable<ListReferenceImagesRequest,ListReferenceImagesResponse>`	`listReferenceImagesCallable()` Lists reference images.
`com.google.api.gax.rpc.UnaryCallable<ListReferenceImagesRequest,ProductSearchClient.ListReferenceImagesPagedResponse>`	`listReferenceImagesPagedCallable()` Lists reference images.
`static String`	`parseLocationFromLocationName(String locationName)` Deprecated. Use the `LocationName` class instead.
`static String`	`parseLocationFromProductName(String productName)` Deprecated. Use the `ProductName` class instead.
`static String`	`parseLocationFromProductSetName(String productSetName)` Deprecated. Use the `ProductSetName` class instead.
`static String`	`parseLocationFromReferenceImageName(String referenceImageName)` Deprecated. Use the `ReferenceImageName` class instead.
`static String`	`parseProductFromProductName(String productName)` Deprecated. Use the `ProductName` class instead.
`static String`	`parseProductFromReferenceImageName(String referenceImageName)` Deprecated. Use the `ReferenceImageName` class instead.
`static String`	`parseProductSetFromProductSetName(String productSetName)` Deprecated. Use the `ProductSetName` class instead.
`static String`	`parseProjectFromLocationName(String locationName)` Deprecated. Use the `LocationName` class instead.
`static String`	`parseProjectFromProductName(String productName)` Deprecated. Use the `ProductName` class instead.
`static String`	`parseProjectFromProductSetName(String productSetName)` Deprecated. Use the `ProductSetName` class instead.
`static String`	`parseProjectFromReferenceImageName(String referenceImageName)` Deprecated. Use the `ReferenceImageName` class instead.
`static String`	`parseReferenceImageFromReferenceImageName(String referenceImageName)` Deprecated. Use the `ReferenceImageName` class instead.
`com.google.api.gax.longrunning.OperationFuture<Empty,BatchOperationMetadata>`	`purgeProductsAsync(LocationName parent)` Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
`com.google.api.gax.longrunning.OperationFuture<Empty,BatchOperationMetadata>`	`purgeProductsAsync(PurgeProductsRequest request)` Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
`com.google.api.gax.longrunning.OperationFuture<Empty,BatchOperationMetadata>`	`purgeProductsAsync(String parent)` Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
`com.google.api.gax.rpc.UnaryCallable<PurgeProductsRequest,com.google.longrunning.Operation>`	`purgeProductsCallable()` Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
`com.google.api.gax.rpc.OperationCallable<PurgeProductsRequest,Empty,BatchOperationMetadata>`	`purgeProductsOperationCallable()` Asynchronous API to delete all Products in a ProductSet or all Products that are in no ProductSet.
`void`	`removeProductFromProductSet(ProductSetName name, ProductName product)` Removes a Product from the specified ProductSet.
`void`	`removeProductFromProductSet(RemoveProductFromProductSetRequest request)` Removes a Product from the specified ProductSet.
`void`	`removeProductFromProductSet(String name, String product)` Removes a Product from the specified ProductSet.
`com.google.api.gax.rpc.UnaryCallable<RemoveProductFromProductSetRequest,Empty>`	`removeProductFromProductSetCallable()` Removes a Product from the specified ProductSet.
`void`	`shutdown()`
`void`	`shutdownNow()`
`Product`	`updateProduct(Product product, FieldMask updateMask)` Makes changes to a Product resource.
`Product`	`updateProduct(UpdateProductRequest request)` Makes changes to a Product resource.
`com.google.api.gax.rpc.UnaryCallable<UpdateProductRequest,Product>`	`updateProductCallable()` Makes changes to a Product resource.
`ProductSet`	`updateProductSet(ProductSet productSet, FieldMask updateMask)` Makes changes to a ProductSet resource.
`ProductSet`	`updateProductSet(UpdateProductSetRequest request)` Makes changes to a ProductSet resource.
`com.google.api.gax.rpc.UnaryCallable<UpdateProductSetRequest,ProductSet>`	`updateProductSetCallable()` Makes changes to a ProductSet resource.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ProductSearchClient
```
protected ProductSearchClient(ProductSearchSettings settings)
                       throws IOException
```
  Constructs an instance of ProductSearchClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
  
  Throws:
  
  IOException
- ProductSearchClient
```
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected ProductSearchClient(ProductSearchStub stub)
```

Method Detail

formatLocationName

@Deprecated
public static final String formatLocationName(String project,
                                                          String location)

Deprecated. Use the LocationName class instead.

Formats a string containing the fully-qualified path to represent a location resource.

formatProductName

@Deprecated
public static final String formatProductName(String project,
                                                         String location,
                                                         String product)

Deprecated. Use the ProductName class instead.

Formats a string containing the fully-qualified path to represent a product resource.

formatProductSetName

@Deprecated
public static final String formatProductSetName(String project,
                                                            String location,
                                                            String productSet)

Deprecated. Use the ProductSetName class instead.

Formats a string containing the fully-qualified path to represent a product_set resource.

formatReferenceImageName

@Deprecated
public static final String formatReferenceImageName(String project,
                                                                String location,
                                                                String product,
                                                                String referenceImage)

Deprecated. Use the ReferenceImageName class instead.

Formats a string containing the fully-qualified path to represent a reference_image resource.

parseProjectFromLocationName
```
@Deprecated
public static final String parseProjectFromLocationName(String locationName)
```
Deprecated. Use the LocationName class instead.

Parses the project from the given fully-qualified path which represents a location resource.

parseLocationFromLocationName
```
@Deprecated
public static final String parseLocationFromLocationName(String locationName)
```
Deprecated. Use the LocationName class instead.

Parses the location from the given fully-qualified path which represents a location resource.

parseProjectFromProductName
```
@Deprecated
public static final String parseProjectFromProductName(String productName)
```
Deprecated. Use the ProductName class instead.

Parses the project from the given fully-qualified path which represents a product resource.

parseLocationFromProductName
```
@Deprecated
public static final String parseLocationFromProductName(String productName)
```
Deprecated. Use the ProductName class instead.

Parses the location from the given fully-qualified path which represents a product resource.

parseProductFromProductName
```
@Deprecated
public static final String parseProductFromProductName(String productName)
```
Deprecated. Use the ProductName class instead.

Parses the product from the given fully-qualified path which represents a product resource.

parseProjectFromProductSetName
```
@Deprecated
public static final String parseProjectFromProductSetName(String productSetName)
```
Deprecated. Use the ProductSetName class instead.

Parses the project from the given fully-qualified path which represents a product_set resource.

parseLocationFromProductSetName
```
@Deprecated
public static final String parseLocationFromProductSetName(String productSetName)
```
Deprecated. Use the ProductSetName class instead.

Parses the location from the given fully-qualified path which represents a product_set resource.

parseProductSetFromProductSetName
```
@Deprecated
public static final String parseProductSetFromProductSetName(String productSetName)
```
Deprecated. Use the ProductSetName class instead.

Parses the product_set from the given fully-qualified path which represents a product_set resource.

parseProjectFromReferenceImageName
```
@Deprecated
public static final String parseProjectFromReferenceImageName(String referenceImageName)
```
Deprecated. Use the ReferenceImageName class instead.

Parses the project from the given fully-qualified path which represents a reference_image resource.

parseLocationFromReferenceImageName
```
@Deprecated
public static final String parseLocationFromReferenceImageName(String referenceImageName)
```
Deprecated. Use the ReferenceImageName class instead.

Parses the location from the given fully-qualified path which represents a reference_image resource.

parseProductFromReferenceImageName
```
@Deprecated
public static final String parseProductFromReferenceImageName(String referenceImageName)
```
Deprecated. Use the ReferenceImageName class instead.

Parses the product from the given fully-qualified path which represents a reference_image resource.

parseReferenceImageFromReferenceImageName
```
@Deprecated
public static final String parseReferenceImageFromReferenceImageName(String referenceImageName)
```
Deprecated. Use the ReferenceImageName class instead.

Parses the reference_image from the given fully-qualified path which represents a reference_image resource.

create

public static final ProductSearchClient create()
                                        throws IOException

Constructs an instance of ProductSearchClient with default settings.

Throws:: IOException

create
```
public static final ProductSearchClient create(ProductSearchSettings settings)
                                        throws IOException
```
Constructs an instance of ProductSearchClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final ProductSearchClient create(ProductSearchStub stub)

Constructs an instance of ProductSearchClient, using the given stub for making calls. This is for advanced usage - prefer to use ProductSearchSettings}.

getSettings

public final ProductSearchSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public ProductSearchStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

createProductSet
```
public final ProductSet createProductSet(LocationName parent,
                                         ProductSet productSet,
                                         String productSetId)
```
Creates and returns a new ProductSet resource.
Possible errors:
* Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   String productSetId = "";
   ProductSet response = productSearchClient.createProductSet(parent, productSet, productSetId);
 }
 
```
Parameters:

parent - Required. The project in which the ProductSet should be created.
Format is `projects/PROJECT_ID/locations/LOC_ID`.

productSet - Required. The ProductSet to create.

productSetId - A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createProductSet
```
public final ProductSet createProductSet(String parent,
                                         ProductSet productSet,
                                         String productSetId)
```
Creates and returns a new ProductSet resource.
Possible errors:
* Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   String productSetId = "";
   ProductSet response = productSearchClient.createProductSet(parent.toString(), productSet, productSetId);
 }
 
```
Parameters:

parent - Required. The project in which the ProductSet should be created.
Format is `projects/PROJECT_ID/locations/LOC_ID`.

productSet - Required. The ProductSet to create.

productSetId - A user-supplied resource id for this ProductSet. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createProductSet

public final 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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   CreateProductSetRequest request = CreateProductSetRequest.newBuilder()
     .setParent(parent.toString())
     .setProductSet(productSet)
     .build();
   ProductSet response = productSearchClient.createProductSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createProductSetCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateProductSetRequest,ProductSet> createProductSetCallable()

Creates and returns a new ProductSet resource.

Possible errors:

* Returns INVALID_ARGUMENT if display_name is missing, or is longer than 4096 characters.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ProductSet productSet = ProductSet.newBuilder().build();
   CreateProductSetRequest request = CreateProductSetRequest.newBuilder()
     .setParent(parent.toString())
     .setProductSet(productSet)
     .build();
   ApiFuture<ProductSet> future = productSearchClient.createProductSetCallable().futureCall(request);
   // Do something
   ProductSet response = future.get();
 }

listProductSets

public final ProductSearchClient.ListProductSetsPagedResponse listProductSets(LocationName parent)

Lists ProductSets in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ProductSet element : productSearchClient.listProductSets(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The project from which ProductSets should be listed.
Format is `projects/PROJECT_ID/locations/LOC_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listProductSets

public final ProductSearchClient.ListProductSetsPagedResponse listProductSets(String parent)

Lists ProductSets in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (ProductSet element : productSearchClient.listProductSets(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The project from which ProductSets should be listed.
Format is `projects/PROJECT_ID/locations/LOC_ID`.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listProductSets

public final ProductSearchClient.ListProductSetsPagedResponse listProductSets(ListProductSetsRequest request)

Lists ProductSets in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListProductSetsRequest request = ListProductSetsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (ProductSet element : productSearchClient.listProductSets(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listProductSetsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListProductSetsRequest,ProductSearchClient.ListProductSetsPagedResponse> listProductSetsPagedCallable()

Lists ProductSets in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListProductSetsRequest request = ListProductSetsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListProductSetsPagedResponse> future = productSearchClient.listProductSetsPagedCallable().futureCall(request);
   // Do something
   for (ProductSet element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listProductSetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListProductSetsRequest,ListProductSetsResponse> listProductSetsCallable()

Lists ProductSets in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100, or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListProductSetsRequest request = ListProductSetsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListProductSetsResponse response = productSearchClient.listProductSetsCallable().call(request);
     for (ProductSet element : response.getProductSetsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getProductSet
```
public final ProductSet getProductSet(ProductSetName name)
```
Gets information associated with a ProductSet.
Possible errors:
* Returns NOT_FOUND if the ProductSet does not exist.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductSet response = productSearchClient.getProductSet(name);
 }
 
```
Parameters:

name - Required. Resource name of the ProductSet to get.
Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getProductSet
```
public final ProductSet getProductSet(String name)
```
Gets information associated with a ProductSet.
Possible errors:
* Returns NOT_FOUND if the ProductSet does not exist.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductSet response = productSearchClient.getProductSet(name.toString());
 }
 
```
Parameters:

name - Required. Resource name of the ProductSet to get.
Format is: `projects/PROJECT_ID/locations/LOG_ID/productSets/PRODUCT_SET_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getProductSet

public final ProductSet getProductSet(GetProductSetRequest request)

Gets information associated with a ProductSet.

Possible errors:

* Returns NOT_FOUND if the ProductSet does not exist.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   GetProductSetRequest request = GetProductSetRequest.newBuilder()
     .setName(name.toString())
     .build();
   ProductSet response = productSearchClient.getProductSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getProductSetCallable

public final com.google.api.gax.rpc.UnaryCallable<GetProductSetRequest,ProductSet> getProductSetCallable()

Gets information associated with a ProductSet.

Possible errors:

* Returns NOT_FOUND if the ProductSet does not exist.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   GetProductSetRequest request = GetProductSetRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ProductSet> future = productSearchClient.getProductSetCallable().futureCall(request);
   // Do something
   ProductSet response = future.get();
 }

updateProductSet
```
public final ProductSet updateProductSet(ProductSet productSet,
                                         FieldMask updateMask)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSet productSet = ProductSet.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ProductSet response = productSearchClient.updateProductSet(productSet, updateMask);
 }
 
```
Parameters:

productSet - Required. The ProductSet resource which replaces the one on the server.

updateMask - The [FieldMask][google.protobuf.FieldMask] that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask path is `display_name`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateProductSet
```
public final ProductSet updateProductSet(UpdateProductSetRequest request)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSet productSet = ProductSet.newBuilder().build();
   UpdateProductSetRequest request = UpdateProductSetRequest.newBuilder()
     .setProductSet(productSet)
     .build();
   ProductSet response = productSearchClient.updateProductSet(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateProductSetCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateProductSetRequest,ProductSet> updateProductSetCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSet productSet = ProductSet.newBuilder().build();
   UpdateProductSetRequest request = UpdateProductSetRequest.newBuilder()
     .setProductSet(productSet)
     .build();
   ApiFuture<ProductSet> future = productSearchClient.updateProductSetCallable().futureCall(request);
   // Do something
   ProductSet response = future.get();
 }

deleteProductSet
```
public final void deleteProductSet(ProductSetName name)
```
Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud Storage.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   productSearchClient.deleteProductSet(name);
 }
 
```
Parameters:

name - Required. Resource name of the ProductSet to delete.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProductSet
```
public final void deleteProductSet(String name)
```
Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.
The actual image files are not deleted from Google Cloud Storage.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   productSearchClient.deleteProductSet(name.toString());
 }
 
```
Parameters:

name - Required. Resource name of the ProductSet to delete.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProductSet

public final void deleteProductSet(DeleteProductSetRequest request)

Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.

The actual image files are not deleted from Google Cloud Storage.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   DeleteProductSetRequest request = DeleteProductSetRequest.newBuilder()
     .setName(name.toString())
     .build();
   productSearchClient.deleteProductSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProductSetCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteProductSetRequest,Empty> deleteProductSetCallable()

Permanently deletes a ProductSet. Products and ReferenceImages in the ProductSet are not deleted.

The actual image files are not deleted from Google Cloud Storage.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   DeleteProductSetRequest request = DeleteProductSetRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = productSearchClient.deleteProductSetCallable().futureCall(request);
   // Do something
   future.get();
 }

createProduct
```
public final Product createProduct(LocationName parent,
                                   Product product,
                                   String productId)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Product product = Product.newBuilder().build();
   String productId = "";
   Product response = productSearchClient.createProduct(parent, product, productId);
 }
 
```
Parameters:

parent - Required. The project in which the Product should be created.
Format is `projects/PROJECT_ID/locations/LOC_ID`.

product - Required. The product to create.

productId - A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createProduct
```
public final Product createProduct(String parent,
                                   Product product,
                                   String productId)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Product product = Product.newBuilder().build();
   String productId = "";
   Product response = productSearchClient.createProduct(parent.toString(), product, productId);
 }
 
```
Parameters:

parent - Required. The project in which the Product should be created.
Format is `projects/PROJECT_ID/locations/LOC_ID`.

product - Required. The product to create.

productId - A user-supplied resource id for this Product. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createProduct

public final 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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Product product = Product.newBuilder().build();
   CreateProductRequest request = CreateProductRequest.newBuilder()
     .setParent(parent.toString())
     .setProduct(product)
     .build();
   Product response = productSearchClient.createProduct(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

createProductCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateProductRequest,Product> createProductCallable()

Creates and returns a new product resource.

Possible errors:

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Product product = Product.newBuilder().build();
   CreateProductRequest request = CreateProductRequest.newBuilder()
     .setParent(parent.toString())
     .setProduct(product)
     .build();
   ApiFuture<Product> future = productSearchClient.createProductCallable().futureCall(request);
   // Do something
   Product response = future.get();
 }

listProducts

public final ProductSearchClient.ListProductsPagedResponse listProducts(LocationName parent)

Lists products in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Product element : productSearchClient.listProducts(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The project OR ProductSet from which Products should be listed.
Format: `projects/PROJECT_ID/locations/LOC_ID`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listProducts

public final ProductSearchClient.ListProductsPagedResponse listProducts(String parent)

Lists products in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Product element : productSearchClient.listProducts(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: parent - Required. The project OR ProductSet from which Products should be listed.
Format: `projects/PROJECT_ID/locations/LOC_ID`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listProducts

public final ProductSearchClient.ListProductsPagedResponse listProducts(ListProductsRequest request)

Lists products in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListProductsRequest request = ListProductsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Product element : productSearchClient.listProducts(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listProductsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListProductsRequest,ProductSearchClient.ListProductsPagedResponse> listProductsPagedCallable()

Lists products in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListProductsRequest request = ListProductsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListProductsPagedResponse> future = productSearchClient.listProductsPagedCallable().futureCall(request);
   // Do something
   for (Product element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listProductsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListProductsRequest,ListProductsResponse> listProductsCallable()

Lists products in an unspecified order.

Possible errors:

* Returns INVALID_ARGUMENT if page_size is greater than 100 or less than 1.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ListProductsRequest request = ListProductsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListProductsResponse response = productSearchClient.listProductsCallable().call(request);
     for (Product element : response.getProductsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getProduct
```
public final Product getProduct(ProductName name)
```
Gets information associated with a Product.
Possible errors:
* Returns NOT_FOUND if the Product does not exist.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   Product response = productSearchClient.getProduct(name);
 }
 
```
Parameters:

name - Required. Resource name of the Product to get.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getProduct
```
public final Product getProduct(String name)
```
Gets information associated with a Product.
Possible errors:
* Returns NOT_FOUND if the Product does not exist.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   Product response = productSearchClient.getProduct(name.toString());
 }
 
```
Parameters:

name - Required. Resource name of the Product to get.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getProduct

public final Product getProduct(GetProductRequest request)

Gets information associated with a Product.

Possible errors:

* Returns NOT_FOUND if the Product does not exist.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   GetProductRequest request = GetProductRequest.newBuilder()
     .setName(name.toString())
     .build();
   Product response = productSearchClient.getProduct(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getProductCallable

public final com.google.api.gax.rpc.UnaryCallable<GetProductRequest,Product> getProductCallable()

Gets information associated with a Product.

Possible errors:

* Returns NOT_FOUND if the Product does not exist.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   GetProductRequest request = GetProductRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Product> future = productSearchClient.getProductCallable().futureCall(request);
   // Do something
   Product response = future.get();
 }

updateProduct
```
public final Product updateProduct(Product product,
                                   FieldMask updateMask)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   Product product = Product.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Product response = productSearchClient.updateProduct(product, updateMask);
 }
 
```
Parameters:

product - Required. The Product resource which replaces the one on the server. product.name is immutable.

updateMask - The [FieldMask][google.protobuf.FieldMask] that specifies which fields to update. If update_mask isn't specified, all mutable fields are to be updated. Valid mask paths include `product_labels`, `display_name`, and `description`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateProduct
```
public final Product updateProduct(UpdateProductRequest request)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   Product product = Product.newBuilder().build();
   UpdateProductRequest request = UpdateProductRequest.newBuilder()
     .setProduct(product)
     .build();
   Product response = productSearchClient.updateProduct(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateProductCallable
```
public final com.google.api.gax.rpc.UnaryCallable<UpdateProductRequest,Product> updateProductCallable()
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   Product product = Product.newBuilder().build();
   UpdateProductRequest request = UpdateProductRequest.newBuilder()
     .setProduct(product)
     .build();
   ApiFuture<Product> future = productSearchClient.updateProductCallable().futureCall(request);
   // Do something
   Product response = future.get();
 }
 
```

deleteProduct
```
public final void deleteProduct(ProductName name)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   productSearchClient.deleteProduct(name);
 }
 
```
Parameters:

name - Required. Resource name of product to delete.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProduct
```
public final void deleteProduct(String name)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   productSearchClient.deleteProduct(name.toString());
 }
 
```
Parameters:

name - Required. Resource name of product to delete.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProduct
```
public final void deleteProduct(DeleteProductRequest request)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   DeleteProductRequest request = DeleteProductRequest.newBuilder()
     .setName(name.toString())
     .build();
   productSearchClient.deleteProduct(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteProductCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteProductRequest,Empty> deleteProductCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName name = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   DeleteProductRequest request = DeleteProductRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = productSearchClient.deleteProductCallable().futureCall(request);
   // Do something
   future.get();
 }

createReferenceImage
```
public final ReferenceImage createReferenceImage(ProductName parent,
                                                 ReferenceImage referenceImage,
                                                 String referenceImageId)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   ReferenceImage referenceImage = ReferenceImage.newBuilder().build();
   String referenceImageId = "";
   ReferenceImage response = productSearchClient.createReferenceImage(parent, referenceImage, referenceImageId);
 }
 
```
Parameters:

parent - Required. Resource name of the product in which to create the reference image.
Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

referenceImage - Required. The reference image to create. If an image ID is specified, it is ignored.

referenceImageId - A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createReferenceImage
```
public final ReferenceImage createReferenceImage(String parent,
                                                 ReferenceImage referenceImage,
                                                 String referenceImageId)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   ReferenceImage referenceImage = ReferenceImage.newBuilder().build();
   String referenceImageId = "";
   ReferenceImage response = productSearchClient.createReferenceImage(parent.toString(), referenceImage, referenceImageId);
 }
 
```
Parameters:

parent - Required. Resource name of the product in which to create the reference image.
Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

referenceImage - Required. The reference image to create. If an image ID is specified, it is ignored.

referenceImageId - A user-supplied resource id for the ReferenceImage to be added. If set, the server will attempt to use this value as the resource id. If it is already in use, an error is returned with code ALREADY_EXISTS. Must be at most 128 characters long. It cannot contain the character `/`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createReferenceImage
```
public final 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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   ReferenceImage referenceImage = ReferenceImage.newBuilder().build();
   CreateReferenceImageRequest request = CreateReferenceImageRequest.newBuilder()
     .setParent(parent.toString())
     .setReferenceImage(referenceImage)
     .build();
   ReferenceImage response = productSearchClient.createReferenceImage(request);
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createReferenceImageCallable
```
public final com.google.api.gax.rpc.UnaryCallable<CreateReferenceImageRequest,ReferenceImage> createReferenceImageCallable()
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   ReferenceImage referenceImage = ReferenceImage.newBuilder().build();
   CreateReferenceImageRequest request = CreateReferenceImageRequest.newBuilder()
     .setParent(parent.toString())
     .setReferenceImage(referenceImage)
     .build();
   ApiFuture<ReferenceImage> future = productSearchClient.createReferenceImageCallable().futureCall(request);
   // Do something
   ReferenceImage response = future.get();
 }
 
```

deleteReferenceImage
```
public final void deleteReferenceImage(ReferenceImageName name)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   productSearchClient.deleteReferenceImage(name);
 }
 
```
Parameters:

name - Required. The resource name of the reference image to delete.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteReferenceImage
```
public final void deleteReferenceImage(String name)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   productSearchClient.deleteReferenceImage(name.toString());
 }
 
```
Parameters:

name - Required. The resource name of the reference image to delete.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteReferenceImage

public final void deleteReferenceImage(DeleteReferenceImageRequest request)

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   DeleteReferenceImageRequest request = DeleteReferenceImageRequest.newBuilder()
     .setName(name.toString())
     .build();
   productSearchClient.deleteReferenceImage(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

deleteReferenceImageCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteReferenceImageRequest,Empty> deleteReferenceImageCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   DeleteReferenceImageRequest request = DeleteReferenceImageRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = productSearchClient.deleteReferenceImageCallable().futureCall(request);
   // Do something
   future.get();
 }

listReferenceImages
```
public final ProductSearchClient.ListReferenceImagesPagedResponse listReferenceImages(ProductName parent)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   for (ReferenceImage element : productSearchClient.listReferenceImages(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

parent - Required. Resource name of the product containing the reference images.
Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listReferenceImages
```
public final ProductSearchClient.ListReferenceImagesPagedResponse listReferenceImages(String parent)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   for (ReferenceImage element : productSearchClient.listReferenceImages(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

parent - Required. Resource name of the product containing the reference images.
Format is `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listReferenceImages

public final ProductSearchClient.ListReferenceImagesPagedResponse listReferenceImages(ListReferenceImagesRequest request)

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   ListReferenceImagesRequest request = ListReferenceImagesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (ReferenceImage element : productSearchClient.listReferenceImages(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listReferenceImagesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListReferenceImagesRequest,ProductSearchClient.ListReferenceImagesPagedResponse> listReferenceImagesPagedCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   ListReferenceImagesRequest request = ListReferenceImagesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListReferenceImagesPagedResponse> future = productSearchClient.listReferenceImagesPagedCallable().futureCall(request);
   // Do something
   for (ReferenceImage element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listReferenceImagesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListReferenceImagesRequest,ListReferenceImagesResponse> listReferenceImagesCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductName parent = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   ListReferenceImagesRequest request = ListReferenceImagesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListReferenceImagesResponse response = productSearchClient.listReferenceImagesCallable().call(request);
     for (ReferenceImage element : response.getReferenceImagesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

getReferenceImage
```
public final ReferenceImage getReferenceImage(ReferenceImageName name)
```
Gets information associated with a ReferenceImage.
Possible errors:
* Returns NOT_FOUND if the specified image does not exist.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   ReferenceImage response = productSearchClient.getReferenceImage(name);
 }
 
```
Parameters:

name - Required. The resource name of the ReferenceImage to get.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getReferenceImage
```
public final ReferenceImage getReferenceImage(String name)
```
Gets information associated with a ReferenceImage.
Possible errors:
* Returns NOT_FOUND if the specified image does not exist.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   ReferenceImage response = productSearchClient.getReferenceImage(name.toString());
 }
 
```
Parameters:

name - Required. The resource name of the ReferenceImage to get.
Format is:
`projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getReferenceImage

public final ReferenceImage getReferenceImage(GetReferenceImageRequest request)

Gets information associated with a ReferenceImage.

Possible errors:

* Returns NOT_FOUND if the specified image does not exist.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   GetReferenceImageRequest request = GetReferenceImageRequest.newBuilder()
     .setName(name.toString())
     .build();
   ReferenceImage response = productSearchClient.getReferenceImage(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

getReferenceImageCallable

public final com.google.api.gax.rpc.UnaryCallable<GetReferenceImageRequest,ReferenceImage> getReferenceImageCallable()

Gets information associated with a ReferenceImage.

Possible errors:

* Returns NOT_FOUND if the specified image does not exist.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ReferenceImageName name = ReferenceImageName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]", "[REFERENCE_IMAGE]");
   GetReferenceImageRequest request = GetReferenceImageRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ReferenceImage> future = productSearchClient.getReferenceImageCallable().futureCall(request);
   // Do something
   ReferenceImage response = future.get();
 }

addProductToProductSet
```
public final void addProductToProductSet(ProductSetName name,
                                         ProductName product)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   productSearchClient.addProductToProductSet(name, product);
 }
 
```
Parameters:

name - Required. The resource name for the ProductSet to modify.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

product - Required. The resource name for the Product to be added to this ProductSet.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

addProductToProductSet
```
public final void addProductToProductSet(String name,
                                         String product)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   productSearchClient.addProductToProductSet(name.toString(), product.toString());
 }
 
```
Parameters:

name - Required. The resource name for the ProductSet to modify.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

product - Required. The resource name for the Product to be added to this ProductSet.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

addProductToProductSet

public final void 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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   AddProductToProductSetRequest request = AddProductToProductSetRequest.newBuilder()
     .setName(name.toString())
     .setProduct(product.toString())
     .build();
   productSearchClient.addProductToProductSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

addProductToProductSetCallable

public final com.google.api.gax.rpc.UnaryCallable<AddProductToProductSetRequest,Empty> addProductToProductSetCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   AddProductToProductSetRequest request = AddProductToProductSetRequest.newBuilder()
     .setName(name.toString())
     .setProduct(product.toString())
     .build();
   ApiFuture<Void> future = productSearchClient.addProductToProductSetCallable().futureCall(request);
   // Do something
   future.get();
 }

removeProductFromProductSet

public final void removeProductFromProductSet(ProductSetName name,
                                              ProductName product)

Removes a Product from the specified ProductSet.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   productSearchClient.removeProductFromProductSet(name, product);
 }

Parameters:: name - Required. The resource name for the ProductSet to modify.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`; product - Required. The resource name for the Product to be removed from this ProductSet.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

removeProductFromProductSet

public final void removeProductFromProductSet(String name,
                                              String product)

Removes a Product from the specified ProductSet.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   productSearchClient.removeProductFromProductSet(name.toString(), product.toString());
 }

Parameters:: name - Required. The resource name for the ProductSet to modify.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`; product - Required. The resource name for the Product to be removed from this ProductSet.
Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

removeProductFromProductSet

public final void removeProductFromProductSet(RemoveProductFromProductSetRequest request)

Removes a Product from the specified ProductSet.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   RemoveProductFromProductSetRequest request = RemoveProductFromProductSetRequest.newBuilder()
     .setName(name.toString())
     .setProduct(product.toString())
     .build();
   productSearchClient.removeProductFromProductSet(request);
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

removeProductFromProductSetCallable

public final com.google.api.gax.rpc.UnaryCallable<RemoveProductFromProductSetRequest,Empty> removeProductFromProductSetCallable()

Removes a Product from the specified ProductSet.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ProductName product = ProductName.of("[PROJECT]", "[LOCATION]", "[PRODUCT]");
   RemoveProductFromProductSetRequest request = RemoveProductFromProductSetRequest.newBuilder()
     .setName(name.toString())
     .setProduct(product.toString())
     .build();
   ApiFuture<Void> future = productSearchClient.removeProductFromProductSetCallable().futureCall(request);
   // Do something
   future.get();
 }

listProductsInProductSet
```
public final ProductSearchClient.ListProductsInProductSetPagedResponse listProductsInProductSet(ProductSetName name)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   for (Product element : productSearchClient.listProductsInProductSet(name).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

name - Required. The ProductSet resource for which to retrieve Products.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listProductsInProductSet
```
public final ProductSearchClient.ListProductsInProductSetPagedResponse listProductsInProductSet(String name)
```
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.
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   for (Product element : productSearchClient.listProductsInProductSet(name.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
```
Parameters:

name - Required. The ProductSet resource for which to retrieve Products.
Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listProductsInProductSet

public final ProductSearchClient.ListProductsInProductSetPagedResponse listProductsInProductSet(ListProductsInProductSetRequest request)

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ListProductsInProductSetRequest request = ListProductsInProductSetRequest.newBuilder()
     .setName(name.toString())
     .build();
   for (Product element : productSearchClient.listProductsInProductSet(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

listProductsInProductSetPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListProductsInProductSetRequest,ProductSearchClient.ListProductsInProductSetPagedResponse> listProductsInProductSetPagedCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ListProductsInProductSetRequest request = ListProductsInProductSetRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<ListProductsInProductSetPagedResponse> future = productSearchClient.listProductsInProductSetPagedCallable().futureCall(request);
   // Do something
   for (Product element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

listProductsInProductSetCallable

public final com.google.api.gax.rpc.UnaryCallable<ListProductsInProductSetRequest,ListProductsInProductSetResponse> listProductsInProductSetCallable()

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.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   ProductSetName name = ProductSetName.of("[PROJECT]", "[LOCATION]", "[PRODUCT_SET]");
   ListProductsInProductSetRequest request = ListProductsInProductSetRequest.newBuilder()
     .setName(name.toString())
     .build();
   while (true) {
     ListProductsInProductSetResponse response = productSearchClient.listProductsInProductSetCallable().call(request);
     for (Product element : response.getProductsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

importProductSetsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ImportProductSetsResponse,BatchOperationMetadata> importProductSetsAsync(LocationName parent,
                                                                                                                                                                                                                                               ImportProductSetsInputConfig inputConfig)

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].

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ImportProductSetsInputConfig inputConfig = ImportProductSetsInputConfig.newBuilder().build();
   ImportProductSetsResponse response = productSearchClient.importProductSetsAsync(parent, inputConfig).get();
 }

Parameters:: parent - Required. The project in which the ProductSets should be imported.
Format is `projects/PROJECT_ID/locations/LOC_ID`.; inputConfig - Required. The input content for the list of requests.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importProductSetsAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ImportProductSetsResponse,BatchOperationMetadata> importProductSetsAsync(String parent,
                                                                                                                                                                                                                                               ImportProductSetsInputConfig inputConfig)

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ImportProductSetsInputConfig inputConfig = ImportProductSetsInputConfig.newBuilder().build();
   ImportProductSetsResponse response = productSearchClient.importProductSetsAsync(parent.toString(), inputConfig).get();
 }

Parameters:: parent - Required. The project in which the ProductSets should be imported.
Format is `projects/PROJECT_ID/locations/LOC_ID`.; inputConfig - Required. The input content for the list of requests.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

importProductSetsAsync
```
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<ImportProductSetsResponse,BatchOperationMetadata> importProductSetsAsync(ImportProductSetsRequest request)
```
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].
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ImportProductSetsInputConfig inputConfig = ImportProductSetsInputConfig.newBuilder().build();
   ImportProductSetsRequest request = ImportProductSetsRequest.newBuilder()
     .setParent(parent.toString())
     .setInputConfig(inputConfig)
     .build();
   ImportProductSetsResponse response = productSearchClient.importProductSetsAsync(request).get();
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

importProductSetsOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<ImportProductSetsRequest,ImportProductSetsResponse,BatchOperationMetadata> importProductSetsOperationCallable()

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ImportProductSetsInputConfig inputConfig = ImportProductSetsInputConfig.newBuilder().build();
   ImportProductSetsRequest request = ImportProductSetsRequest.newBuilder()
     .setParent(parent.toString())
     .setInputConfig(inputConfig)
     .build();
   OperationFuture<ImportProductSetsResponse, BatchOperationMetadata> future = productSearchClient.importProductSetsOperationCallable().futureCall(request);
   // Do something
   ImportProductSetsResponse response = future.get();
 }

importProductSetsCallable

public final com.google.api.gax.rpc.UnaryCallable<ImportProductSetsRequest,com.google.longrunning.Operation> importProductSetsCallable()

Asynchronous API that imports a list of reference images to specified product sets based on a list of image information.

Sample code:


 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   ImportProductSetsInputConfig inputConfig = ImportProductSetsInputConfig.newBuilder().build();
   ImportProductSetsRequest request = ImportProductSetsRequest.newBuilder()
     .setParent(parent.toString())
     .setInputConfig(inputConfig)
     .build();
   ApiFuture<Operation> future = productSearchClient.importProductSetsCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

purgeProductsAsync
```
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Empty,BatchOperationMetadata> purgeProductsAsync(LocationName parent)
```
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)
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   productSearchClient.purgeProductsAsync(parent).get();
 }
 
```
Parameters:

parent - Required. The project and location in which the Products should be deleted.
Format is `projects/PROJECT_ID/locations/LOC_ID`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

purgeProductsAsync
```
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Empty,BatchOperationMetadata> purgeProductsAsync(String parent)
```
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)
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   productSearchClient.purgeProductsAsync(parent.toString()).get();
 }
 
```
Parameters:

parent - Required. The project and location in which the Products should be deleted.
Format is `projects/PROJECT_ID/locations/LOC_ID`.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

purgeProductsAsync
```
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<Empty,BatchOperationMetadata> purgeProductsAsync(PurgeProductsRequest request)
```
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)
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PurgeProductsRequest request = PurgeProductsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   productSearchClient.purgeProductsAsync(request).get();
 }
 
```
Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

purgeProductsOperationCallable
```
@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<PurgeProductsRequest,Empty,BatchOperationMetadata> purgeProductsOperationCallable()
```
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)
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PurgeProductsRequest request = PurgeProductsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   OperationFuture<Empty, BatchOperationMetadata> future = productSearchClient.purgeProductsOperationCallable().futureCall(request);
   // Do something
   future.get();
 }
 
```

purgeProductsCallable
```
public final com.google.api.gax.rpc.UnaryCallable<PurgeProductsRequest,com.google.longrunning.Operation> purgeProductsCallable()
```
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)
Sample code:
```
 try (ProductSearchClient productSearchClient = ProductSearchClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   PurgeProductsRequest request = PurgeProductsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<Operation> future = productSearchClient.purgeProductsCallable().futureCall(request);
   // Do something
   future.get();
 }
 
```

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class ProductSearchClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProductSearchClient

ProductSearchClient

Method Detail

formatLocationName

formatProductName

formatProductSetName

formatReferenceImageName

parseProjectFromLocationName

parseLocationFromLocationName

parseProjectFromProductName

parseLocationFromProductName

parseProductFromProductName

parseProjectFromProductSetName

parseLocationFromProductSetName

parseProductSetFromProductSetName

parseProjectFromReferenceImageName

parseLocationFromReferenceImageName

parseProductFromReferenceImageName

parseReferenceImageFromReferenceImageName

create

create

create

getSettings

getStub

getOperationsClient

createProductSet

createProductSet

createProductSet

createProductSetCallable

listProductSets

listProductSets

listProductSets

listProductSetsPagedCallable

listProductSetsCallable

getProductSet

getProductSet

getProductSet

getProductSetCallable

updateProductSet

updateProductSet

updateProductSetCallable

deleteProductSet

deleteProductSet

deleteProductSet

deleteProductSetCallable

createProduct

createProduct

createProduct

createProductCallable

listProducts

listProducts

listProducts

listProductsPagedCallable

listProductsCallable

getProduct

getProduct

getProduct

getProductCallable

updateProduct

updateProduct

updateProductCallable

deleteProduct

deleteProduct

deleteProduct

deleteProductCallable

createReferenceImage

createReferenceImage

createReferenceImage

createReferenceImageCallable

deleteReferenceImage

deleteReferenceImage

deleteReferenceImage

deleteReferenceImageCallable

listReferenceImages