docs: Keep the API doc up-to-date feat: add search mode to search req…

…uest. If not specified, a single search request triggers both product search and faceted search. feat: update grpc service config settings to reflect correct API deadlines

PiperOrigin-RevId: 404039072

Source-Link: googleapis/googleapis@8ef531e

Source-Link: googleapis/googleapis-gen@86e9109
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODZlOTEwOTdhNDQ1YTRiMDk3MmEyMGU0YjBlM2U4N2Y5YWFkZDJjMCJ9

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CatalogServiceClient.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CatalogServiceClient.java

@@ -57,13 +57,13 @@
  * methods:
  *
  * <ol>
- *   <li>A "flattened" method. With this type of method, the fields of the request type have been
+ *   <li> A "flattened" method. With this type of method, the fields of the request type have been
  *       converted into function parameters. It may be the case that not all fields are available as
  *       parameters, and not every API method will have a flattened method entry point.
- *   <li>A "request object" method. This type of method only takes one parameter, a request object,
+ *   <li> A "request object" method. This type of method only takes one parameter, a request object,
  *       which must be constructed before the call. Not every API method will have a request object
  *       method.
- *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
+ *   <li> A "callable" method. This type of method takes no parameters and returns an immutable API
  *       callable object, which can be used to initiate calls to the service.
  * </ol>
  *
