| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| ListCatalogs | + *ListCatalogs |
* Lists all the [Catalog][google.cloud.retail.v2.Catalog]s associated with the project. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| UpdateCatalog | + *UpdateCatalog |
* Updates the [Catalog][google.cloud.retail.v2.Catalog]s. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| SetDefaultBranch | + *SetDefaultBranch |
* Set a specified branch id as default branch. API methods such as [SearchService.Search][google.cloud.retail.v2.SearchService.Search], [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct], [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts] will treat requests using "default_branch" to the actual branch id set as default. * For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to `projects/*/locations/*/catalogs/*/branches/1`. * Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as [SearchRequest.branch][google.cloud.retail.v2.SearchRequest.branch] to route the traffic to this staging branch. @@ -115,159 +117,158 @@ * |
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| GetDefaultBranch | + *GetDefaultBranch |
* Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch] method under a specified parent catalog. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| GetCompletionConfig | + *GetCompletionConfig |
* Gets a [CompletionConfig][google.cloud.retail.v2.CompletionConfig]. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| UpdateCompletionConfig | + *UpdateCompletionConfig |
* Updates the [CompletionConfig][google.cloud.retail.v2.CompletionConfig]s. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| GetAttributesConfig | + *GetAttributesConfig |
* Gets an [AttributesConfig][google.cloud.retail.v2.AttributesConfig]. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| UpdateAttributesConfig | + *UpdateAttributesConfig |
* Updates the [AttributesConfig][google.cloud.retail.v2.AttributesConfig]. * The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| AddCatalogAttribute | + *AddCatalogAttribute |
* Adds the specified [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2.AttributesConfig]. * If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| RemoveCatalogAttribute | + *RemoveCatalogAttribute |
* Removes the specified [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2.AttributesConfig]. * If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to remove does not exist, a NOT_FOUND error is returned. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ReplaceCatalogAttribute | + *ReplaceCatalogAttribute |
* Replaces the specified [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] in the [AttributesConfig][google.cloud.retail.v2.AttributesConfig] by updating the catalog attribute with the same [CatalogAttribute.key][google.cloud.retail.v2.CatalogAttribute.key]. * If the [CatalogAttribute][google.cloud.retail.v2.CatalogAttribute] to replace does not exist, a NOT_FOUND error is returned. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceClient.java index b8099ab16ae7..aa305e12ceae 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceClient.java @@ -66,27 +66,29 @@ * close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| CompleteQuery | + *CompleteQuery |
* Completes the specified prefix with keyword suggestions. * This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ImportCompletionData | + *ImportCompletionData |
* Bulk import of processed completion dataset. * Request processing is asynchronous. Partial updating is not supported. * The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours. @@ -94,16 +96,15 @@ * |
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ControlServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ControlServiceClient.java index 2be7a05a26f8..cbebb6fb4e8e 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ControlServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ControlServiceClient.java @@ -59,109 +59,110 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| CreateControl | + *CreateControl |
* Creates a Control. * If the [Control][google.cloud.retail.v2.Control] to create already exists, an ALREADY_EXISTS error is returned. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| DeleteControl | + *DeleteControl |
* Deletes a Control. * If the [Control][google.cloud.retail.v2.Control] to delete does not exist, a NOT_FOUND error is returned. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| UpdateControl | + *UpdateControl |
* Updates a Control. * [Control][google.cloud.retail.v2.Control] cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the [Control][google.cloud.retail.v2.Control] to update does not exist, a NOT_FOUND error is returned. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| GetControl | + *GetControl |
* Gets a Control. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ListControls | + *ListControls |
* Lists all Controls by their parent [Catalog][google.cloud.retail.v2.Catalog]. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ModelServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ModelServiceClient.java index 9491ecd97708..167643c2c4d7 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ModelServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ModelServiceClient.java @@ -74,164 +74,165 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| CreateModel | + *CreateModel |
* Creates a new model. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| GetModel | + *GetModel |
* Gets a model. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| PauseModel | + *PauseModel |
* Pauses the training of an existing model. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ResumeModel | + *ResumeModel |
* Resumes the training of an existing model. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| DeleteModel | + *DeleteModel |
* Deletes an existing model. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ListModels | + *ListModels |
* Lists all the models linked to this event store. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| UpdateModel | + *UpdateModel |
* Update of model metadata. Only fields that currently can be updated are: `filtering_option` and `periodic_tuning_state`. If other values are provided, this API method ignores them. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| TuneModel | + *TuneModel |
* Tunes an existing model. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java index e0b87732140b..761ef00ad498 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java @@ -58,25 +58,26 @@ * close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| Predict | + *Predict |
* Makes a recommendation prediction. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java index c323635ae7d6..aa883df024b4 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java @@ -65,124 +65,126 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| CreateProduct | + *CreateProduct |
* Creates a [Product][google.cloud.retail.v2.Product]. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| GetProduct | + *GetProduct |
* Gets a [Product][google.cloud.retail.v2.Product]. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ListProducts | + *ListProducts |
* Gets a list of [Product][google.cloud.retail.v2.Product]s. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| UpdateProduct | + *UpdateProduct |
* Updates a [Product][google.cloud.retail.v2.Product]. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| DeleteProduct | + *DeleteProduct |
* Deletes a [Product][google.cloud.retail.v2.Product]. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ImportProducts | + *ImportProducts |
* Bulk import of multiple [Product][google.cloud.retail.v2.Product]s. * Request processing may be synchronous. Non-existing items are created. * Note that it is possible for a subset of the [Product][google.cloud.retail.v2.Product]s to be successfully updated. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| SetInventory | + *SetInventory |
* Updates inventory information for a [Product][google.cloud.retail.v2.Product] while respecting the last update timestamps of each inventory field. * This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update is enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. * When inventory is updated with [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct], the specified inventory field value(s) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times of the [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] or [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] request. @@ -194,21 +196,21 @@ * |
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| AddFulfillmentPlaces | + *AddFulfillmentPlaces |
* It is recommended to use the [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] method instead of [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces]. [ProductService.AddLocalInventories][google.cloud.retail.v2.ProductService.AddLocalInventories] achieves the same results but provides more fine-grained control over ingesting local inventory data. * Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]. * This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. @@ -217,22 +219,22 @@ * |
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| RemoveFulfillmentPlaces | + *RemoveFulfillmentPlaces |
* It is recommended to use the [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] method instead of [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces]. [ProductService.RemoveLocalInventories][google.cloud.retail.v2.ProductService.RemoveLocalInventories] achieves the same results but provides more fine-grained control over ingesting local inventory data. * Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2.FulfillmentInfo.place_ids]. * This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. @@ -241,22 +243,22 @@ * |
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| AddLocalInventories | + *AddLocalInventories |
* Updates local inventory information for a [Product][google.cloud.retail.v2.Product] at a list of places, while respecting the last update timestamps of each inventory field. * This process is asynchronous and does not require the [Product][google.cloud.retail.v2.Product] to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. * Local inventory information can only be modified using this method. [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] has no effect on local inventories. @@ -265,22 +267,22 @@ * |
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| RemoveLocalInventories | + *RemoveLocalInventories |
* Remove local inventory information for a [Product][google.cloud.retail.v2.Product] at a list of places at a removal timestamp. * This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the [Product][google.cloud.retail.v2.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts]. * Local inventory information can only be removed using this method. [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct] has no effect on local inventories. @@ -289,21 +291,20 @@ * |
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/SearchServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/SearchServiceClient.java index 282dc2154d54..a73ab9ab4953 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/SearchServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/SearchServiceClient.java @@ -84,27 +84,28 @@ * as threads. In the example above, try-with-resources is used, which automatically calls close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| Search | + *Search |
* Performs a search. * This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ServingConfigServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ServingConfigServiceClient.java index 9e8cb5277e5d..3d35e6c0a9f0 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ServingConfigServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ServingConfigServiceClient.java @@ -62,147 +62,148 @@ * calls close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| CreateServingConfig | + *CreateServingConfig |
* Creates a ServingConfig. * A maximum of 100 [ServingConfig][google.cloud.retail.v2.ServingConfig]s are allowed in a [Catalog][google.cloud.retail.v2.Catalog], otherwise a FAILED_PRECONDITION error is returned. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| DeleteServingConfig | + *DeleteServingConfig |
* Deletes a ServingConfig. * Returns a NotFound error if the ServingConfig does not exist. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| UpdateServingConfig | + *UpdateServingConfig |
* Updates a ServingConfig. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| GetServingConfig | + *GetServingConfig |
* Gets a ServingConfig. * Returns a NotFound error if the ServingConfig does not exist. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ListServingConfigs | + *ListServingConfigs |
* Lists all ServingConfigs linked to this catalog. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| AddControl | + *AddControl |
* Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| RemoveControl | + *RemoveControl |
* Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code. diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/UserEventServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/UserEventServiceClient.java index 9e096de19025..0d398b0ee178 100644 --- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/UserEventServiceClient.java +++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/UserEventServiceClient.java @@ -59,86 +59,87 @@ * close(). * *
| Method | *Description | *Method Variants | + *|
|---|---|---|---|
| WriteUserEvent | + *WriteUserEvent |
* Writes a single user event. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| CollectUserEvent | + *CollectUserEvent |
* Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. * This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| PurgeUserEvents | + *PurgeUserEvents |
* Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| ImportUserEvents | + *ImportUserEvents |
* Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. * `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
| RejoinUserEvents | + *RejoinUserEvents |
* Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete. |
*
* Request object method variants only take one parameter, a request object, which must be constructed before the call. *
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. *
|
*
See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/stub/CatalogServiceStubSettings.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/stub/CatalogServiceStubSettings.java
index e895878b22b4..1c4929675fb2 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/stub/CatalogServiceStubSettings.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/stub/CatalogServiceStubSettings.java
@@ -267,6 +267,15 @@ public CatalogServiceStub createStub() throws IOException {
"Transport not supported: %s", getTransportChannelProvider().getTransportName()));
}
+ /** Returns the endpoint set by the user or the the service's default endpoint. */
+ @Override
+ public String getEndpoint() {
+ if (super.getEndpoint() != null) {
+ return super.getEndpoint();
+ }
+ return getDefaultEndpoint();
+ }
+
/** Returns the default service name. */
@Override
public String getServiceName() {
@@ -505,7 +514,6 @@ private static Builder createDefault() {
builder.setTransportChannelProvider(defaultTransportChannelProvider());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultApiClientHeaderProviderBuilder().build());
- builder.setEndpoint(getDefaultEndpoint());
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
builder.setSwitchToMtlsEndpointAllowed(true);
@@ -518,7 +526,6 @@ private static Builder createHttpJsonDefault() {
builder.setTransportChannelProvider(defaultHttpJsonTransportProviderBuilder().build());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultHttpJsonApiClientHeaderProviderBuilder().build());
- builder.setEndpoint(getDefaultEndpoint());
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
builder.setSwitchToMtlsEndpointAllowed(true);
@@ -664,6 +671,15 @@ public UnaryCallSettings.Builder 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:
+ *
+ * Note: close() needs to be called on the AnalyticsServiceClient object to clean up resources
+ * such as threads. In the example above, try-with-resources is used, which automatically calls
+ * close().
+ *
+ * ExportAnalyticsMetrics Exports analytics metrics.
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`. Request object method variants only take one parameter, a request object, which must be constructed before the call. exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request)
+ * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportAnalyticsMetricsOperationCallable()
+ * exportAnalyticsMetricsCallable()
+ * 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 AnalyticsServiceSettings to
+ * create(). For example:
+ *
+ * To customize credentials:
+ *
+ * To customize the endpoint:
+ *
+ * To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
+ * the wire:
+ *
+ * Please refer to the GitHub repository's samples for more quickstart code snippets.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class AnalyticsServiceClient implements BackgroundResource {
+ private final AnalyticsServiceSettings settings;
+ private final AnalyticsServiceStub stub;
+ private final OperationsClient httpJsonOperationsClient;
+ private final com.google.longrunning.OperationsClient operationsClient;
+
+ /** Constructs an instance of AnalyticsServiceClient with default settings. */
+ public static final AnalyticsServiceClient create() throws IOException {
+ return create(AnalyticsServiceSettings.newBuilder().build());
+ }
+
+ /**
+ * Constructs an instance of AnalyticsServiceClient, using the given settings. The channels are
+ * created based on the settings passed in, or defaults for any settings that are not set.
+ */
+ public static final AnalyticsServiceClient create(AnalyticsServiceSettings settings)
+ throws IOException {
+ return new AnalyticsServiceClient(settings);
+ }
+
+ /**
+ * Constructs an instance of AnalyticsServiceClient, using the given stub for making calls. This
+ * is for advanced usage - prefer using create(AnalyticsServiceSettings).
+ */
+ public static final AnalyticsServiceClient create(AnalyticsServiceStub stub) {
+ return new AnalyticsServiceClient(stub);
+ }
+
+ /**
+ * Constructs an instance of AnalyticsServiceClient, 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.
+ */
+ protected AnalyticsServiceClient(AnalyticsServiceSettings settings) throws IOException {
+ this.settings = settings;
+ this.stub = ((AnalyticsServiceStubSettings) settings.getStubSettings()).createStub();
+ this.operationsClient =
+ com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
+ this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
+ }
+
+ protected AnalyticsServiceClient(AnalyticsServiceStub stub) {
+ this.settings = null;
+ this.stub = stub;
+ this.operationsClient =
+ com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
+ this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
+ }
+
+ public final AnalyticsServiceSettings getSettings() {
+ return settings;
+ }
+
+ public AnalyticsServiceStub getStub() {
+ return stub;
+ }
+
+ /**
+ * Returns the OperationsClient that can be used to query the status of a long-running operation
+ * returned by another API method call.
+ */
+ public final com.google.longrunning.OperationsClient getOperationsClient() {
+ return operationsClient;
+ }
+
+ /**
+ * Returns the OperationsClient that can be used to query the status of a long-running operation
+ * returned by another API method call.
+ */
+ @BetaApi
+ public final OperationsClient getHttpJsonOperationsClient() {
+ return httpJsonOperationsClient;
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports analytics metrics.
+ *
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
+ * type `ExportMetadata`.
+ *
+ * Sample code:
+ *
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
+ * type `ExportMetadata`.
+ *
+ * Sample code:
+ *
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
+ * type `ExportMetadata`.
+ *
+ * Sample code:
+ *
+ * The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of exportAnalyticsMetrics to 30 seconds:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction ListCatalogs Lists all the [Catalog][google.cloud.retail.v2alpha.Catalog]s associated with the project. Request object method variants only take one parameter, a request object, which must be constructed before the call. listCatalogs(ListCatalogsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCatalogs(LocationName parent)
+ * listCatalogs(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCatalogsPagedCallable()
+ * listCatalogsCallable()
* UpdateCatalog Updates the [Catalog][google.cloud.retail.v2alpha.Catalog]s. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCatalog(UpdateCatalogRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCatalog(Catalog catalog, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCatalogCallable()
* SetDefaultBranch Set a specified branch id as default branch. API methods such as [SearchService.Search][google.cloud.retail.v2alpha.SearchService.Search], [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct], [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts] will treat requests using "default_branch" to the actual branch id set as default.
* For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting [SearchRequest.branch][google.cloud.retail.v2alpha.SearchRequest.branch] to `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting [SearchRequest.branch][google.cloud.retail.v2alpha.SearchRequest.branch] to `projects/*/locations/*/catalogs/*/branches/1`.
* Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as [SearchRequest.branch][google.cloud.retail.v2alpha.SearchRequest.branch] to route the traffic to this staging branch.
@@ -116,173 +118,172 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. setDefaultBranch(SetDefaultBranchRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setDefaultBranch(CatalogName catalog)
+ * setDefaultBranch(String catalog)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setDefaultBranchCallable()
* GetDefaultBranch Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2alpha.CatalogService.SetDefaultBranch] method under a specified parent catalog. Request object method variants only take one parameter, a request object, which must be constructed before the call. getDefaultBranch(GetDefaultBranchRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDefaultBranch(CatalogName catalog)
+ * getDefaultBranch(String catalog)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDefaultBranchCallable()
* GetCompletionConfig Gets a [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig]. Request object method variants only take one parameter, a request object, which must be constructed before the call. getCompletionConfig(GetCompletionConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCompletionConfig(CompletionConfigName name)
+ * getCompletionConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCompletionConfigCallable()
* UpdateCompletionConfig Updates the [CompletionConfig][google.cloud.retail.v2alpha.CompletionConfig]s. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCompletionConfig(UpdateCompletionConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCompletionConfig(CompletionConfig completionConfig, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCompletionConfigCallable()
* GetAttributesConfig Gets an [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig]. Request object method variants only take one parameter, a request object, which must be constructed before the call. getAttributesConfig(GetAttributesConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAttributesConfig(AttributesConfigName name)
+ * getAttributesConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAttributesConfigCallable()
* UpdateAttributesConfig Updates the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].
* The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAttributesConfig(UpdateAttributesConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateAttributesConfig(AttributesConfig attributesConfig, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateAttributesConfigCallable()
* AddCatalogAttribute Adds the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].
* If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. addCatalogAttribute(AddCatalogAttributeRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addCatalogAttributeCallable()
* RemoveCatalogAttribute Removes the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig].
* If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to remove does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. removeCatalogAttribute(RemoveCatalogAttributeRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeCatalogAttributeCallable()
* BatchRemoveCatalogAttributes Removes all specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute]s from the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig]. Request object method variants only take one parameter, a request object, which must be constructed before the call. batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchRemoveCatalogAttributesCallable()
* ReplaceCatalogAttribute Replaces the specified [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] in the [AttributesConfig][google.cloud.retail.v2alpha.AttributesConfig] by updating the catalog attribute with the same [CatalogAttribute.key][google.cloud.retail.v2alpha.CatalogAttribute.key].
* If the [CatalogAttribute][google.cloud.retail.v2alpha.CatalogAttribute] to replace does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. replaceCatalogAttribute(ReplaceCatalogAttributeRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. replaceCatalogAttributeCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/CompletionServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/CompletionServiceClient.java
index 7e80f190d03f..a3cfa2007bf6 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/CompletionServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/CompletionServiceClient.java
@@ -67,27 +67,29 @@
* close().
*
* CompleteQuery Completes the specified prefix with keyword suggestions.
* This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. Request object method variants only take one parameter, a request object, which must be constructed before the call. completeQuery(CompleteQueryRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. completeQueryCallable()
* ImportCompletionData Bulk import of processed completion dataset.
* Request processing is asynchronous. Partial updating is not supported.
* The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours.
@@ -95,16 +97,15 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. importCompletionDataAsync(ImportCompletionDataRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importCompletionDataOperationCallable()
+ * importCompletionDataCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ControlServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ControlServiceClient.java
index 060ed6295dc1..eae12d56986b 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ControlServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ControlServiceClient.java
@@ -60,109 +60,110 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* CreateControl Creates a Control.
* If the [Control][google.cloud.retail.v2alpha.Control] to create already exists, an ALREADY_EXISTS error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. createControl(CreateControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createControl(CatalogName parent, Control control, String controlId)
+ * createControl(String parent, Control control, String controlId)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createControlCallable()
* DeleteControl Deletes a Control.
* If the [Control][google.cloud.retail.v2alpha.Control] to delete does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteControl(DeleteControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteControl(ControlName name)
+ * deleteControl(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteControlCallable()
* UpdateControl Updates a Control.
* [Control][google.cloud.retail.v2alpha.Control] cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the [Control][google.cloud.retail.v2alpha.Control] to update does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateControl(UpdateControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateControl(Control control, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateControlCallable()
* GetControl Gets a Control. Request object method variants only take one parameter, a request object, which must be constructed before the call. getControl(GetControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getControl(ControlName name)
+ * getControl(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getControlCallable()
* ListControls Lists all Controls by their parent [Catalog][google.cloud.retail.v2alpha.Catalog]. Request object method variants only take one parameter, a request object, which must be constructed before the call. listControls(ListControlsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listControls(CatalogName parent)
+ * listControls(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listControlsPagedCallable()
+ * listControlsCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/MerchantCenterAccountLinkServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/MerchantCenterAccountLinkServiceClient.java
index 010bb21bb3f4..1e155f328e30 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/MerchantCenterAccountLinkServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/MerchantCenterAccountLinkServiceClient.java
@@ -56,69 +56,70 @@
* automatically calls close().
*
* ListMerchantCenterAccountLinks Lists all [MerchantCenterAccountLink][google.cloud.retail.v2alpha.MerchantCenterAccountLink]s under the specified parent [Catalog][google.cloud.retail.v2alpha.Catalog]. Request object method variants only take one parameter, a request object, which must be constructed before the call. listMerchantCenterAccountLinks(ListMerchantCenterAccountLinksRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listMerchantCenterAccountLinks(CatalogName parent)
+ * listMerchantCenterAccountLinks(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listMerchantCenterAccountLinksCallable()
* CreateMerchantCenterAccountLink Creates a [MerchantCenterAccountLink][google.cloud.retail.v2alpha.MerchantCenterAccountLink]. Request object method variants only take one parameter, a request object, which must be constructed before the call. createMerchantCenterAccountLinkAsync(CreateMerchantCenterAccountLinkRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createMerchantCenterAccountLinkAsync(CatalogName parent, MerchantCenterAccountLink merchantCenterAccountLink)
+ * createMerchantCenterAccountLinkAsync(String parent, MerchantCenterAccountLink merchantCenterAccountLink)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createMerchantCenterAccountLinkOperationCallable()
+ * createMerchantCenterAccountLinkCallable()
* DeleteMerchantCenterAccountLink Deletes a [MerchantCenterAccountLink][google.cloud.retail.v2alpha.MerchantCenterAccountLink]. If the [MerchantCenterAccountLink][google.cloud.retail.v2alpha.MerchantCenterAccountLink] to delete does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteMerchantCenterAccountLink(DeleteMerchantCenterAccountLinkRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteMerchantCenterAccountLink(MerchantCenterAccountLinkName name)
+ * deleteMerchantCenterAccountLink(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteMerchantCenterAccountLinkCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ModelServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ModelServiceClient.java
index da3111b78270..ed82ddc9f202 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ModelServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ModelServiceClient.java
@@ -74,164 +74,165 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* CreateModel Creates a new model. Request object method variants only take one parameter, a request object, which must be constructed before the call. createModelAsync(CreateModelRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createModelAsync(CatalogName parent, Model model)
+ * createModelAsync(String parent, Model model)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createModelOperationCallable()
+ * createModelCallable()
* GetModel Gets a model. Request object method variants only take one parameter, a request object, which must be constructed before the call. getModel(GetModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getModel(ModelName name)
+ * getModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getModelCallable()
* PauseModel Pauses the training of an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. pauseModel(PauseModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. pauseModel(ModelName name)
+ * pauseModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. pauseModelCallable()
* ResumeModel Resumes the training of an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. resumeModel(ResumeModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. resumeModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. resumeModelCallable()
* DeleteModel Deletes an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteModel(DeleteModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteModel(ModelName name)
+ * deleteModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteModelCallable()
* ListModels Lists all the models linked to this event store. Request object method variants only take one parameter, a request object, which must be constructed before the call. listModels(ListModelsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listModels(CatalogName parent)
+ * listModels(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listModelsPagedCallable()
+ * listModelsCallable()
* UpdateModel Update of model metadata. Only fields that currently can be updated are: `filtering_option` and `periodic_tuning_state`. If other values are provided, this API method ignores them. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateModel(UpdateModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateModel(Model model, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateModelCallable()
* TuneModel Tunes an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. tuneModelAsync(TuneModelRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. tuneModelAsync(ModelName name)
+ * tuneModelAsync(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. tuneModelOperationCallable()
+ * tuneModelCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/PredictionServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/PredictionServiceClient.java
index 74b1fe2c5047..a7c61e73f9a8 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/PredictionServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/PredictionServiceClient.java
@@ -59,25 +59,26 @@
* close().
*
* Predict Makes a recommendation prediction. Request object method variants only take one parameter, a request object, which must be constructed before the call. predict(PredictRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. predictCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ProductServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ProductServiceClient.java
index 3422108d4075..bb1786d92869 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ProductServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ProductServiceClient.java
@@ -65,141 +65,143 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* CreateProduct Creates a [Product][google.cloud.retail.v2alpha.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. createProduct(CreateProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createProduct(BranchName parent, Product product, String productId)
+ * createProduct(String parent, Product product, String productId)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createProductCallable()
* GetProduct Gets a [Product][google.cloud.retail.v2alpha.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. getProduct(GetProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getProduct(ProductName name)
+ * getProduct(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getProductCallable()
* ListProducts Gets a list of [Product][google.cloud.retail.v2alpha.Product]s. Request object method variants only take one parameter, a request object, which must be constructed before the call. listProducts(ListProductsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listProducts(BranchName parent)
+ * listProducts(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listProductsPagedCallable()
+ * listProductsCallable()
* UpdateProduct Updates a [Product][google.cloud.retail.v2alpha.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateProduct(UpdateProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateProduct(Product product, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateProductCallable()
* DeleteProduct Deletes a [Product][google.cloud.retail.v2alpha.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteProduct(DeleteProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteProduct(ProductName name)
+ * deleteProduct(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteProductCallable()
* PurgeProducts Permanently deletes all selected [Product][google.cloud.retail.v2alpha.Product]s under a branch.
* This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of [Product][google.cloud.retail.v2alpha.Product]s, this operation could take hours to complete. Before the operation completes, some [Product][google.cloud.retail.v2alpha.Product]s may still be returned by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
* Depending on the number of [Product][google.cloud.retail.v2alpha.Product]s, this operation could take hours to complete. To get a sample of [Product][google.cloud.retail.v2alpha.Product]s that would be deleted, set [PurgeProductsRequest.force][google.cloud.retail.v2alpha.PurgeProductsRequest.force] to false. Request object method variants only take one parameter, a request object, which must be constructed before the call. purgeProductsAsync(PurgeProductsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. purgeProductsOperationCallable()
+ * purgeProductsCallable()
* ImportProducts Bulk import of multiple [Product][google.cloud.retail.v2alpha.Product]s.
* Request processing may be synchronous. Non-existing items are created.
* Note that it is possible for a subset of the [Product][google.cloud.retail.v2alpha.Product]s to be successfully updated. Request object method variants only take one parameter, a request object, which must be constructed before the call. importProductsAsync(ImportProductsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importProductsOperationCallable()
+ * importProductsCallable()
* SetInventory Updates inventory information for a [Product][google.cloud.retail.v2alpha.Product] while respecting the last update timestamps of each inventory field.
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2alpha.Product] to exist before updating fulfillment information. If the request is valid, the update is enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2alpha.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
* When inventory is updated with [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct], the specified inventory field value(s) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times of the [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct] or [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct] request.
@@ -211,21 +213,21 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. setInventoryAsync(SetInventoryRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setInventoryAsync(Product inventory, FieldMask setMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setInventoryOperationCallable()
+ * setInventoryCallable()
* AddFulfillmentPlaces It is recommended to use the [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] method instead of [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.AddFulfillmentPlaces]. [ProductService.AddLocalInventories][google.cloud.retail.v2alpha.ProductService.AddLocalInventories] achieves the same results but provides more fine-grained control over ingesting local inventory data.
* Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids].
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2alpha.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the [Product][google.cloud.retail.v2alpha.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
@@ -234,22 +236,22 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. addFulfillmentPlacesAsync(AddFulfillmentPlacesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. addFulfillmentPlacesAsync(ProductName product)
+ * addFulfillmentPlacesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addFulfillmentPlacesOperationCallable()
+ * addFulfillmentPlacesCallable()
* RemoveFulfillmentPlaces It is recommended to use the [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] method instead of [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2alpha.ProductService.RemoveFulfillmentPlaces]. [ProductService.RemoveLocalInventories][google.cloud.retail.v2alpha.ProductService.RemoveLocalInventories] achieves the same results but provides more fine-grained control over ingesting local inventory data.
* Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2alpha.FulfillmentInfo.place_ids].
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2alpha.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the [Product][google.cloud.retail.v2alpha.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
@@ -258,22 +260,22 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. removeFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. removeFulfillmentPlacesAsync(ProductName product)
+ * removeFulfillmentPlacesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeFulfillmentPlacesOperationCallable()
+ * removeFulfillmentPlacesCallable()
* AddLocalInventories Updates local inventory information for a [Product][google.cloud.retail.v2alpha.Product] at a list of places, while respecting the last update timestamps of each inventory field.
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2alpha.Product] to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2alpha.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
* Local inventory information can only be modified using this method. [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct] has no effect on local inventories.
@@ -282,22 +284,22 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. addLocalInventoriesAsync(AddLocalInventoriesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. addLocalInventoriesAsync(ProductName product)
+ * addLocalInventoriesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addLocalInventoriesOperationCallable()
+ * addLocalInventoriesCallable()
* RemoveLocalInventories Remove local inventory information for a [Product][google.cloud.retail.v2alpha.Product] at a list of places at a removal timestamp.
* This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the [Product][google.cloud.retail.v2alpha.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2alpha.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2alpha.ProductService.ListProducts].
* Local inventory information can only be removed using this method. [ProductService.CreateProduct][google.cloud.retail.v2alpha.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2alpha.ProductService.UpdateProduct] has no effect on local inventories.
@@ -306,21 +308,20 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. removeLocalInventoriesAsync(RemoveLocalInventoriesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. removeLocalInventoriesAsync(ProductName product)
+ * removeLocalInventoriesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeLocalInventoriesOperationCallable()
+ * removeLocalInventoriesCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/SearchServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/SearchServiceClient.java
index 331c3a7c5fe9..2b4e80bb5b01 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/SearchServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/SearchServiceClient.java
@@ -85,27 +85,28 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* Search Performs a search.
* This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. Request object method variants only take one parameter, a request object, which must be constructed before the call. search(SearchRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. searchPagedCallable()
+ * searchCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ServingConfigServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ServingConfigServiceClient.java
index 0b93b3f0dfbd..f8222d433736 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ServingConfigServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/ServingConfigServiceClient.java
@@ -63,147 +63,148 @@
* calls close().
*
* CreateServingConfig Creates a ServingConfig.
* A maximum of 100 [ServingConfig][google.cloud.retail.v2alpha.ServingConfig]s are allowed in a [Catalog][google.cloud.retail.v2alpha.Catalog], otherwise a FAILED_PRECONDITION error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. createServingConfig(CreateServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createServingConfig(CatalogName parent, ServingConfig servingConfig, String servingConfigId)
+ * createServingConfig(String parent, ServingConfig servingConfig, String servingConfigId)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createServingConfigCallable()
* DeleteServingConfig Deletes a ServingConfig.
* Returns a NotFound error if the ServingConfig does not exist. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteServingConfig(DeleteServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteServingConfig(ServingConfigName name)
+ * deleteServingConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteServingConfigCallable()
* UpdateServingConfig Updates a ServingConfig. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateServingConfig(UpdateServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateServingConfig(ServingConfig servingConfig, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateServingConfigCallable()
* GetServingConfig Gets a ServingConfig.
* Returns a NotFound error if the ServingConfig does not exist. Request object method variants only take one parameter, a request object, which must be constructed before the call. getServingConfig(GetServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getServingConfig(ServingConfigName name)
+ * getServingConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getServingConfigCallable()
* ListServingConfigs Lists all ServingConfigs linked to this catalog. Request object method variants only take one parameter, a request object, which must be constructed before the call. listServingConfigs(ListServingConfigsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listServingConfigs(CatalogName parent)
+ * listServingConfigs(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listServingConfigsPagedCallable()
+ * listServingConfigsCallable()
* AddControl Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control. Request object method variants only take one parameter, a request object, which must be constructed before the call. addControl(AddControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. addControl(ServingConfigName servingConfig)
+ * addControl(String servingConfig)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addControlCallable()
* RemoveControl Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig. Request object method variants only take one parameter, a request object, which must be constructed before the call. removeControl(RemoveControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. removeControl(ServingConfigName servingConfig)
+ * removeControl(String servingConfig)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeControlCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/UserEventServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/UserEventServiceClient.java
index 546b5056d59d..5e5bbfc0472d 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/UserEventServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/UserEventServiceClient.java
@@ -59,86 +59,87 @@
* close().
*
* WriteUserEvent Writes a single user event. Request object method variants only take one parameter, a request object, which must be constructed before the call. writeUserEvent(WriteUserEventRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. writeUserEventCallable()
* CollectUserEvent Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain.
* This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly. Request object method variants only take one parameter, a request object, which must be constructed before the call. collectUserEvent(CollectUserEventRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. collectUserEventCallable()
* PurgeUserEvents Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. Request object method variants only take one parameter, a request object, which must be constructed before the call. purgeUserEventsAsync(PurgeUserEventsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. purgeUserEventsOperationCallable()
+ * purgeUserEventsCallable()
* ImportUserEvents Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
* `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`. Request object method variants only take one parameter, a request object, which must be constructed before the call. importUserEventsAsync(ImportUserEventsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importUserEventsOperationCallable()
+ * importUserEventsCallable()
* RejoinUserEvents Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete. Request object method variants only take one parameter, a request object, which must be constructed before the call. rejoinUserEventsAsync(RejoinUserEventsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. rejoinUserEventsOperationCallable()
+ * rejoinUserEventsCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/gapic_metadata.json b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/gapic_metadata.json
index cd13fcbcb7eb..3c65a87ce132 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/gapic_metadata.json
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/gapic_metadata.json
@@ -5,6 +5,18 @@
"protoPackage": "google.cloud.retail.v2alpha",
"libraryPackage": "com.google.cloud.retail.v2alpha",
"services": {
+ "AnalyticsService": {
+ "clients": {
+ "grpc": {
+ "libraryClient": "AnalyticsServiceClient",
+ "rpcs": {
+ "ExportAnalyticsMetrics": {
+ "methods": ["exportAnalyticsMetricsAsync", "exportAnalyticsMetricsOperationCallable", "exportAnalyticsMetricsCallable"]
+ }
+ }
+ }
+ }
+ },
"CatalogService": {
"clients": {
"grpc": {
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/package-info.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/package-info.java
index e6cc96cd27bc..52af901af334 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/package-info.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/package-info.java
@@ -19,6 +19,31 @@
*
* The interfaces provided are listed below, along with usage samples.
*
+ * ======================= AnalyticsServiceClient =======================
+ *
+ * Service Description: Service for managing & accessing retail search business metric.
+ * Retail recommendation business metric is currently not available.
+ *
+ * Sample for AnalyticsServiceClient:
+ *
+ * ======================= CatalogServiceClient =======================
*
* Service Description: Service for managing catalog configuration.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/stub/AnalyticsServiceStub.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/stub/AnalyticsServiceStub.java
new file mode 100644
index 000000000000..83252d53682b
--- /dev/null
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2alpha/stub/AnalyticsServiceStub.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.retail.v2alpha.stub;
+
+import com.google.api.core.BetaApi;
+import com.google.api.gax.core.BackgroundResource;
+import com.google.api.gax.rpc.OperationCallable;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.cloud.retail.v2alpha.ExportAnalyticsMetricsRequest;
+import com.google.cloud.retail.v2alpha.ExportAnalyticsMetricsResponse;
+import com.google.cloud.retail.v2alpha.ExportMetadata;
+import com.google.longrunning.Operation;
+import com.google.longrunning.stub.OperationsStub;
+import javax.annotation.Generated;
+
+// AUTO-GENERATED DOCUMENTATION AND CLASS.
+/**
+ * Base stub class for the AnalyticsService service API.
+ *
+ * This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public abstract class AnalyticsServiceStub implements BackgroundResource {
+
+ public OperationsStub getOperationsStub() {
+ return null;
+ }
+
+ public com.google.api.gax.httpjson.longrunning.stub.OperationsStub getHttpJsonOperationsStub() {
+ return null;
+ }
+
+ public OperationCallable<
+ ExportAnalyticsMetricsRequest, ExportAnalyticsMetricsResponse, ExportMetadata>
+ exportAnalyticsMetricsOperationCallable() {
+ throw new UnsupportedOperationException(
+ "Not implemented: exportAnalyticsMetricsOperationCallable()");
+ }
+
+ public UnaryCallable The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of exportAnalyticsMetrics to 30 seconds:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction This class is for advanced usage.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class GrpcAnalyticsServiceCallableFactory implements GrpcStubCallableFactory {
+
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class GrpcAnalyticsServiceStub extends AnalyticsServiceStub {
+ private static final MethodDescriptor This class is for advanced usage.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class HttpJsonAnalyticsServiceCallableFactory
+ implements HttpJsonStubCallableFactory This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class HttpJsonAnalyticsServiceStub extends AnalyticsServiceStub {
+ private static final TypeRegistry typeRegistry =
+ TypeRegistry.newBuilder()
+ .add(ExportMetadata.getDescriptor())
+ .add(ExportAnalyticsMetricsResponse.getDescriptor())
+ .build();
+
+ private static final ApiMethodDescriptor 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:
+ *
+ * Note: close() needs to be called on the AnalyticsServiceClient object to clean up resources
+ * such as threads. In the example above, try-with-resources is used, which automatically calls
+ * close().
+ *
+ * ExportAnalyticsMetrics Exports analytics metrics.
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`. Request object method variants only take one parameter, a request object, which must be constructed before the call. exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request)
+ * Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. exportAnalyticsMetricsOperationCallable()
+ * exportAnalyticsMetricsCallable()
+ * 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 AnalyticsServiceSettings to
+ * create(). For example:
+ *
+ * To customize credentials:
+ *
+ * To customize the endpoint:
+ *
+ * To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
+ * the wire:
+ *
+ * Please refer to the GitHub repository's samples for more quickstart code snippets.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class AnalyticsServiceClient implements BackgroundResource {
+ private final AnalyticsServiceSettings settings;
+ private final AnalyticsServiceStub stub;
+ private final OperationsClient httpJsonOperationsClient;
+ private final com.google.longrunning.OperationsClient operationsClient;
+
+ /** Constructs an instance of AnalyticsServiceClient with default settings. */
+ public static final AnalyticsServiceClient create() throws IOException {
+ return create(AnalyticsServiceSettings.newBuilder().build());
+ }
+
+ /**
+ * Constructs an instance of AnalyticsServiceClient, using the given settings. The channels are
+ * created based on the settings passed in, or defaults for any settings that are not set.
+ */
+ public static final AnalyticsServiceClient create(AnalyticsServiceSettings settings)
+ throws IOException {
+ return new AnalyticsServiceClient(settings);
+ }
+
+ /**
+ * Constructs an instance of AnalyticsServiceClient, using the given stub for making calls. This
+ * is for advanced usage - prefer using create(AnalyticsServiceSettings).
+ */
+ public static final AnalyticsServiceClient create(AnalyticsServiceStub stub) {
+ return new AnalyticsServiceClient(stub);
+ }
+
+ /**
+ * Constructs an instance of AnalyticsServiceClient, 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.
+ */
+ protected AnalyticsServiceClient(AnalyticsServiceSettings settings) throws IOException {
+ this.settings = settings;
+ this.stub = ((AnalyticsServiceStubSettings) settings.getStubSettings()).createStub();
+ this.operationsClient =
+ com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
+ this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
+ }
+
+ protected AnalyticsServiceClient(AnalyticsServiceStub stub) {
+ this.settings = null;
+ this.stub = stub;
+ this.operationsClient =
+ com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
+ this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
+ }
+
+ public final AnalyticsServiceSettings getSettings() {
+ return settings;
+ }
+
+ public AnalyticsServiceStub getStub() {
+ return stub;
+ }
+
+ /**
+ * Returns the OperationsClient that can be used to query the status of a long-running operation
+ * returned by another API method call.
+ */
+ public final com.google.longrunning.OperationsClient getOperationsClient() {
+ return operationsClient;
+ }
+
+ /**
+ * Returns the OperationsClient that can be used to query the status of a long-running operation
+ * returned by another API method call.
+ */
+ @BetaApi
+ public final OperationsClient getHttpJsonOperationsClient() {
+ return httpJsonOperationsClient;
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports analytics metrics.
+ *
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
+ * type `ExportMetadata`.
+ *
+ * Sample code:
+ *
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
+ * type `ExportMetadata`.
+ *
+ * Sample code:
+ *
+ * `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
+ * type `ExportMetadata`.
+ *
+ * Sample code:
+ *
+ * The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of exportAnalyticsMetrics to 30 seconds:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction ListCatalogs Lists all the [Catalog][google.cloud.retail.v2beta.Catalog]s associated with the project. Request object method variants only take one parameter, a request object, which must be constructed before the call. listCatalogs(ListCatalogsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCatalogs(LocationName parent)
+ * listCatalogs(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCatalogsPagedCallable()
+ * listCatalogsCallable()
* UpdateCatalog Updates the [Catalog][google.cloud.retail.v2beta.Catalog]s. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCatalog(UpdateCatalogRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCatalog(Catalog catalog, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCatalogCallable()
* SetDefaultBranch Set a specified branch id as default branch. API methods such as [SearchService.Search][google.cloud.retail.v2beta.SearchService.Search], [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct], [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts] will treat requests using "default_branch" to the actual branch id set as default.
* For example, if `projects/*/locations/*/catalogs/*/branches/1` is set as default, setting [SearchRequest.branch][google.cloud.retail.v2beta.SearchRequest.branch] to `projects/*/locations/*/catalogs/*/branches/default_branch` is equivalent to setting [SearchRequest.branch][google.cloud.retail.v2beta.SearchRequest.branch] to `projects/*/locations/*/catalogs/*/branches/1`.
* Using multiple branches can be useful when developers would like to have a staging branch to test and verify for future usage. When it becomes ready, developers switch on the staging branch using this API while keeping using `projects/*/locations/*/catalogs/*/branches/default_branch` as [SearchRequest.branch][google.cloud.retail.v2beta.SearchRequest.branch] to route the traffic to this staging branch.
@@ -116,173 +118,172 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. setDefaultBranch(SetDefaultBranchRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. setDefaultBranch(CatalogName catalog)
+ * setDefaultBranch(String catalog)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setDefaultBranchCallable()
* GetDefaultBranch Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2beta.CatalogService.SetDefaultBranch] method under a specified parent catalog. Request object method variants only take one parameter, a request object, which must be constructed before the call. getDefaultBranch(GetDefaultBranchRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getDefaultBranch(CatalogName catalog)
+ * getDefaultBranch(String catalog)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getDefaultBranchCallable()
* GetCompletionConfig Gets a [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig]. Request object method variants only take one parameter, a request object, which must be constructed before the call. getCompletionConfig(GetCompletionConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCompletionConfig(CompletionConfigName name)
+ * getCompletionConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCompletionConfigCallable()
* UpdateCompletionConfig Updates the [CompletionConfig][google.cloud.retail.v2beta.CompletionConfig]s. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateCompletionConfig(UpdateCompletionConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateCompletionConfig(CompletionConfig completionConfig, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateCompletionConfigCallable()
* GetAttributesConfig Gets an [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig]. Request object method variants only take one parameter, a request object, which must be constructed before the call. getAttributesConfig(GetAttributesConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getAttributesConfig(AttributesConfigName name)
+ * getAttributesConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getAttributesConfigCallable()
* UpdateAttributesConfig Updates the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
* The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateAttributesConfig(UpdateAttributesConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateAttributesConfig(AttributesConfig attributesConfig, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateAttributesConfigCallable()
* AddCatalogAttribute Adds the specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
* If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to add already exists, an ALREADY_EXISTS error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. addCatalogAttribute(AddCatalogAttributeRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addCatalogAttributeCallable()
* RemoveCatalogAttribute Removes the specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] from the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig].
* If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to remove does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. removeCatalogAttribute(RemoveCatalogAttributeRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeCatalogAttributeCallable()
* BatchRemoveCatalogAttributes Removes all specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute]s from the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig]. Request object method variants only take one parameter, a request object, which must be constructed before the call. batchRemoveCatalogAttributes(BatchRemoveCatalogAttributesRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. batchRemoveCatalogAttributesCallable()
* ReplaceCatalogAttribute Replaces the specified [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] in the [AttributesConfig][google.cloud.retail.v2beta.AttributesConfig] by updating the catalog attribute with the same [CatalogAttribute.key][google.cloud.retail.v2beta.CatalogAttribute.key].
* If the [CatalogAttribute][google.cloud.retail.v2beta.CatalogAttribute] to replace does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. replaceCatalogAttribute(ReplaceCatalogAttributeRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. replaceCatalogAttributeCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/CompletionServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/CompletionServiceClient.java
index b77920ee026d..d0740287bdd7 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/CompletionServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/CompletionServiceClient.java
@@ -66,27 +66,29 @@
* close().
*
* CompleteQuery Completes the specified prefix with keyword suggestions.
* This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. Request object method variants only take one parameter, a request object, which must be constructed before the call. completeQuery(CompleteQueryRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. completeQueryCallable()
* ImportCompletionData Bulk import of processed completion dataset.
* Request processing is asynchronous. Partial updating is not supported.
* The operation is successfully finished only after the imported suggestions are indexed successfully and ready for serving. The process takes hours.
@@ -94,16 +96,15 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. importCompletionDataAsync(ImportCompletionDataRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importCompletionDataOperationCallable()
+ * importCompletionDataCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ControlServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ControlServiceClient.java
index fd3efcd53780..9a4478ffb17e 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ControlServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ControlServiceClient.java
@@ -60,109 +60,110 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* CreateControl Creates a Control.
* If the [Control][google.cloud.retail.v2beta.Control] to create already exists, an ALREADY_EXISTS error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. createControl(CreateControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createControl(CatalogName parent, Control control, String controlId)
+ * createControl(String parent, Control control, String controlId)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createControlCallable()
* DeleteControl Deletes a Control.
* If the [Control][google.cloud.retail.v2beta.Control] to delete does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteControl(DeleteControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteControl(ControlName name)
+ * deleteControl(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteControlCallable()
* UpdateControl Updates a Control.
* [Control][google.cloud.retail.v2beta.Control] cannot be set to a different oneof field, if so an INVALID_ARGUMENT is returned. If the [Control][google.cloud.retail.v2beta.Control] to update does not exist, a NOT_FOUND error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateControl(UpdateControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateControl(Control control, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateControlCallable()
* GetControl Gets a Control. Request object method variants only take one parameter, a request object, which must be constructed before the call. getControl(GetControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getControl(ControlName name)
+ * getControl(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getControlCallable()
* ListControls Lists all Controls by their parent [Catalog][google.cloud.retail.v2beta.Catalog]. Request object method variants only take one parameter, a request object, which must be constructed before the call. listControls(ListControlsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listControls(CatalogName parent)
+ * listControls(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listControlsPagedCallable()
+ * listControlsCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ModelServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ModelServiceClient.java
index dee52f518821..bdd3f4c7b6e8 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ModelServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ModelServiceClient.java
@@ -74,164 +74,165 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* CreateModel Creates a new model. Request object method variants only take one parameter, a request object, which must be constructed before the call. createModelAsync(CreateModelRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createModelAsync(CatalogName parent, Model model)
+ * createModelAsync(String parent, Model model)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createModelOperationCallable()
+ * createModelCallable()
* GetModel Gets a model. Request object method variants only take one parameter, a request object, which must be constructed before the call. getModel(GetModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getModel(ModelName name)
+ * getModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getModelCallable()
* PauseModel Pauses the training of an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. pauseModel(PauseModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. pauseModel(ModelName name)
+ * pauseModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. pauseModelCallable()
* ResumeModel Resumes the training of an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. resumeModel(ResumeModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. resumeModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. resumeModelCallable()
* DeleteModel Deletes an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteModel(DeleteModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteModel(ModelName name)
+ * deleteModel(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteModelCallable()
* ListModels Lists all the models linked to this event store. Request object method variants only take one parameter, a request object, which must be constructed before the call. listModels(ListModelsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listModels(CatalogName parent)
+ * listModels(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listModelsPagedCallable()
+ * listModelsCallable()
* UpdateModel Update of model metadata. Only fields that currently can be updated are: `filtering_option` and `periodic_tuning_state`. If other values are provided, this API method ignores them. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateModel(UpdateModelRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateModel(Model model, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateModelCallable()
* TuneModel Tunes an existing model. Request object method variants only take one parameter, a request object, which must be constructed before the call. tuneModelAsync(TuneModelRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. tuneModelAsync(ModelName name)
+ * tuneModelAsync(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. tuneModelOperationCallable()
+ * tuneModelCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/PredictionServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/PredictionServiceClient.java
index ec4df7c0f849..2fa28af001d7 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/PredictionServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/PredictionServiceClient.java
@@ -59,25 +59,26 @@
* close().
*
* Predict Makes a recommendation prediction. Request object method variants only take one parameter, a request object, which must be constructed before the call. predict(PredictRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. predictCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ProductServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ProductServiceClient.java
index af23a470f57b..3d5e156dda1b 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ProductServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ProductServiceClient.java
@@ -65,124 +65,126 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* CreateProduct Creates a [Product][google.cloud.retail.v2beta.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. createProduct(CreateProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createProduct(BranchName parent, Product product, String productId)
+ * createProduct(String parent, Product product, String productId)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createProductCallable()
* GetProduct Gets a [Product][google.cloud.retail.v2beta.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. getProduct(GetProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getProduct(ProductName name)
+ * getProduct(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getProductCallable()
* ListProducts Gets a list of [Product][google.cloud.retail.v2beta.Product]s. Request object method variants only take one parameter, a request object, which must be constructed before the call. listProducts(ListProductsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listProducts(BranchName parent)
+ * listProducts(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listProductsPagedCallable()
+ * listProductsCallable()
* UpdateProduct Updates a [Product][google.cloud.retail.v2beta.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateProduct(UpdateProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateProduct(Product product, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateProductCallable()
* DeleteProduct Deletes a [Product][google.cloud.retail.v2beta.Product]. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteProduct(DeleteProductRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteProduct(ProductName name)
+ * deleteProduct(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteProductCallable()
* ImportProducts Bulk import of multiple [Product][google.cloud.retail.v2beta.Product]s.
* Request processing may be synchronous. Non-existing items are created.
* Note that it is possible for a subset of the [Product][google.cloud.retail.v2beta.Product]s to be successfully updated. Request object method variants only take one parameter, a request object, which must be constructed before the call. importProductsAsync(ImportProductsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importProductsOperationCallable()
+ * importProductsCallable()
* SetInventory Updates inventory information for a [Product][google.cloud.retail.v2beta.Product] while respecting the last update timestamps of each inventory field.
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2beta.Product] to exist before updating fulfillment information. If the request is valid, the update is enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2beta.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
* When inventory is updated with [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct], the specified inventory field value(s) overwrite any existing value(s) while ignoring the last update time for this field. Furthermore, the last update times for the specified inventory fields are overwritten by the times of the [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct] or [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct] request.
@@ -194,21 +196,21 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. setInventoryAsync(SetInventoryRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. setInventoryAsync(Product inventory, FieldMask setMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setInventoryOperationCallable()
+ * setInventoryCallable()
* AddFulfillmentPlaces It is recommended to use the [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] method instead of [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.AddFulfillmentPlaces]. [ProductService.AddLocalInventories][google.cloud.retail.v2beta.ProductService.AddLocalInventories] achieves the same results but provides more fine-grained control over ingesting local inventory data.
* Incrementally adds place IDs to [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2beta.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the added place IDs are not immediately manifested in the [Product][google.cloud.retail.v2beta.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
@@ -217,22 +219,22 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. addFulfillmentPlacesAsync(AddFulfillmentPlacesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. addFulfillmentPlacesAsync(ProductName product)
+ * addFulfillmentPlacesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addFulfillmentPlacesOperationCallable()
+ * addFulfillmentPlacesCallable()
* RemoveFulfillmentPlaces It is recommended to use the [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] method instead of [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2beta.ProductService.RemoveFulfillmentPlaces]. [ProductService.RemoveLocalInventories][google.cloud.retail.v2beta.ProductService.RemoveLocalInventories] achieves the same results but provides more fine-grained control over ingesting local inventory data.
* Incrementally removes place IDs from a [Product.fulfillment_info.place_ids][google.cloud.retail.v2beta.FulfillmentInfo.place_ids].
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2beta.Product] to exist before updating fulfillment information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, the removed place IDs are not immediately manifested in the [Product][google.cloud.retail.v2beta.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
@@ -241,22 +243,22 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. removeFulfillmentPlacesAsync(RemoveFulfillmentPlacesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. removeFulfillmentPlacesAsync(ProductName product)
+ * removeFulfillmentPlacesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeFulfillmentPlacesOperationCallable()
+ * removeFulfillmentPlacesCallable()
* AddLocalInventories Updates local inventory information for a [Product][google.cloud.retail.v2beta.Product] at a list of places, while respecting the last update timestamps of each inventory field.
* This process is asynchronous and does not require the [Product][google.cloud.retail.v2beta.Product] to exist before updating inventory information. If the request is valid, the update will be enqueued and processed downstream. As a consequence, when a response is returned, updates are not immediately manifested in the [Product][google.cloud.retail.v2beta.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
* Local inventory information can only be modified using this method. [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct] has no effect on local inventories.
@@ -265,22 +267,22 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. addLocalInventoriesAsync(AddLocalInventoriesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. addLocalInventoriesAsync(ProductName product)
+ * addLocalInventoriesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addLocalInventoriesOperationCallable()
+ * addLocalInventoriesCallable()
* RemoveLocalInventories Remove local inventory information for a [Product][google.cloud.retail.v2beta.Product] at a list of places at a removal timestamp.
* This process is asynchronous. If the request is valid, the removal will be enqueued and processed downstream. As a consequence, when a response is returned, removals are not immediately manifested in the [Product][google.cloud.retail.v2beta.Product] queried by [ProductService.GetProduct][google.cloud.retail.v2beta.ProductService.GetProduct] or [ProductService.ListProducts][google.cloud.retail.v2beta.ProductService.ListProducts].
* Local inventory information can only be removed using this method. [ProductService.CreateProduct][google.cloud.retail.v2beta.ProductService.CreateProduct] and [ProductService.UpdateProduct][google.cloud.retail.v2beta.ProductService.UpdateProduct] has no effect on local inventories.
@@ -289,21 +291,20 @@
* Request object method variants only take one parameter, a request object, which must be constructed before the call. removeLocalInventoriesAsync(RemoveLocalInventoriesRequest request)
* Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. removeLocalInventoriesAsync(ProductName product)
+ * removeLocalInventoriesAsync(String product)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeLocalInventoriesOperationCallable()
+ * removeLocalInventoriesCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/SearchServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/SearchServiceClient.java
index 116a0df1a7e6..6a2cff5be2d8 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/SearchServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/SearchServiceClient.java
@@ -85,27 +85,28 @@
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* Search Performs a search.
* This feature is only available for users who have Retail Search enabled. Enable Retail Search on Cloud Console before using this feature. Request object method variants only take one parameter, a request object, which must be constructed before the call. search(SearchRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. searchPagedCallable()
+ * searchCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ServingConfigServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ServingConfigServiceClient.java
index 9b787ed9009b..e5ea2f0051af 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ServingConfigServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/ServingConfigServiceClient.java
@@ -63,147 +63,148 @@
* calls close().
*
* CreateServingConfig Creates a ServingConfig.
* A maximum of 100 [ServingConfig][google.cloud.retail.v2beta.ServingConfig]s are allowed in a [Catalog][google.cloud.retail.v2beta.Catalog], otherwise a FAILED_PRECONDITION error is returned. Request object method variants only take one parameter, a request object, which must be constructed before the call. createServingConfig(CreateServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. createServingConfig(CatalogName parent, ServingConfig servingConfig, String servingConfigId)
+ * createServingConfig(String parent, ServingConfig servingConfig, String servingConfigId)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createServingConfigCallable()
* DeleteServingConfig Deletes a ServingConfig.
* Returns a NotFound error if the ServingConfig does not exist. Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteServingConfig(DeleteServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. deleteServingConfig(ServingConfigName name)
+ * deleteServingConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteServingConfigCallable()
* UpdateServingConfig Updates a ServingConfig. Request object method variants only take one parameter, a request object, which must be constructed before the call. updateServingConfig(UpdateServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. updateServingConfig(ServingConfig servingConfig, FieldMask updateMask)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateServingConfigCallable()
* GetServingConfig Gets a ServingConfig.
* Returns a NotFound error if the ServingConfig does not exist. Request object method variants only take one parameter, a request object, which must be constructed before the call. getServingConfig(GetServingConfigRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getServingConfig(ServingConfigName name)
+ * getServingConfig(String name)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getServingConfigCallable()
* ListServingConfigs Lists all ServingConfigs linked to this catalog. Request object method variants only take one parameter, a request object, which must be constructed before the call. listServingConfigs(ListServingConfigsRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listServingConfigs(CatalogName parent)
+ * listServingConfigs(String parent)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listServingConfigsPagedCallable()
+ * listServingConfigsCallable()
* AddControl Enables a Control on the specified ServingConfig. The control is added in the last position of the list of controls it belongs to (e.g. if it's a facet spec control it will be applied in the last position of servingConfig.facetSpecIds) Returns a ALREADY_EXISTS error if the control has already been applied. Returns a FAILED_PRECONDITION error if the addition could exceed maximum number of control allowed for that type of control. Request object method variants only take one parameter, a request object, which must be constructed before the call. addControl(AddControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. addControl(ServingConfigName servingConfig)
+ * addControl(String servingConfig)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. addControlCallable()
* RemoveControl Disables a Control on the specified ServingConfig. The control is removed from the ServingConfig. Returns a NOT_FOUND error if the Control is not enabled for the ServingConfig. Request object method variants only take one parameter, a request object, which must be constructed before the call. removeControl(RemoveControlRequest request)
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. removeControl(ServingConfigName servingConfig)
+ * removeControl(String servingConfig)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. removeControlCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/UserEventServiceClient.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/UserEventServiceClient.java
index b0a53d6d5e43..5e5be1e629b2 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/UserEventServiceClient.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/UserEventServiceClient.java
@@ -59,86 +59,87 @@
* close().
*
* WriteUserEvent Writes a single user event. Request object method variants only take one parameter, a request object, which must be constructed before the call. writeUserEvent(WriteUserEventRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. writeUserEventCallable()
* CollectUserEvent Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain.
* This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly. Request object method variants only take one parameter, a request object, which must be constructed before the call. collectUserEvent(CollectUserEventRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. collectUserEventCallable()
* PurgeUserEvents Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. Request object method variants only take one parameter, a request object, which must be constructed before the call. purgeUserEventsAsync(PurgeUserEventsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. purgeUserEventsOperationCallable()
+ * purgeUserEventsCallable()
* ImportUserEvents Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
* `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`. Request object method variants only take one parameter, a request object, which must be constructed before the call. importUserEventsAsync(ImportUserEventsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. importUserEventsOperationCallable()
+ * importUserEventsCallable()
* RejoinUserEvents Starts a user-event rejoin operation with latest product catalog. Events are not annotated with detailed product information for products that are missing from the catalog when the user event is ingested. These events are stored as unjoined events with limited usage on training and serving. You can use this method to start a join operation on specified events with the latest version of product catalog. You can also use this method to correct events joined with the wrong product catalog. A rejoin operation can take hours or days to complete. Request object method variants only take one parameter, a request object, which must be constructed before the call. rejoinUserEventsAsync(RejoinUserEventsRequest request)
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. rejoinUserEventsOperationCallable()
+ * rejoinUserEventsCallable()
* See the individual methods for example code.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/gapic_metadata.json b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/gapic_metadata.json
index 9fc728a5a567..d16e2d0a9153 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/gapic_metadata.json
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/gapic_metadata.json
@@ -5,6 +5,18 @@
"protoPackage": "google.cloud.retail.v2beta",
"libraryPackage": "com.google.cloud.retail.v2beta",
"services": {
+ "AnalyticsService": {
+ "clients": {
+ "grpc": {
+ "libraryClient": "AnalyticsServiceClient",
+ "rpcs": {
+ "ExportAnalyticsMetrics": {
+ "methods": ["exportAnalyticsMetricsAsync", "exportAnalyticsMetricsOperationCallable", "exportAnalyticsMetricsCallable"]
+ }
+ }
+ }
+ }
+ },
"CatalogService": {
"clients": {
"grpc": {
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/package-info.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/package-info.java
index 46c7b68d5157..260ec0b5916d 100644
--- a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/package-info.java
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/package-info.java
@@ -19,6 +19,31 @@
*
* The interfaces provided are listed below, along with usage samples.
*
+ * ======================= AnalyticsServiceClient =======================
+ *
+ * Service Description: Service for managing & accessing retail search business metric.
+ * Retail recommendation business metric is currently not available.
+ *
+ * Sample for AnalyticsServiceClient:
+ *
+ * ======================= CatalogServiceClient =======================
*
* Service Description: Service for managing catalog configuration.
diff --git a/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/stub/AnalyticsServiceStub.java b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/stub/AnalyticsServiceStub.java
new file mode 100644
index 000000000000..d977b0970425
--- /dev/null
+++ b/java-retail/google-cloud-retail/src/main/java/com/google/cloud/retail/v2beta/stub/AnalyticsServiceStub.java
@@ -0,0 +1,61 @@
+/*
+ * Copyright 2023 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.cloud.retail.v2beta.stub;
+
+import com.google.api.core.BetaApi;
+import com.google.api.gax.core.BackgroundResource;
+import com.google.api.gax.rpc.OperationCallable;
+import com.google.api.gax.rpc.UnaryCallable;
+import com.google.cloud.retail.v2beta.ExportAnalyticsMetricsRequest;
+import com.google.cloud.retail.v2beta.ExportAnalyticsMetricsResponse;
+import com.google.cloud.retail.v2beta.ExportMetadata;
+import com.google.longrunning.Operation;
+import com.google.longrunning.stub.OperationsStub;
+import javax.annotation.Generated;
+
+// AUTO-GENERATED DOCUMENTATION AND CLASS.
+/**
+ * Base stub class for the AnalyticsService service API.
+ *
+ * This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public abstract class AnalyticsServiceStub implements BackgroundResource {
+
+ public OperationsStub getOperationsStub() {
+ return null;
+ }
+
+ public com.google.api.gax.httpjson.longrunning.stub.OperationsStub getHttpJsonOperationsStub() {
+ return null;
+ }
+
+ public OperationCallable<
+ ExportAnalyticsMetricsRequest, ExportAnalyticsMetricsResponse, ExportMetadata>
+ exportAnalyticsMetricsOperationCallable() {
+ throw new UnsupportedOperationException(
+ "Not implemented: exportAnalyticsMetricsOperationCallable()");
+ }
+
+ public UnaryCallable The default instance has everything set to sensible defaults:
+ *
+ * The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object.
+ *
+ * For example, to set the total timeout of exportAnalyticsMetrics to 30 seconds:
+ *
+ * Note: This method does not support applying settings to streaming methods.
+ */
+ public Builder applyToAllUnaryMethods(
+ ApiFunction This class is for advanced usage.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class GrpcAnalyticsServiceCallableFactory implements GrpcStubCallableFactory {
+
+ @Override
+ public This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class GrpcAnalyticsServiceStub extends AnalyticsServiceStub {
+ private static final MethodDescriptor This class is for advanced usage.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class HttpJsonAnalyticsServiceCallableFactory
+ implements HttpJsonStubCallableFactory This class is for advanced usage and reflects the underlying API directly.
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class HttpJsonAnalyticsServiceStub extends AnalyticsServiceStub {
+ private static final TypeRegistry typeRegistry =
+ TypeRegistry.newBuilder()
+ .add(ExportMetadata.getDescriptor())
+ .add(ExportAnalyticsMetricsResponse.getDescriptor())
+ .build();
+
+ private static final ApiMethodDescriptor{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ExportAnalyticsMetricsResponse response =
+ * analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
+ * }
+ * }
+ *
+ *
+ *
+ *
+ *
+ *
+ * Method
+ * Description
+ * Method Variants
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings analyticsServiceSettings =
+ * AnalyticsServiceSettings.newBuilder()
+ * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
+ * .build();
+ * AnalyticsServiceClient analyticsServiceClient =
+ * AnalyticsServiceClient.create(analyticsServiceSettings);
+ * }
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings analyticsServiceSettings =
+ * AnalyticsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
+ * AnalyticsServiceClient analyticsServiceClient =
+ * AnalyticsServiceClient.create(analyticsServiceSettings);
+ * }
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings analyticsServiceSettings =
+ * AnalyticsServiceSettings.newHttpJsonBuilder().build();
+ * AnalyticsServiceClient analyticsServiceClient =
+ * AnalyticsServiceClient.create(analyticsServiceSettings);
+ * }
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ExportAnalyticsMetricsResponse response =
+ * analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
+ * }
+ * }
+ *
+ * @param 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
+ */
+ public final OperationFuture{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * OperationFuture
+ */
+ public final OperationCallable<
+ ExportAnalyticsMetricsRequest, ExportAnalyticsMetricsResponse, ExportMetadata>
+ exportAnalyticsMetricsOperationCallable() {
+ return stub.exportAnalyticsMetricsOperationCallable();
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports analytics metrics.
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ApiFuture
+ */
+ public final UnaryCallable
+ *
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings.Builder analyticsServiceSettingsBuilder =
+ * AnalyticsServiceSettings.newBuilder();
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .setRetrySettings(
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * AnalyticsServiceSettings analyticsServiceSettings = analyticsServiceSettingsBuilder.build();
+ * }
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class AnalyticsServiceSettings extends ClientSettings
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* ListCatalogs
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateCatalog
+ *
*
*
- *
*
- *
*
- *
*
- *
* SetDefaultBranch
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetDefaultBranch
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetCompletionConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateCompletionConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetAttributesConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateAttributesConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddCatalogAttribute
+ *
*
*
- *
*
- *
*
- *
* RemoveCatalogAttribute
+ *
*
*
- *
*
- *
*
- *
* BatchRemoveCatalogAttributes
+ *
*
*
- *
*
- *
*
- *
- *
* ReplaceCatalogAttribute
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CompleteQuery
+ *
*
*
- *
*
- *
*
- *
- *
* ImportCompletionData
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateControl
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteControl
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateControl
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetControl
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* ListControls
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* ListMerchantCenterAccountLinks
+ *
*
*
- *
*
- *
*
- *
*
- *
* CreateMerchantCenterAccountLink
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* DeleteMerchantCenterAccountLink
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* PauseModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* ResumeModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* ListModels
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateModel
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* TuneModel
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
- *
* Predict
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* ListProducts
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* PurgeProducts
+ *
*
*
- *
*
- *
*
- *
* ImportProducts
+ *
*
*
- *
*
- *
*
- *
* SetInventory
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddFulfillmentPlaces
+ *
*
*
- *
*
- *
*
- *
*
- *
* RemoveFulfillmentPlaces
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddLocalInventories
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* RemoveLocalInventories
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
- *
* Search
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* ListServingConfigs
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddControl
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* RemoveControl
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* WriteUserEvent
+ *
*
*
- *
*
- *
*
- *
* CollectUserEvent
+ *
*
*
- *
*
- *
*
- *
* PurgeUserEvents
+ *
*
*
- *
*
- *
*
- *
* ImportUserEvents
+ *
*
*
- *
*
- *
*
- *
- *
* RejoinUserEvents
+ *
*
*
- *
*
- *
* {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ExportAnalyticsMetricsResponse response =
+ * analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
+ * }
+ * }
+ *
*
+ *
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceStubSettings.Builder analyticsServiceSettingsBuilder =
+ * AnalyticsServiceStubSettings.newBuilder();
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .setRetrySettings(
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * AnalyticsServiceStubSettings analyticsServiceSettings = analyticsServiceSettingsBuilder.build();
+ * }
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class AnalyticsServiceStubSettings extends StubSettings{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ExportAnalyticsMetricsResponse response =
+ * analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
+ * }
+ * }
+ *
+ *
+ *
+ *
+ *
+ *
+ * Method
+ * Description
+ * Method Variants
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings analyticsServiceSettings =
+ * AnalyticsServiceSettings.newBuilder()
+ * .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
+ * .build();
+ * AnalyticsServiceClient analyticsServiceClient =
+ * AnalyticsServiceClient.create(analyticsServiceSettings);
+ * }
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings analyticsServiceSettings =
+ * AnalyticsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
+ * AnalyticsServiceClient analyticsServiceClient =
+ * AnalyticsServiceClient.create(analyticsServiceSettings);
+ * }
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings analyticsServiceSettings =
+ * AnalyticsServiceSettings.newHttpJsonBuilder().build();
+ * AnalyticsServiceClient analyticsServiceClient =
+ * AnalyticsServiceClient.create(analyticsServiceSettings);
+ * }
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ExportAnalyticsMetricsResponse response =
+ * analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
+ * }
+ * }
+ *
+ * @param 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
+ */
+ public final OperationFuture{@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * OperationFuture
+ */
+ public final OperationCallable<
+ ExportAnalyticsMetricsRequest, ExportAnalyticsMetricsResponse, ExportMetadata>
+ exportAnalyticsMetricsOperationCallable() {
+ return stub.exportAnalyticsMetricsOperationCallable();
+ }
+
+ // AUTO-GENERATED DOCUMENTATION AND METHOD.
+ /**
+ * Exports analytics metrics.
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ApiFuture
+ */
+ public final UnaryCallable
+ *
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceSettings.Builder analyticsServiceSettingsBuilder =
+ * AnalyticsServiceSettings.newBuilder();
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .setRetrySettings(
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * AnalyticsServiceSettings analyticsServiceSettings = analyticsServiceSettingsBuilder.build();
+ * }
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class AnalyticsServiceSettings extends ClientSettings
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* ListCatalogs
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateCatalog
+ *
*
*
- *
*
- *
*
- *
*
- *
* SetDefaultBranch
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetDefaultBranch
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetCompletionConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateCompletionConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetAttributesConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateAttributesConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddCatalogAttribute
+ *
*
*
- *
*
- *
*
- *
* RemoveCatalogAttribute
+ *
*
*
- *
*
- *
*
- *
* BatchRemoveCatalogAttributes
+ *
*
*
- *
*
- *
*
- *
- *
* ReplaceCatalogAttribute
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CompleteQuery
+ *
*
*
- *
*
- *
*
- *
- *
* ImportCompletionData
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateControl
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteControl
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateControl
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetControl
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* ListControls
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* PauseModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* ResumeModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteModel
+ *
*
*
- *
*
- *
*
- *
*
- *
* ListModels
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateModel
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* TuneModel
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
- *
* Predict
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* ListProducts
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteProduct
+ *
*
*
- *
*
- *
*
- *
*
- *
* ImportProducts
+ *
*
*
- *
*
- *
*
- *
* SetInventory
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddFulfillmentPlaces
+ *
*
*
- *
*
- *
*
- *
*
- *
* RemoveFulfillmentPlaces
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddLocalInventories
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* RemoveLocalInventories
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
- *
* Search
+ *
*
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* CreateServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* DeleteServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* UpdateServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* GetServingConfig
+ *
*
*
- *
*
- *
*
- *
*
- *
* ListServingConfigs
+ *
*
*
- *
*
- *
*
- *
*
- *
* AddControl
+ *
*
*
- *
*
- *
*
- *
*
- *
- *
* RemoveControl
+ *
*
*
- *
*
- *
*
- *
*
+ *
*
*
*
* Method
* Description
* Method Variants
+ *
- *
* WriteUserEvent
+ *
*
*
- *
*
- *
*
- *
* CollectUserEvent
+ *
*
*
- *
*
- *
*
- *
* PurgeUserEvents
+ *
*
*
- *
*
- *
*
- *
* ImportUserEvents
+ *
*
*
- *
*
- *
*
- *
- *
* RejoinUserEvents
+ *
*
*
- *
*
- *
* {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
+ * ExportAnalyticsMetricsRequest request =
+ * ExportAnalyticsMetricsRequest.newBuilder()
+ * .setCatalog("catalog555704345")
+ * .setOutputConfig(OutputConfig.newBuilder().build())
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ExportAnalyticsMetricsResponse response =
+ * analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
+ * }
+ * }
+ *
*
+ *
+ *
+ * {@code
+ * // This snippet has been automatically generated and should be regarded as a code template only.
+ * // It will require modifications to work:
+ * // - It may require correct/in-range values for request initialization.
+ * // - It may require specifying regional endpoints when creating the service client as shown in
+ * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
+ * AnalyticsServiceStubSettings.Builder analyticsServiceSettingsBuilder =
+ * AnalyticsServiceStubSettings.newBuilder();
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .setRetrySettings(
+ * analyticsServiceSettingsBuilder
+ * .exportAnalyticsMetricsSettings()
+ * .getRetrySettings()
+ * .toBuilder()
+ * .setTotalTimeout(Duration.ofSeconds(30))
+ * .build());
+ * AnalyticsServiceStubSettings analyticsServiceSettings = analyticsServiceSettingsBuilder.build();
+ * }
+ */
+@BetaApi
+@Generated("by gapic-generator-java")
+public class AnalyticsServiceStubSettings extends StubSettings