Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

docs: Keep the API doc up-to-date #80

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions google/cloud/retail_v2/services/catalog_service/async_client.py
Expand Up @@ -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`):
Expand Down Expand Up @@ -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`):
Expand Down
12 changes: 6 additions & 6 deletions google/cloud/retail_v2/services/catalog_service/client.py
Expand Up @@ -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):
Expand Down Expand Up @@ -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):
Expand Down
Expand Up @@ -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],
Expand Down Expand Up @@ -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],
Expand Down
Expand Up @@ -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],
Expand Down Expand Up @@ -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],
Expand Down
33 changes: 18 additions & 15 deletions google/cloud/retail_v2/services/completion_service/async_client.py
Expand Up @@ -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
Expand Down Expand Up @@ -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`):
Expand Down Expand Up @@ -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`):
Expand Down
33 changes: 18 additions & 15 deletions google/cloud/retail_v2/services/completion_service/client.py
Expand Up @@ -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
Expand Down Expand Up @@ -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):
Expand Down Expand Up @@ -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):
Expand Down
Expand Up @@ -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
Expand Down Expand Up @@ -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],
Expand Down Expand Up @@ -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],
Expand Down
Expand Up @@ -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
Expand Down Expand Up @@ -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],
Expand Down Expand Up @@ -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],
Expand Down
18 changes: 9 additions & 9 deletions google/cloud/retail_v2/services/product_service/async_client.py
Expand Up @@ -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`):
Expand Down Expand Up @@ -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`):
Expand Down Expand Up @@ -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`):
Expand Down