@@ -397,10 +397,10 @@ public final UnaryCallable<UpdateCatalogRequest, Catalog> updateCatalogCallable(
    * <p>More specifically:
    *
    * <ul>
-   *   <li>PredictionService will only return product IDs from branch {newBranch}.
-   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
+   *   <li> PredictionService will only return product IDs from branch {newBranch}.
+   *   <li> SearchService will only return product IDs from branch {newBranch} (if branch is not
    *       explicitly set).
-   *   <li>UserEventService will only join events with products from branch {newBranch}.
+   *   <li> UserEventService will only join events with products from branch {newBranch}.
    * </ul>
    *
    * <p>This feature is only available for users who have Retail Search enabled. Please submit a
@@ -455,10 +455,10 @@ public final void setDefaultBranch(CatalogName catalog) {
    * <p>More specifically:
    *
    * <ul>
-   *   <li>PredictionService will only return product IDs from branch {newBranch}.
-   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
+   *   <li> PredictionService will only return product IDs from branch {newBranch}.
+   *   <li> SearchService will only return product IDs from branch {newBranch} (if branch is not
    *       explicitly set).
-   *   <li>UserEventService will only join events with products from branch {newBranch}.
+   *   <li> UserEventService will only join events with products from branch {newBranch}.
    * </ul>
    *
    * <p>This feature is only available for users who have Retail Search enabled. Please submit a
@@ -511,10 +511,10 @@ public final void setDefaultBranch(String catalog) {
    * <p>More specifically:
    *
    * <ul>
-   *   <li>PredictionService will only return product IDs from branch {newBranch}.
-   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
+   *   <li> PredictionService will only return product IDs from branch {newBranch}.
+   *   <li> SearchService will only return product IDs from branch {newBranch} (if branch is not
    *       explicitly set).
-   *   <li>UserEventService will only join events with products from branch {newBranch}.
+   *   <li> UserEventService will only join events with products from branch {newBranch}.
    * </ul>
    *
    * <p>This feature is only available for users who have Retail Search enabled. Please submit a
@@ -570,10 +570,10 @@ public final void setDefaultBranch(SetDefaultBranchRequest request) {
    * <p>More specifically:
    *
    * <ul>
-   *   <li>PredictionService will only return product IDs from branch {newBranch}.
-   *   <li>SearchService will only return product IDs from branch {newBranch} (if branch is not
+   *   <li> PredictionService will only return product IDs from branch {newBranch}.
+   *   <li> SearchService will only return product IDs from branch {newBranch} (if branch is not
    *       explicitly set).
-   *   <li>UserEventService will only join events with products from branch {newBranch}.
+   *   <li> UserEventService will only join events with products from branch {newBranch}.
    * </ul>
    *
    * <p>This feature is only available for users who have Retail Search enabled. Please submit a
@@ -752,10 +752,7 @@ public boolean awaitTermination(long duration, TimeUnit unit) throws Interrupted
 
   public static class ListCatalogsPagedResponse
       extends AbstractPagedListResponse<
-          ListCatalogsRequest,
-          ListCatalogsResponse,
-          Catalog,
-          ListCatalogsPage,
+          ListCatalogsRequest, ListCatalogsResponse, Catalog, ListCatalogsPage,
           ListCatalogsFixedSizeCollection> {
 
     public static ApiFuture<ListCatalogsPagedResponse> createAsync(
@@ -804,10 +801,7 @@ public ApiFuture<ListCatalogsPage> createPageAsync(
 
   public static class ListCatalogsFixedSizeCollection
       extends AbstractFixedSizeCollection<
-          ListCatalogsRequest,
-          ListCatalogsResponse,
-          Catalog,
-          ListCatalogsPage,
+          ListCatalogsRequest, ListCatalogsResponse, Catalog, ListCatalogsPage,
           ListCatalogsFixedSizeCollection> {
 
     private ListCatalogsFixedSizeCollection(List<ListCatalogsPage> pages, int collectionSize) {

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CatalogServiceSettings.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CatalogServiceSettings.java

@@ -27,6 +27,7 @@
 import com.google.api.gax.rpc.ClientContext;
 import com.google.api.gax.rpc.ClientSettings;
 import com.google.api.gax.rpc.PagedCallSettings;
+import com.google.api.gax.rpc.StubSettings;
 import com.google.api.gax.rpc.TransportChannelProvider;
 import com.google.api.gax.rpc.UnaryCallSettings;
 import com.google.cloud.retail.v2.stub.CatalogServiceStubSettings;
@@ -42,9 +43,9 @@
  * <p>The default instance has everything set to sensible defaults:
  *
  * <ul>
- *   <li>The default service address (retail.googleapis.com) and default port (443) are used.
- *   <li>Credentials are acquired automatically through Application Default Credentials.
- *   <li>Retries are configured for idempotent methods but not for non-idempotent methods.
+ *   <li> The default service address (retail.googleapis.com) and default port (443) are used.
+ *   <li> Credentials are acquired automatically through Application Default Credentials.
+ *   <li> Retries are configured for idempotent methods but not for non-idempotent methods.
  * </ul>
  *
  * <p>The builder of this class is recursive, so contained classes are themselves builders. When

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceClient.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceClient.java

@@ -64,13 +64,13 @@
  * methods:
  *
  * <ol>
- *   <li>A "flattened" method. With this type of method, the fields of the request type have been
+ *   <li> A "flattened" method. With this type of method, the fields of the request type have been
  *       converted into function parameters. It may be the case that not all fields are available as
  *       parameters, and not every API method will have a flattened method entry point.
- *   <li>A "request object" method. This type of method only takes one parameter, a request object,
+ *   <li> A "request object" method. This type of method only takes one parameter, a request object,
  *       which must be constructed before the call. Not every API method will have a request object
  *       method.
- *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
+ *   <li> A "callable" method. This type of method takes no parameters and returns an immutable API
  *       callable object, which can be used to initiate calls to the service.
  * </ol>
  *

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceSettings.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/CompletionServiceSettings.java

@@ -25,6 +25,7 @@
 import com.google.api.gax.rpc.ClientContext;
 import com.google.api.gax.rpc.ClientSettings;
 import com.google.api.gax.rpc.OperationCallSettings;
+import com.google.api.gax.rpc.StubSettings;
 import com.google.api.gax.rpc.TransportChannelProvider;
 import com.google.api.gax.rpc.UnaryCallSettings;
 import com.google.cloud.retail.v2.stub.CompletionServiceStubSettings;
@@ -40,9 +41,9 @@
  * <p>The default instance has everything set to sensible defaults:
  *
  * <ul>
- *   <li>The default service address (retail.googleapis.com) and default port (443) are used.
- *   <li>Credentials are acquired automatically through Application Default Credentials.
- *   <li>Retries are configured for idempotent methods but not for non-idempotent methods.
+ *   <li> The default service address (retail.googleapis.com) and default port (443) are used.
+ *   <li> Credentials are acquired automatically through Application Default Credentials.
+ *   <li> Retries are configured for idempotent methods but not for non-idempotent methods.
  * </ul>
  *
  * <p>The builder of this class is recursive, so contained classes are themselves builders. When

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceClient.java

@@ -57,13 +57,13 @@
  * methods:
  *
  * <ol>
- *   <li>A "flattened" method. With this type of method, the fields of the request type have been
+ *   <li> A "flattened" method. With this type of method, the fields of the request type have been
  *       converted into function parameters. It may be the case that not all fields are available as
  *       parameters, and not every API method will have a flattened method entry point.
- *   <li>A "request object" method. This type of method only takes one parameter, a request object,
+ *   <li> A "request object" method. This type of method only takes one parameter, a request object,
  *       which must be constructed before the call. Not every API method will have a request object
  *       method.
- *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
+ *   <li> A "callable" method. This type of method takes no parameters and returns an immutable API
  *       callable object, which can be used to initiate calls to the service.
  * </ol>
  *

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceSettings.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/PredictionServiceSettings.java

@@ -24,6 +24,7 @@
 import com.google.api.gax.rpc.ApiClientHeaderProvider;
 import com.google.api.gax.rpc.ClientContext;
 import com.google.api.gax.rpc.ClientSettings;
+import com.google.api.gax.rpc.StubSettings;
 import com.google.api.gax.rpc.TransportChannelProvider;
 import com.google.api.gax.rpc.UnaryCallSettings;
 import com.google.cloud.retail.v2.stub.PredictionServiceStubSettings;
@@ -38,9 +39,9 @@
  * <p>The default instance has everything set to sensible defaults:
  *
  * <ul>
- *   <li>The default service address (retail.googleapis.com) and default port (443) are used.
- *   <li>Credentials are acquired automatically through Application Default Credentials.
- *   <li>Retries are configured for idempotent methods but not for non-idempotent methods.
+ *   <li> The default service address (retail.googleapis.com) and default port (443) are used.
+ *   <li> Credentials are acquired automatically through Application Default Credentials.
+ *   <li> Retries are configured for idempotent methods but not for non-idempotent methods.
  * </ul>
  *
  * <p>The builder of this class is recursive, so contained classes are themselves builders. When

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceClient.java

@@ -63,13 +63,13 @@
  * methods:
  *
  * <ol>
- *   <li>A "flattened" method. With this type of method, the fields of the request type have been
+ *   <li> A "flattened" method. With this type of method, the fields of the request type have been
  *       converted into function parameters. It may be the case that not all fields are available as
  *       parameters, and not every API method will have a flattened method entry point.
- *   <li>A "request object" method. This type of method only takes one parameter, a request object,
+ *   <li> A "request object" method. This type of method only takes one parameter, a request object,
  *       which must be constructed before the call. Not every API method will have a request object
  *       method.
- *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
+ *   <li> A "callable" method. This type of method takes no parameters and returns an immutable API
  *       callable object, which can be used to initiate calls to the service.
  * </ol>
  *
@@ -929,10 +929,10 @@ public final UnaryCallable<ImportProductsRequest, Operation> importProductsCalla
    * @param inventory Required. The inventory information to update. The allowable fields to update
    *     are:
    *     <ul>
-   *       <li>[Product.price_info][google.cloud.retail.v2.Product.price_info]
-   *       <li>[Product.availability][google.cloud.retail.v2.Product.availability]
-   *       <li>[Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
-   *       <li>[Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info] The
+   *       <li> [Product.price_info][google.cloud.retail.v2.Product.price_info]
+   *       <li> [Product.availability][google.cloud.retail.v2.Product.availability]
+   *       <li> [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
+   *       <li> [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info] The
    *           updated inventory fields must be specified in
    *           [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask].
    *     </ul>
@@ -950,10 +950,10 @@ public final UnaryCallable<ImportProductsRequest, Operation> importProductsCalla
    *     [SetInventoryRequest.set_time][google.cloud.retail.v2.SetInventoryRequest.set_time].
    *     <p>The last update time is recorded for the following inventory fields:
    *     <ul>
-   *       <li>[Product.price_info][google.cloud.retail.v2.Product.price_info]
-   *       <li>[Product.availability][google.cloud.retail.v2.Product.availability]
-   *       <li>[Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
-   *       <li>[Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
+   *       <li> [Product.price_info][google.cloud.retail.v2.Product.price_info]
+   *       <li> [Product.availability][google.cloud.retail.v2.Product.availability]
+   *       <li> [Product.available_quantity][google.cloud.retail.v2.Product.available_quantity]
+   *       <li> [Product.fulfillment_info][google.cloud.retail.v2.Product.fulfillment_info]
    *     </ul>
    *     <p>If a full overwrite of inventory information while ignoring timestamps is needed,
    *     [UpdateProduct][] should be invoked instead.
@@ -1544,8 +1544,7 @@ public final UnaryCallable<SetInventoryRequest, Operation> setInventoryCallable(
    * }</pre>
    */
   public final OperationCallable<
-          RemoveFulfillmentPlacesRequest,
-          RemoveFulfillmentPlacesResponse,
+          RemoveFulfillmentPlacesRequest, RemoveFulfillmentPlacesResponse,
           RemoveFulfillmentPlacesMetadata>
       removeFulfillmentPlacesOperationCallable() {
     return stub.removeFulfillmentPlacesOperationCallable();
@@ -1626,10 +1625,7 @@ public boolean awaitTermination(long duration, TimeUnit unit) throws Interrupted
 
   public static class ListProductsPagedResponse
       extends AbstractPagedListResponse<
-          ListProductsRequest,
-          ListProductsResponse,
-          Product,
-          ListProductsPage,
+          ListProductsRequest, ListProductsResponse, Product, ListProductsPage,
           ListProductsFixedSizeCollection> {
 
     public static ApiFuture<ListProductsPagedResponse> createAsync(
@@ -1678,10 +1674,7 @@ public ApiFuture<ListProductsPage> createPageAsync(
 
   public static class ListProductsFixedSizeCollection
       extends AbstractFixedSizeCollection<
-          ListProductsRequest,
-          ListProductsResponse,
-          Product,
-          ListProductsPage,
+          ListProductsRequest, ListProductsResponse, Product, ListProductsPage,
           ListProductsFixedSizeCollection> {
 
     private ListProductsFixedSizeCollection(List<ListProductsPage> pages, int collectionSize) {

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceSettings.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/ProductServiceSettings.java

@@ -28,6 +28,7 @@
 import com.google.api.gax.rpc.ClientSettings;
 import com.google.api.gax.rpc.OperationCallSettings;
 import com.google.api.gax.rpc.PagedCallSettings;
+import com.google.api.gax.rpc.StubSettings;
 import com.google.api.gax.rpc.TransportChannelProvider;
 import com.google.api.gax.rpc.UnaryCallSettings;
 import com.google.cloud.retail.v2.stub.ProductServiceStubSettings;
@@ -44,9 +45,9 @@
  * <p>The default instance has everything set to sensible defaults:
  *
  * <ul>
- *   <li>The default service address (retail.googleapis.com) and default port (443) are used.
- *   <li>Credentials are acquired automatically through Application Default Credentials.
- *   <li>Retries are configured for idempotent methods but not for non-idempotent methods.
+ *   <li> The default service address (retail.googleapis.com) and default port (443) are used.
+ *   <li> Credentials are acquired automatically through Application Default Credentials.
+ *   <li> Retries are configured for idempotent methods but not for non-idempotent methods.
  * </ul>
  *
  * <p>The builder of this class is recursive, so contained classes are themselves builders. When
@@ -140,8 +141,7 @@ public UnaryCallSettings<AddFulfillmentPlacesRequest, Operation> addFulfillmentP
 
   /** Returns the object with the settings used for calls to removeFulfillmentPlaces. */
   public OperationCallSettings<
-          RemoveFulfillmentPlacesRequest,
-          RemoveFulfillmentPlacesResponse,
+          RemoveFulfillmentPlacesRequest, RemoveFulfillmentPlacesResponse,
           RemoveFulfillmentPlacesMetadata>
       removeFulfillmentPlacesOperationSettings() {
     return ((ProductServiceStubSettings) getStubSettings())
@@ -317,8 +317,7 @@ public UnaryCallSettings.Builder<SetInventoryRequest, Operation> setInventorySet
 
     /** Returns the builder for the settings used for calls to removeFulfillmentPlaces. */
     public OperationCallSettings.Builder<
-            RemoveFulfillmentPlacesRequest,
-            RemoveFulfillmentPlacesResponse,
+            RemoveFulfillmentPlacesRequest, RemoveFulfillmentPlacesResponse,
             RemoveFulfillmentPlacesMetadata>
         removeFulfillmentPlacesOperationSettings() {
       return getStubSettingsBuilder().removeFulfillmentPlacesOperationSettings();

google-cloud-retail/src/main/java/com/google/cloud/retail/v2/SearchServiceClient.java → owl-bot-staging/v2/google-cloud-retail/src/main/java/com/google/cloud/retail/v2/SearchServiceClient.java

@@ -80,13 +80,13 @@
  * methods:
  *
  * <ol>
- *   <li>A "flattened" method. With this type of method, the fields of the request type have been
+ *   <li> A "flattened" method. With this type of method, the fields of the request type have been
  *       converted into function parameters. It may be the case that not all fields are available as
  *       parameters, and not every API method will have a flattened method entry point.
- *   <li>A "request object" method. This type of method only takes one parameter, a request object,
+ *   <li> A "request object" method. This type of method only takes one parameter, a request object,
  *       which must be constructed before the call. Not every API method will have a request object
  *       method.
- *   <li>A "callable" method. This type of method takes no parameters and returns an immutable API
+ *   <li> A "callable" method. This type of method takes no parameters and returns an immutable API
  *       callable object, which can be used to initiate calls to the service.
  * </ol>
  *
@@ -348,10 +348,7 @@ public boolean awaitTermination(long duration, TimeUnit unit) throws Interrupted
 
   public static class SearchPagedResponse
       extends AbstractPagedListResponse<
-          SearchRequest,
-          SearchResponse,
-          SearchResponse.SearchResult,
-          SearchPage,
+          SearchRequest, SearchResponse, SearchResponse.SearchResult, SearchPage,
           SearchFixedSizeCollection> {
 
     public static ApiFuture<SearchPagedResponse> createAsync(
@@ -398,10 +395,7 @@ public ApiFuture<SearchPage> createPageAsync(
 
   public static class SearchFixedSizeCollection
       extends AbstractFixedSizeCollection<
-          SearchRequest,
-          SearchResponse,
-          SearchResponse.SearchResult,
-          SearchPage,
+          SearchRequest, SearchResponse, SearchResponse.SearchResult, SearchPage,
           SearchFixedSizeCollection> {
 
     private SearchFixedSizeCollection(List<SearchPage> pages, int collectionSize) {