|
104 | 104 | * </tr> |
105 | 105 | * <tr> |
106 | 106 | * <td><p> SetDefaultBranch</td> |
107 | | - * <td><p> 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. |
108 | | - * <p> 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`. |
109 | | - * <p> 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. |
110 | | - * <p> CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. |
111 | | - * <p> More specifically: |
112 | | - * <p> * PredictionService will only return product IDs from branch {newBranch}. * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). * UserEventService will only join events with products from branch {newBranch}.</td> |
| 107 | + * <td><p> 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. |
| 108 | + * <p> 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`. |
| 109 | + * <p> 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. |
| 110 | + * <p> CAUTION: If you have live predict/search traffic, switching the default branch could potentially cause outages if the ID space of the new branch is very different from the old one. |
| 111 | + * <p> More specifically: |
| 112 | + * <ul> |
| 113 | + * <li> PredictionService will only return product IDs from branch {newBranch}. |
| 114 | + * <li> SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly set). |
| 115 | + * <li> UserEventService will only join events with products from branch {newBranch}. |
| 116 | + * </ul></td> |
113 | 117 | * <td> |
114 | 118 | * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
115 | 119 | * <ul> |
|
128 | 132 | * </tr> |
129 | 133 | * <tr> |
130 | 134 | * <td><p> GetDefaultBranch</td> |
131 | | - * <td><p> Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch] method under a specified parent catalog.</td> |
| 135 | + * <td><p> Get which branch is currently default branch set by [CatalogService.SetDefaultBranch][google.cloud.retail.v2.CatalogService.SetDefaultBranch] method under a specified parent catalog.</td> |
132 | 136 | * <td> |
133 | 137 | * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
134 | 138 | * <ul> |
@@ -657,9 +661,12 @@ public final UnaryCallable<UpdateCatalogRequest, Catalog> updateCatalogCallable( |
657 | 661 | * |
658 | 662 | * <p>More specifically: |
659 | 663 | * |
660 | | - * <p>* PredictionService will only return product IDs from branch {newBranch}. * |
661 | | - * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly |
662 | | - * set). * UserEventService will only join events with products from branch {newBranch}. |
| 664 | + * <ul> |
| 665 | + * <li>PredictionService will only return product IDs from branch {newBranch}. |
| 666 | + * <li>SearchService will only return product IDs from branch {newBranch} (if branch is not |
| 667 | + * explicitly set). |
| 668 | + * <li>UserEventService will only join events with products from branch {newBranch}. |
| 669 | + * </ul> |
663 | 670 | * |
664 | 671 | * <p>Sample code: |
665 | 672 | * |
@@ -713,9 +720,12 @@ public final void setDefaultBranch(CatalogName catalog) { |
713 | 720 | * |
714 | 721 | * <p>More specifically: |
715 | 722 | * |
716 | | - * <p>* PredictionService will only return product IDs from branch {newBranch}. * |
717 | | - * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly |
718 | | - * set). * UserEventService will only join events with products from branch {newBranch}. |
| 723 | + * <ul> |
| 724 | + * <li>PredictionService will only return product IDs from branch {newBranch}. |
| 725 | + * <li>SearchService will only return product IDs from branch {newBranch} (if branch is not |
| 726 | + * explicitly set). |
| 727 | + * <li>UserEventService will only join events with products from branch {newBranch}. |
| 728 | + * </ul> |
719 | 729 | * |
720 | 730 | * <p>Sample code: |
721 | 731 | * |
@@ -767,9 +777,12 @@ public final void setDefaultBranch(String catalog) { |
767 | 777 | * |
768 | 778 | * <p>More specifically: |
769 | 779 | * |
770 | | - * <p>* PredictionService will only return product IDs from branch {newBranch}. * |
771 | | - * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly |
772 | | - * set). * UserEventService will only join events with products from branch {newBranch}. |
| 780 | + * <ul> |
| 781 | + * <li>PredictionService will only return product IDs from branch {newBranch}. |
| 782 | + * <li>SearchService will only return product IDs from branch {newBranch} (if branch is not |
| 783 | + * explicitly set). |
| 784 | + * <li>UserEventService will only join events with products from branch {newBranch}. |
| 785 | + * </ul> |
773 | 786 | * |
774 | 787 | * <p>Sample code: |
775 | 788 | * |
@@ -825,9 +838,12 @@ public final void setDefaultBranch(SetDefaultBranchRequest request) { |
825 | 838 | * |
826 | 839 | * <p>More specifically: |
827 | 840 | * |
828 | | - * <p>* PredictionService will only return product IDs from branch {newBranch}. * |
829 | | - * SearchService will only return product IDs from branch {newBranch} (if branch is not explicitly |
830 | | - * set). * UserEventService will only join events with products from branch {newBranch}. |
| 841 | + * <ul> |
| 842 | + * <li>PredictionService will only return product IDs from branch {newBranch}. |
| 843 | + * <li>SearchService will only return product IDs from branch {newBranch} (if branch is not |
| 844 | + * explicitly set). |
| 845 | + * <li>UserEventService will only join events with products from branch {newBranch}. |
| 846 | + * </ul> |
831 | 847 | * |
832 | 848 | * <p>Sample code: |
833 | 849 | * |
|
0 commit comments