Skip to content
Permalink
Browse files
docs: Keep the API doc up-to-date (#80)
- [ ] Regenerate this pull request now.

PiperOrigin-RevId: 391605108

Source-Link: googleapis/googleapis@62d5035

Source-Link: googleapis/googleapis-gen@d3293d9
  • Loading branch information
gcf-owl-bot committed Aug 19, 2021
1 parent 9e8a666 commit a77f0ea03ab1d5a2cb976bb2bff3739c15026558
Showing with 307 additions and 239 deletions.
  1. +6 −6 google/cloud/retail_v2/services/catalog_service/async_client.py
  2. +6 −6 google/cloud/retail_v2/services/catalog_service/client.py
  3. +6 −6 google/cloud/retail_v2/services/catalog_service/transports/grpc.py
  4. +6 −6 google/cloud/retail_v2/services/catalog_service/transports/grpc_asyncio.py
  5. +18 −15 google/cloud/retail_v2/services/completion_service/async_client.py
  6. +18 −15 google/cloud/retail_v2/services/completion_service/client.py
  7. +18 −15 google/cloud/retail_v2/services/completion_service/transports/grpc.py
  8. +18 −15 google/cloud/retail_v2/services/completion_service/transports/grpc_asyncio.py
  9. +9 −9 google/cloud/retail_v2/services/product_service/async_client.py
  10. +9 −9 google/cloud/retail_v2/services/product_service/client.py
  11. +9 −9 google/cloud/retail_v2/services/product_service/transports/grpc.py
  12. +9 −9 google/cloud/retail_v2/services/product_service/transports/grpc_asyncio.py
  13. +9 −7 google/cloud/retail_v2/services/search_service/async_client.py
  14. +9 −7 google/cloud/retail_v2/services/search_service/client.py
  15. +9 −7 google/cloud/retail_v2/services/search_service/transports/grpc.py
  16. +9 −7 google/cloud/retail_v2/services/search_service/transports/grpc_asyncio.py
  17. +12 −9 google/cloud/retail_v2/types/completion_service.py
  18. +1 −1 google/cloud/retail_v2/types/import_config.py
  19. +7 −7 google/cloud/retail_v2/types/product.py
  20. +104 −71 google/cloud/retail_v2/types/search_service.py
  21. +15 −3 google/cloud/retail_v2/types/user_event.py
@@ -394,9 +394,9 @@ async def set_default_branch(
branch {newBranch}.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (:class:`google.cloud.retail_v2.types.SetDefaultBranchRequest`):
@@ -465,9 +465,9 @@ async def get_default_branch(
method under a specified parent catalog.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (:class:`google.cloud.retail_v2.types.GetDefaultBranchRequest`):
@@ -597,9 +597,9 @@ def set_default_branch(
branch {newBranch}.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (google.cloud.retail_v2.types.SetDefaultBranchRequest):
@@ -668,9 +668,9 @@ def get_default_branch(
method under a specified parent catalog.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (google.cloud.retail_v2.types.GetDefaultBranchRequest):
@@ -325,9 +325,9 @@ def set_default_branch(
branch {newBranch}.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.SetDefaultBranchRequest],
@@ -361,9 +361,9 @@ def get_default_branch(
method under a specified parent catalog.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.GetDefaultBranchRequest],
@@ -333,9 +333,9 @@ def set_default_branch(
branch {newBranch}.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.SetDefaultBranchRequest],
@@ -369,9 +369,9 @@ def get_default_branch(
method under a specified parent catalog.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.GetDefaultBranchRequest],
@@ -37,10 +37,11 @@

class CompletionServiceAsyncClient:
"""Auto-completion service for retail.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using Retail
Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud sales
if you are interested in using Retail Search.
"""

_client: CompletionServiceClient
@@ -176,12 +177,12 @@ async def complete_query(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> completion_service.CompleteQueryResponse:
r"""Completes the specified prefix with keyword
suggestions.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
r"""Completes the specified prefix with keyword suggestions.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (:class:`google.cloud.retail_v2.types.CompleteQueryRequest`):
@@ -228,12 +229,14 @@ async def import_completion_data(
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Bulk import of processed completion dataset.
Request processing may be synchronous. Partial updating
is not supported.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
Request processing may be synchronous. Partial updating is not
supported.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (:class:`google.cloud.retail_v2.types.ImportCompletionDataRequest`):
@@ -76,10 +76,11 @@ 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. Contact Retail Support (retail-search-
support@google.com) if you are interested in using Retail
Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud sales
if you are interested in using Retail Search.
"""

@staticmethod
@@ -367,12 +368,12 @@ def complete_query(
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> completion_service.CompleteQueryResponse:
r"""Completes the specified prefix with keyword
suggestions.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
r"""Completes the specified prefix with keyword suggestions.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (google.cloud.retail_v2.types.CompleteQueryRequest):
@@ -420,12 +421,14 @@ def import_completion_data(
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""Bulk import of processed completion dataset.
Request processing may be synchronous. Partial updating
is not supported.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
Request processing may be synchronous. Partial updating is not
supported.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (google.cloud.retail_v2.types.ImportCompletionDataRequest):
@@ -35,10 +35,11 @@ class CompletionServiceGrpcTransport(CompletionServiceTransport):
"""gRPC backend transport for CompletionService.
Auto-completion service for retail.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using Retail
Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud sales
if you are interested in using Retail Search.
This class defines the same methods as the primary client, so the
primary client can load the underlying transport implementation
@@ -256,12 +257,12 @@ def complete_query(
]:
r"""Return a callable for the complete query method over gRPC.
Completes the specified prefix with keyword
suggestions.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
Completes the specified prefix with keyword suggestions.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.CompleteQueryRequest],
@@ -290,12 +291,14 @@ def import_completion_data(
r"""Return a callable for the import completion data method over gRPC.
Bulk import of processed completion dataset.
Request processing may be synchronous. Partial updating
is not supported.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
Request processing may be synchronous. Partial updating is not
supported.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.ImportCompletionDataRequest],
@@ -37,10 +37,11 @@ class CompletionServiceGrpcAsyncIOTransport(CompletionServiceTransport):
"""gRPC AsyncIO backend transport for CompletionService.
Auto-completion service for retail.
This feature is only available for users who have Retail Search
enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using Retail
Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud sales
if you are interested in using Retail Search.
This class defines the same methods as the primary client, so the
primary client can load the underlying transport implementation
@@ -261,12 +262,12 @@ def complete_query(
]:
r"""Return a callable for the complete query method over gRPC.
Completes the specified prefix with keyword
suggestions.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
Completes the specified prefix with keyword suggestions.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.CompleteQueryRequest],
@@ -295,12 +296,14 @@ def import_completion_data(
r"""Return a callable for the import completion data method over gRPC.
Bulk import of processed completion dataset.
Request processing may be synchronous. Partial updating
is not supported.
This feature is only available for users who have Retail
Search enabled. Contact Retail Support (retail-search-
support@google.com) if you are interested in using
Retail Search.
Request processing may be synchronous. Partial updating is not
supported.
This feature is only available for users who have Retail Search
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Returns:
Callable[[~.ImportCompletionDataRequest],
@@ -764,9 +764,9 @@ async def set_inventory(
[RemoveFulfillmentPlaces][google.cloud.retail.v2.ProductService.RemoveFulfillmentPlaces].
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (:class:`google.cloud.retail_v2.types.SetInventoryRequest`):
@@ -919,9 +919,9 @@ async def add_fulfillment_places(
[ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (:class:`google.cloud.retail_v2.types.AddFulfillmentPlacesRequest`):
@@ -1024,9 +1024,9 @@ async def remove_fulfillment_places(
[ListProducts][google.cloud.retail.v2.ProductService.ListProducts].
This feature is only available for users who have Retail Search
enabled. Contact Retail Support
(retail-search-support@google.com) if you are interested in
using Retail Search.
enabled. Please submit a form
`here <https://cloud.google.com/contact>`__ to contact cloud
sales if you are interested in using Retail Search.
Args:
request (:class:`google.cloud.retail_v2.types.RemoveFulfillmentPlacesRequest`):
Loading

0 comments on commit a77f0ea

Please sign in to comment.