feat: support async write mode for WriteUserEvent API (#371)

* feat: support async write mode for WriteUserEvent API
feat: support collect GA4 event format with prebuilt whistle rule
feat: support exact searchable and retrievable in catalog attribute config
feat: deprecate retrievable_fields in product attribute
feat: support diversity type in serving config
docs: keep the API doc up-to-date with recent changes

PiperOrigin-RevId: 495660792

Source-Link: googleapis/googleapis@0dbe50f

Source-Link: https://github.com/googleapis/googleapis-gen/commit/59b8ced066ba19657e06d78c201e620ca6ab79c2
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNTliOGNlZDA2NmJhMTk2NTdlMDZkNzhjMjAxZTYyMGNhNmFiNzljMiJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>

google/cloud/retail_v2/services/catalog_service/async_client.py

@@ -753,7 +753,7 @@ async def sample_get_completion_config():
                 method.
             name (:class:`str`):
                 Required. Full CompletionConfig resource name. Format:
-                projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig
+                ``projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig``
 
                 This corresponds to the ``name`` field
                 on the ``request`` instance; if ``request`` is provided, this

google/cloud/retail_v2/services/catalog_service/client.py

@@ -1038,7 +1038,7 @@ def sample_get_completion_config():
                 method.
             name (str):
                 Required. Full CompletionConfig resource name. Format:
-                projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig
+                ``projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/completionConfig``
 
                 This corresponds to the ``name`` field
                 on the ``request`` instance; if ``request`` is provided, this

google/cloud/retail_v2/services/completion_service/async_client.py

@@ -55,8 +55,8 @@
 class CompletionServiceAsyncClient:
     """Auto-completion service for retail.
     This feature is only available for users who have Retail Search
-    enabled. Please enable Retail Search on Cloud Console before
-    using this feature.
+    enabled. Enable Retail Search on Cloud Console before using this
+    feature.
     """
 
     _client: CompletionServiceClient
@@ -231,8 +231,8 @@ async def complete_query(
         r"""Completes the specified prefix with keyword
         suggestions.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         .. code-block:: python
 
@@ -319,8 +319,8 @@ async def import_completion_data(
         imported suggestions are indexed successfully and ready
         for serving. The process takes hours.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         .. code-block:: python
 

google/cloud/retail_v2/services/completion_service/client.py

@@ -95,8 +95,8 @@ def get_transport_class(
 class CompletionServiceClient(metaclass=CompletionServiceClientMeta):
     """Auto-completion service for retail.
     This feature is only available for users who have Retail Search
-    enabled. Please enable Retail Search on Cloud Console before
-    using this feature.
+    enabled. Enable Retail Search on Cloud Console before using this
+    feature.
     """
 
     @staticmethod
@@ -458,8 +458,8 @@ def complete_query(
         r"""Completes the specified prefix with keyword
         suggestions.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         .. code-block:: python
 
@@ -547,8 +547,8 @@ def import_completion_data(
         imported suggestions are indexed successfully and ready
         for serving. The process takes hours.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         .. code-block:: python
 

google/cloud/retail_v2/services/completion_service/transports/grpc.py

@@ -33,8 +33,8 @@ class CompletionServiceGrpcTransport(CompletionServiceTransport):
 
     Auto-completion service for retail.
     This feature is only available for users who have Retail Search
-    enabled. Please enable Retail Search on Cloud Console before
-    using this feature.
+    enabled. Enable Retail Search on Cloud Console before using this
+    feature.
 
     This class defines the same methods as the primary client, so the
     primary client can load the underlying transport implementation
@@ -259,8 +259,8 @@ def complete_query(
         Completes the specified prefix with keyword
         suggestions.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         Returns:
             Callable[[~.CompleteQueryRequest],
@@ -295,8 +295,8 @@ def import_completion_data(
         imported suggestions are indexed successfully and ready
         for serving. The process takes hours.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         Returns:
             Callable[[~.ImportCompletionDataRequest],

google/cloud/retail_v2/services/completion_service/transports/grpc_asyncio.py

@@ -34,8 +34,8 @@ class CompletionServiceGrpcAsyncIOTransport(CompletionServiceTransport):
 
     Auto-completion service for retail.
     This feature is only available for users who have Retail Search
-    enabled. Please enable Retail Search on Cloud Console before
-    using this feature.
+    enabled. Enable Retail Search on Cloud Console before using this
+    feature.
 
     This class defines the same methods as the primary client, so the
     primary client can load the underlying transport implementation
@@ -264,8 +264,8 @@ def complete_query(
         Completes the specified prefix with keyword
         suggestions.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         Returns:
             Callable[[~.CompleteQueryRequest],
@@ -300,8 +300,8 @@ def import_completion_data(
         imported suggestions are indexed successfully and ready
         for serving. The process takes hours.
         This feature is only available for users who have Retail
-        Search enabled. Please enable Retail Search on Cloud
-        Console before using this feature.
+        Search enabled. Enable Retail Search on Cloud Console
+        before using this feature.
 
         Returns:
             Callable[[~.ImportCompletionDataRequest],

google/cloud/retail_v2/services/product_service/async_client.py

@@ -1000,10 +1000,10 @@ async def set_inventory(
         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, updates are not
-        immediately manifested in the
-        [Product][google.cloud.retail.v2.Product] queried by
+        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].
@@ -1012,40 +1012,44 @@ async def set_inventory(
         [ProductService.CreateProduct][google.cloud.retail.v2.ProductService.CreateProduct]
         and
         [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct],
-        the specified inventory field value(s) will overwrite any
-        existing value(s) while ignoring the last update time for this
-        field. Furthermore, the last update time for the specified
-        inventory fields will be overwritten to the time of the
+        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.
 
         If no inventory fields are set in
         [CreateProductRequest.product][google.cloud.retail.v2.CreateProductRequest.product],
-        then any pre-existing inventory information for this product
-        will be used.
+        then any pre-existing inventory information for this product is
+        used.
 
         If no inventory fields are set in
         [SetInventoryRequest.set_mask][google.cloud.retail.v2.SetInventoryRequest.set_mask],
-        then any existing inventory information will be preserved.
+        then any existing inventory information is preserved.
 
         Pre-existing inventory information can only be updated with
         [ProductService.SetInventory][google.cloud.retail.v2.ProductService.SetInventory],
         [ProductService.AddFulfillmentPlaces][google.cloud.retail.v2.ProductService.AddFulfillmentPlaces],
         and
         [ProductService.RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
 
-        The returned [Operation][]s will be obsolete after 1 day, and
-        [GetOperation][] API will return NOT_FOUND afterwards.
+        The returned [Operation][google.longrunning.Operation]s is
+        obsolete after one day, and the
+        [GetOperation][google.longrunning.Operations.GetOperation] API
+        returns ``NOT_FOUND`` afterwards.
 
-        If conflicting updates are issued, the [Operation][]s associated
-        with the stale updates will not be marked as
-        [done][Operation.done] until being obsolete.
+        If conflicting updates are issued, the
+        [Operation][google.longrunning.Operation]s associated with the
+        stale updates are not marked as
+        [done][google.longrunning.Operation.done] until they are
+        obsolete.
 
         This feature is only available for users who have Retail Search
-        enabled. Please enable Retail Search on Cloud Console before
-        using this feature.
+        enabled. Enable Retail Search on Cloud Console before using this
+        feature.
 
         .. code-block:: python
 
@@ -1263,16 +1267,19 @@ async def add_fulfillment_places(
         or
         [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
 
-        The returned [Operation][]s will be obsolete after 1 day, and
-        [GetOperation][] API will return NOT_FOUND afterwards.
+        The returned [Operation][google.longrunning.Operation]s will be
+        obsolete after 1 day, and
+        [GetOperation][google.longrunning.Operations.GetOperation] API
+        will return NOT_FOUND afterwards.
 
-        If conflicting updates are issued, the [Operation][]s associated
-        with the stale updates will not be marked as
-        [done][Operation.done] until being obsolete.
+        If conflicting updates are issued, the
+        [Operation][google.longrunning.Operation]s associated with the
+        stale updates will not be marked as
+        [done][google.longrunning.Operation.done] until being obsolete.
 
         This feature is only available for users who have Retail Search
-        enabled. Please enable Retail Search on Cloud Console before
-        using this feature.
+        enabled. Enable Retail Search on Cloud Console before using this
+        feature.
 
         .. code-block:: python
 
@@ -1415,16 +1422,19 @@ async def remove_fulfillment_places(
         or
         [ProductService.ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
 
-        The returned [Operation][]s will be obsolete after 1 day, and
-        [GetOperation][] API will return NOT_FOUND afterwards.
+        The returned [Operation][google.longrunning.Operation]s will be
+        obsolete after 1 day, and
+        [GetOperation][google.longrunning.Operations.GetOperation] API
+        will return NOT_FOUND afterwards.
 
-        If conflicting updates are issued, the [Operation][]s associated
-        with the stale updates will not be marked as
-        [done][Operation.done] until being obsolete.
+        If conflicting updates are issued, the
+        [Operation][google.longrunning.Operation]s associated with the
+        stale updates will not be marked as
+        [done][google.longrunning.Operation.done] until being obsolete.
 
         This feature is only available for users who have Retail Search
-        enabled. Please enable Retail Search on Cloud Console before
-        using this feature.
+        enabled. Enable Retail Search on Cloud Console before using this
+        feature.
 
         .. code-block:: python
 
@@ -1576,16 +1586,19 @@ async def add_local_inventories(
         [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
         has no effect on local inventories.
 
-        The returned [Operation][]s will be obsolete after 1 day, and
-        [GetOperation][] API will return NOT_FOUND afterwards.
+        The returned [Operation][google.longrunning.Operation]s will be
+        obsolete after 1 day, and
+        [GetOperation][google.longrunning.Operations.GetOperation] API
+        will return NOT_FOUND afterwards.
 
-        If conflicting updates are issued, the [Operation][]s associated
-        with the stale updates will not be marked as
-        [done][Operation.done] until being obsolete.
+        If conflicting updates are issued, the
+        [Operation][google.longrunning.Operation]s associated with the
+        stale updates will not be marked as
+        [done][google.longrunning.Operation.done] until being obsolete.
 
         This feature is only available for users who have Retail Search
-        enabled. Please enable Retail Search on Cloud Console before
-        using this feature.
+        enabled. Enable Retail Search on Cloud Console before using this
+        feature.
 
         .. code-block:: python
 
@@ -1734,16 +1747,19 @@ async def remove_local_inventories(
         [ProductService.UpdateProduct][google.cloud.retail.v2.ProductService.UpdateProduct]
         has no effect on local inventories.
 
-        The returned [Operation][]s will be obsolete after 1 day, and
-        [GetOperation][] API will return NOT_FOUND afterwards.
+        The returned [Operation][google.longrunning.Operation]s will be
+        obsolete after 1 day, and
+        [GetOperation][google.longrunning.Operations.GetOperation] API
+        will return NOT_FOUND afterwards.
 
-        If conflicting updates are issued, the [Operation][]s associated
-        with the stale updates will not be marked as
-        [done][Operation.done] until being obsolete.
+        If conflicting updates are issued, the
+        [Operation][google.longrunning.Operation]s associated with the
+        stale updates will not be marked as
+        [done][google.longrunning.Operation.done] until being obsolete.
 
         This feature is only available for users who have Retail Search
-        enabled. Please enable Retail Search on Cloud Console before
-        using this feature.
+        enabled. Enable Retail Search on Cloud Console before using this
+        feature.
 
         .. code-block:: python